Resource Definitions:Agents

From API Documentation

(Difference between revisions)
Jump to: navigation, search
(→GET)
(→GET)
 
(30 intermediate revisions not shown)
Line 1: Line 1:
-
The agents resource is a collection of all agent accounts associated with your company. Available methods are:
+
The ''agents'' resource is a collection of all agent accounts associated with your company.
 +
 
 +
'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/agents</nowiki>
 +
 
 +
Available methods are:
-
[[Category:Resource Definitions]]
 
== GET ==
== GET ==
Returns a list of agents. Each agent record includes the following fields:
Returns a list of agents. Each agent record includes the following fields:
-
* user_id,
+
* user_id
-
* user_email,
+
* user_email
-
* user_fname,
+
* user_status_id - ''possible values: 1 (active), 2 (suspended), 3 (trial), 4 (pending), 5 (free), 6 (deactivated)''
-
* user_lname,
+
* user_fname
 +
* user_lname
 +
* user_company_name
 +
* user_email_work
 +
* user_website
 +
* user_phone_work
 +
* user_phone_home
 +
* user_phone_mobile
 +
* user_phone_fax
 +
* user_photo_path
 +
* user_home_street
 +
* user_home_suite
 +
* user_home_city
 +
* user_home_state
 +
* user_home_zip
 +
* user_company_website
 +
* user_company_street
 +
* user_company_suite
 +
* user_company_city
 +
* user_company_state
 +
* user_company_zip
 +
* user_company_logo_path
 +
* user_tagline
 +
* user_bio
* user_date
* user_date
 +
* user_report_daily - ''possible values: 0, 1 (receives daily status email)''
 +
* user_report_weekly - ''possible values: 0, 1 (receives weekly status email)''
 +
* user_report_monthly - ''possible values: 0, 1 (receives monthly status email)''
 +
* user_sitename
 +
* user_directory_hidden - ''possible values: 0, 1 (not displayed on agent directory page)''
 +
* brokerage_employee_id
 +
* key_username
-
'''''Example Response - XML'''''
+
=== Example Response - XML ===
-
<?xml version="1.0" encoding="UTF-8"?>
+
<source lang="xml">
-
<agents version="1.0">
+
<?xml version="1.0" encoding="UTF-8"?>
-
    <agent>
+
<agents version="1.0">
-
        <user_id>1234</user_id>
+
<agent>
-
        <user_email>john.smith@company.com</user_email>
+
  <user_id>1234</user_id>
-
        <user_fname>John</user_fname>
+
  <user_email>john.smith@company.com</user_email>
-
        <user_lname>Smith</user_lname>
+
  <user_status_id>1</user_status_id>
-
        <user_date>2010-06-25 20:00:00</user_date>
+
  <user_fname>John</user_fname>
-
    </agent>
+
  <user_lname>Smith</user_lname>
-
    ...
+
  <user_company_name>Shady Acres Brokerage</user_company_name>
-
</agents>
+
  <user_email_work>john.smith@company.com</user_email_work>
 +
  <user_website>www.shadyacresbrokerage.com</user_website>
 +
  <user_phone_work>303-555-1234</user_phone_work>
 +
  <user_phone_home></user_phone_home>
 +
  <user_phone_mobile>303-555-1235</user_phone_mobile>
 +
  <user_phone_fax>303-555-1236</user_phone_fax>
 +
  <user_photo_path>1234_photo.jpg</user_photo_path>
 +
  <user_home_street>123 Main Street</user_home_street>
 +
  <user_home_suite></user_home_suite>
 +
  <user_home_city>Shady Acres</user_home_city>
 +
  <user_home_state>CO</user_home_state>
 +
  <user_home_zip>12345</user_home_zip>
 +
  <user_company_website>www.shadyacresbrokerage.com</user_company_website>
 +
  <user_company_street>124 Main Street</user_company_street>
 +
  <user_company_suite>5</user_company_suite>
 +
  <user_company_city>Shady Acres</user_company_city>
 +
  <user_company_state>CO</user_company_state>
 +
  <user_company_zip>12345</user_company_zip>
 +
  <user_company_logo_path>sab_logo.gif</user_company_logo_path>
 +
  <user_tagline></user_tagline>
 +
  <user_bio></user_bio>
 +
  <user_date>2009-07-13 11:25:23</user_date>
 +
  <user_report_daily>0</user_report_daily>
 +
  <user_report_weekly>1</user_report_weekly>
 +
  <user_report_monthly>0</user_report_monthly>
 +
  <user_sitename></user_sitename>
 +
  <user_directory_hidden>0</user_directory_hidden>
 +
  <brokerage_employee_id></brokerage_employee_id>
 +
  <key_username></key_username>
 +
</agent>
 +
...
 +
</agents>
 +
