Resource Definitions:Agents

From API Documentation

Revision as of 06:54, 10 July 2010 by WikiSysop (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The agents resource is a collection of all agent accounts associated with your company. Available methods are:

GET

Returns a list of agents. Each agent record includes the following fields:

  • user_id,
  • user_email,
  • user_fname,
  • user_lname,
  • user_date

Example Response - XML <?xml version="1.0" encoding="UTF-8"?> <agents version="1.0">

<agent>
 <user_id>1234</user_id>
 <user_email>john.smith@company.com</user_email>
 <user_fname>John</user_fname>
 <user_lname>Smith</user_lname>
 <user_date>2010-06-25 20:00:00</user_date>
</agent>
...

</agents>


   Example Response - JSON
   [
        {
             "user_id":"1234",
             "user_email":"john.smith@company.com",
             "user_fname":"John",
             "user_lname":"Smith",
             "user_date":"2010-06-25 20:00:00"
        },
        ...
   ]
   					
   Example Response - TEXT (pipe-delimited)
   1234|john.smith@company.com|John|Smith|2010-06-25 20:00:00
...
Personal tools