Resource Definitions:Agents

From API Documentation

(Difference between revisions)
Jump to: navigation, search
(→GET)
(→GET)
Line 10: Line 10:
* user_date
* user_date
-
'''''Example Response - XML'''''
+
'''''Example Response - XML'''''
-
<code>
+
<code>
-
<?xml version="1.0" encoding="UTF-8"?>
+
<?xml version="1.0" encoding="UTF-8"?>
-
<agents version="1.0">
+
<agents version="1.0">
-
    <agent>
+
    <agent>
-
        <user_id>1234</user_id>
+
        <user_id>1234</user_id>
-
        <user_email>john.smith@company.com</user_email>
+
        <user_email>john.smith@company.com</user_email>
-
        <user_fname>John</user_fname>
+
        <user_fname>John</user_fname>
-
        <user_lname>Smith</user_lname>
+
        <user_lname>Smith</user_lname>
-
        <user_date>2010-06-25 20:00:00</user_date>
+
        <user_date>2010-06-25 20:00:00</user_date>
-
  </agent>
+
    </agent>
-
  ...
+
    ...
-
</agents>
+
</agents>
-
<code>
+
<code>
-
    Example Response - JSON
+
'''''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
-
              "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
+
-
    ...
+

Revision as of 06:59, 10 July 2010

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>
<code>

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
...
Retrieved from "http://api.rezora.com/documentation/index.php?title=Resource_Definitions:Agents"
Personal tools