</source>
-
'''''Example Response - JSON'''''
+
=== Example Response - JSON ===
-
+
<source lang="javascript">
-
[
+
[
-
    {
+
{
-
        "user_id":"1234",
+
  "user_id":"1234",
-
        "user_email":"john.smith@company.com",
+
  "user_email":"john.smith@company.com",
-
        "user_fname":"John",
+
  "user_status_id":"1",
-
        "user_lname":"Smith",
+
  "user_fname":"John",
-
        "user_date":"2010-06-25 20:00:00"
+
  "user_lname":"Smith",
-
    },
+
  "user_company_name":"hady Acres Brokerage",
-
    ...
+
  "user_email_work":"john.smith@company.com",
-
]
+
  "user_website":"www.shadyacresbrokerage.com",
-
 
+
  "user_phone_work":"303-555-1234",
-
'''''Example Response - TEXT (pipe-delimited)'''''
+
  "user_phone_home":"",
-
+
  "user_phone_mobile":"303-555-1235",
-
1234|john.smith@company.com|John|Smith|2010-06-25 20:00:00
+
  "user_phone_fax":"303-555-1236",
 +
  "user_photo_path":"1234_photo.jpg",
 +
  "user_home_street":"123 Main Street",
 +
  "user_home_suite":"",
 +
  "user_home_city":"Shady Acres",
 +
  "user_home_state":"CO",
 +
  "user_home_zip":"12345",
 +
  "user_company_website":"www.shadyacresbrokerage.com",
 +
  "user_company_street":"124 Main Street",
 +
  "user_company_suite":"5",
 +
  "user_company_city":"Shady Acres",
 +
  "user_company_state":"CO",
 +
  "user_company_zip":"12345",
 +
  "user_company_logo_path":"sab_logo.gif",
 +
  "user_tagline":"",
 +
  "user_bio":"",
 +
  "user_date":"2009-07-13 11:25:23",
 +
  "user_report_daily":"0",
 +
  "user_report_weekly":"1",
 +
  "user_report_monthly":"0",
 +
  "user_sitename":"",
 +
  "user_directory_hidden":"0",
 +
  "brokerage_employee_id":"",
 +
  "key_username":""
 +
},
  ...
  ...
 +
]
 +
</source>
 +
 +
=== Example Response - CSV ===
 +
<div style="overflow: auto;">
 +
<source lang="text">
 +
"user_id"|"user_email"|"user_status_id"|"user_fname"|"user_lname"|"user_company_name"|"user_email_work"|"user_website"|"user_phone_work"|"user_phone_home"|"user_phone_mobile"|"user_phone_fax"|"user_photo_path"|"user_home_street"|"user_home_suite"|"user_home_city"|"user_home_state"|"user_home_zip"|"user_company_website"|"user_company_street"|"user_company_suite"|"user_company_city"|"user_company_state"|"user_company_zip"|"user_company_logo_path"|"user_tagline"|"user_bio"|"user_date"|"user_report_daily"|"user_report_weekly"|"user_report_monthly"|"user_sitename"|"user_directory_hidden"|"brokerage_employee_id"|"key_username"
 +
"1234"|"john.smith@company.com"|"1"|"John"|"Smith"|"Shady Acres Brokerage"|"john.smith@company.com"|"www.shadyacresbrokerage.com"|"303-555-1234"|""|"303-555-1235"|"303-555-1236"|"1234_photo.jpg"|"123 Main Street"|""|"Shady Acres"|"CO"|"12345"|"www.shadyacresbrokerage.com"|"124 Main Street"|"5"|"Shady Acres"|"CO"|"12345"|"sab_logo.gif"|""|""|"2009-07-13 11:25:23"|"0"|"1"|"0"|""|"0"|""|""
 +
...
 +
</source>
 +
</div>
 +
[[Category:Resource Definitions]]
 +
[[Category:Company Resources]]

Latest revision as of 20:37, 22 November 2011

The agents resource is a collection of all agent accounts associated with your company. 

Example URI: http://api.rezora.com/v1/agents

Available methods are:

Contents

GET

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

  • user_id
  • user_email
  • user_status_id - possible values: 1 (active), 2 (suspended), 3 (trial), 4 (pending), 5 (free), 6 (deactivated)
  • user_fname
  • user_lname
  • user_company_name
  • user_email_work
  • user_website
  • user_phone_work
  • user_phone_home
  • user_phone_mobile
  • user_phone_fax
  • user_photo_path
  • user_home_street
  • user_home_suite
  • user_home_city
  • user_home_state
  • user_home_zip
  • user_company_website
  • user_company_street
  • user_company_suite
  • user_company_city
  • user_company_state
  • user_company_zip
  • user_company_logo_path
  • user_tagline
  • user_bio
  • user_date
  • user_report_daily - possible values: 0, 1 (receives daily status email)
  • user_report_weekly - possible values: 0, 1 (receives weekly status email)
  • user_report_monthly - possible values: 0, 1 (receives monthly status email)
  • user_sitename
  • user_directory_hidden - possible values: 0, 1 (not displayed on agent directory page)
  • brokerage_employee_id
  • key_username

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_status_id>1</user_status_id>
  <user_fname>John</user_fname>
  <user_lname>Smith</user_lname>
  <user_company_name>Shady Acres Brokerage</user_company_name>
  <user_email_work>john.smith@company.com</user_email_work>
  <user_website>www.shadyacresbrokerage.com</user_website>
  <user_phone_work>303-555-1234</user_phone_work>
  <user_phone_home></user_phone_home>
  <user_phone_mobile>303-555-1235</user_phone_mobile>
  <user_phone_fax>303-555-1236</user_phone_fax>
  <user_photo_path>1234_photo.jpg</user_photo_path>
  <user_home_street>123 Main Street</user_home_street>
  <user_home_suite></user_home_suite>
  <user_home_city>Shady Acres</user_home_city>
  <user_home_state>CO</user_home_state>
  <user_home_zip>12345</user_home_zip>
  <user_company_website>www.shadyacresbrokerage.com</user_company_website>
  <user_company_street>124 Main Street</user_company_street>
  <user_company_suite>5</user_company_suite>
  <user_company_city>Shady Acres</user_company_city>
  <user_company_state>CO</user_company_state>
  <user_company_zip>12345</user_company_zip>
  <user_company_logo_path>sab_logo.gif</user_company_logo_path>
  <user_tagline></user_tagline>
  <user_bio></user_bio>
  <user_date>2009-07-13 11:25:23</user_date>
  <user_report_daily>0</user_report_daily>
  <user_report_weekly>1</user_report_weekly>
  <user_report_monthly>0</user_report_monthly>
  <user_sitename></user_sitename>
  <user_directory_hidden>0</user_directory_hidden>
  <brokerage_employee_id></brokerage_employee_id>
  <key_username></key_username>
 </agent>
 ...
</agents>

Example Response - JSON 

[
 {
  "user_id":"1234",
  "user_email":"john.smith@company.com",
  "user_status_id":"1",
  "user_fname":"John",
  "user_lname":"Smith",
  "user_company_name":"hady Acres Brokerage",
  "user_email_work":"john.smith@company.com",
  "user_website":"www.shadyacresbrokerage.com",
  "user_phone_work":"303-555-1234",
  "user_phone_home":"",
  "user_phone_mobile":"303-555-1235",
  "user_phone_fax":"303-555-1236",
  "user_photo_path":"1234_photo.jpg",
  "user_home_street":"123 Main Street",
  "user_home_suite":"",
  "user_home_city":"Shady Acres",
  "user_home_state":"CO",
  "user_home_zip":"12345",
  "user_company_website":"www.shadyacresbrokerage.com",
  "user_company_street":"124 Main Street",
  "user_company_suite":"5",
  "user_company_city":"Shady Acres",
  "user_company_state":"CO",
  "user_company_zip":"12345",
  "user_company_logo_path":"sab_logo.gif",
  "user_tagline":"",
  "user_bio":"",
  "user_date":"2009-07-13 11:25:23",
  "user_report_daily":"0",
  "user_report_weekly":"1",
  "user_report_monthly":"0",
  "user_sitename":"",
  "user_directory_hidden":"0",
  "brokerage_employee_id":"",
  "key_username":""
 },
 ...
]

Example Response - CSV 

"user_id"|"user_email"|"user_status_id"|"user_fname"|"user_lname"|"user_company_name"|"user_email_work"|"user_website"|"user_phone_work"|"user_phone_home"|"user_phone_mobile"|"user_phone_fax"|"user_photo_path"|"user_home_street"|"user_home_suite"|"user_home_city"|"user_home_state"|"user_home_zip"|"user_company_website"|"user_company_street"|"user_company_suite"|"user_company_city"|"user_company_state"|"user_company_zip"|"user_company_logo_path"|"user_tagline"|"user_bio"|"user_date"|"user_report_daily"|"user_report_weekly"|"user_report_monthly"|"user_sitename"|"user_directory_hidden"|"brokerage_employee_id"|"key_username"
"1234"|"john.smith@company.com"|"1"|"John"|"Smith"|"Shady Acres Brokerage"|"john.smith@company.com"|"www.shadyacresbrokerage.com"|"303-555-1234"|""|"303-555-1235"|"303-555-1236"|"1234_photo.jpg"|"123 Main Street"|""|"Shady Acres"|"CO"|"12345"|"www.shadyacresbrokerage.com"|"124 Main Street"|"5"|"Shady Acres"|"CO"|"12345"|"sab_logo.gif"|""|""|"2009-07-13 11:25:23"|"0"|"1"|"0"|""|"0"|""|""
...
Retrieved from "http://api.rezora.com/documentation/index.php?title=Resource_Definitions:Agents"
Personal tools