Resource Definitions:Agents/ID

From API Documentation

(Difference between revisions)
Jump to: navigation, search
(→GET)
Line 39: Line 39:
* brokerage_employee_id
* brokerage_employee_id
-
'''''Example Response - XML'''''
+
=== Example Response - XML ===
-
+
<source lang="xml">
-
<?xml version="1.0" encoding="UTF-8"?>
+
<?xml version="1.0" encoding="UTF-8"?>
-
<agent version="1.0">
+
<agent version="1.0">
-
    <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_status_id>1</user_status_id>
+
    <user_status_id>1</user_status_id>
-
    <user_fname>John</user_fname>
+
    <user_fname>John</user_fname>
-
    <user_lname>Smith</user_lname>
+
    <user_lname>Smith</user_lname>
-
    <user_company_name>Shady Acres Brokerage</user_company_name>
+
    <user_company_name>Shady Acres Brokerage</user_company_name>
-
    <user_email_work>john.smith@company.com</user_email_work>
+
    <user_email_work>john.smith@company.com</user_email_work>
-
    <user_website>www.shadyacresbrokerage.com</user_website>
+
    <user_website>www.shadyacresbrokerage.com</user_website>
-
    <user_phone_work>303-555-1234</user_phone_work>
+
    <user_phone_work>303-555-1234</user_phone_work>
-
    <user_phone_home></user_phone_home>
+
    <user_phone_home></user_phone_home>
-
    <user_phone_mobile>303-555-1235</user_phone_mobile>
+
    <user_phone_mobile>303-555-1235</user_phone_mobile>
-
    <user_phone_fax>303-555-1236</user_phone_fax>
+
    <user_phone_fax>303-555-1236</user_phone_fax>
-
    <user_photo_path>1234_photo.jpg</user_photo_path>
+
    <user_photo_path>1234_photo.jpg</user_photo_path>
-
    <user_home_street>123 Main Street</user_home_street>
+
    <user_home_street>123 Main Street</user_home_street>
-
    <user_home_suite></user_home_suite>
+
    <user_home_suite></user_home_suite>
-
    <user_home_city>Shady Acres</user_home_city>
+
    <user_home_city>Shady Acres</user_home_city>
-
    <user_home_state>CO</user_home_state>
+
    <user_home_state>CO</user_home_state>
-
    <user_home_zip>12345</user_home_zip>
+
    <user_home_zip>12345</user_home_zip>
-
    <user_company_website>www.shadyacresbrokerage.com</user_company_website>
+
    <user_company_website>www.shadyacresbrokerage.com</user_company_website>
-
    <user_company_street>124 Main Street</user_company_street>
+
    <user_company_street>124 Main Street</user_company_street>
-
    <user_company_suite>5</user_company_suite>
+
    <user_company_suite>5</user_company_suite>
-
    <user_company_city>Shady Acres</user_company_city>
+
    <user_company_city>Shady Acres</user_company_city>
-
    <user_company_state>CO</user_company_state>
+
    <user_company_state>CO</user_company_state>
-
    <user_company_zip>12345</user_company_zip>
+
    <user_company_zip>12345</user_company_zip>
-
    <user_company_logo_path>sab_logo.gif</user_company_logo_path>
+
    <user_company_logo_path>sab_logo.gif</user_company_logo_path>
-
    <user_tagline></user_tagline>
+
    <user_tagline></user_tagline>
-
    <user_bio></user_bio>
+
    <user_bio></user_bio>
-
    <user_date>2009-07-13 11:25:23</user_date>
+
    <user_date>2009-07-13 11:25:23</user_date>
-
    <user_report_daily>0</user_report_daily>
+
    <user_report_daily>0</user_report_daily>
-
    <user_report_weekly>1</user_report_weekly>
+
    <user_report_weekly>1</user_report_weekly>
-
    <user_report_monthly>0</user_report_monthly>
+
    <user_report_monthly>0</user_report_monthly>
-
    <user_sitename></user_sitename>
+
    <user_sitename></user_sitename>
-
    <user_directory_hidden>0</user_directory_hidden>
+
    <user_directory_hidden>0</user_directory_hidden>
-
    <brokerage_employee_id></brokerage_employee_id>
+
    <brokerage_employee_id></brokerage_employee_id>
-
</agent>
+
</agent>
 +
</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_status_id":"1",
+
    "user_status_id":"1",
-
    "user_fname":"John",
+
    "user_fname":"John",
-
    "user_lname":"Smith",
+
    "user_lname":"Smith",
-
    "user_company_name":"hady Acres Brokerage",
+
    "user_company_name":"hady Acres Brokerage",
-
    "user_email_work":"john.smith@company.com",
+
    "user_email_work":"john.smith@company.com",
-
    "user_website":"www.shadyacresbrokerage.com",
+
    "user_website":"www.shadyacresbrokerage.com",
-
    "user_phone_work":"303-555-1234",
+
    "user_phone_work":"303-555-1234",
-
    "user_phone_home":"",
+
    "user_phone_home":"",
-
    "user_phone_mobile":"303-555-1235",
+
    "user_phone_mobile":"303-555-1235",
-
    "user_phone_fax":"303-555-1236",
+
    "user_phone_fax":"303-555-1236",
-
    "user_photo_path":"1234_photo.jpg",
+
    "user_photo_path":"1234_photo.jpg",
-
    "user_home_street":"123 Main Street",
+
    "user_home_street":"123 Main Street",
-
    "user_home_suite":"",
+
    "user_home_suite":"",
-
    "user_home_city":"Shady Acres",
+
    "user_home_city":"Shady Acres",
-
    "user_home_state":"CO",
+
    "user_home_state":"CO",
-
    "user_home_zip":"12345",
+
    "user_home_zip":"12345",
-
    "user_company_website":"www.shadyacresbrokerage.com",
+
    "user_company_website":"www.shadyacresbrokerage.com",
-
    "user_company_street":"124 Main Street",
+
    "user_company_street":"124 Main Street",
-
    "user_company_suite":"5",
+
    "user_company_suite":"5",
-
    "user_company_city":"Shady Acres",
+
    "user_company_city":"Shady Acres",
-
    "user_company_state":"CO",
+
    "user_company_state":"CO",
-
    "user_company_zip":"12345",
+
    "user_company_zip":"12345",
-
    "user_company_logo_path":"sab_logo.gif",
+
    "user_company_logo_path":"sab_logo.gif",
-
    "user_tagline":"",
+
    "user_tagline":"",
-
    "user_bio":"",
+
    "user_bio":"",
-
    "user_date":"2009-07-13 11:25:23",
+
    "user_date":"2009-07-13 11:25:23",
-
    "user_report_daily":"0",
+
    "user_report_daily":"0",
-
    "user_report_weekly":"1",
+
    "user_report_weekly":"1",
-
    "user_report_monthly":"0",
+
    "user_report_monthly":"0",
-
    "user_sitename":"",
+
    "user_sitename":"",
-
    "user_directory_hidden":"0",
+
    "user_directory_hidden":"0",
-
    "brokerage_employee_id":""
+
    "brokerage_employee_id":""
-
}
+
}
 +
<source>
-
'''''Example Response - TEXT (URI-encoded)'''''
+
=== Example Response - TEXT (URI-encoded) ===
-
+
<source lang="text">
-
user_id=1234&
+
user_id=1234&
-
user_email=john.smith%40company.com&
+
user_email=john.smith%40company.com&
-
user_status_id=1&
+
user_status_id=1&
-
user_fname=John&
+
user_fname=John&
-
user_lname=Smith&
+
user_lname=Smith&
-
user_company_name=Shady+Acres+Brokerage&
+
user_company_name=Shady+Acres+Brokerage&
-
user_email_work=john.smith%40company.com&
+
user_email_work=john.smith%40company.com&
-
user_website=www.shadyacresbrokerage.com&
+
user_website=www.shadyacresbrokerage.com&
-
user_phone_work=303-555-1234&
+
user_phone_work=303-555-1234&
-
user_phone_home=&
+
user_phone_home=&
-
user_phone_mobile=303-555-1235&
+
user_phone_mobile=303-555-1235&
-
user_phone_fax=303-555-1236&
+
user_phone_fax=303-555-1236&
-
user_photo_path=1234_photo.jpg&
+
user_photo_path=1234_photo.jpg&
-
user_home_street=123+Main+Street&
+
user_home_street=123+Main+Street&
-
user_home_suite=&
+
user_home_suite=&
-
user_home_city=Shady Acres&
+
user_home_city=Shady Acres&
-
user_home_state=CO&
+
user_home_state=CO&
-
user_home_zip=12345&
+
user_home_zip=12345&
-
user_company_website=www.shadyacresbrokerage.com&
+
user_company_website=www.shadyacresbrokerage.com&
-
user_company_street=124+Main+Street&
+
user_company_street=124+Main+Street&
-
user_company_suite=5&
+
user_company_suite=5&
-
user_company_city=Shady+Acres&
+
user_company_city=Shady+Acres&
-
user_company_state=CO&
+
user_company_state=CO&
-
user_company_zip=12345&
+
user_company_zip=12345&
-
user_company_logo_path=sab_logo.gif&
+
user_company_logo_path=sab_logo.gif&
-
user_tagline=&
+
user_tagline=&
-
user_bio=&
+
user_bio=&
-
user_date=2009-07-13+11%3A25%3A23&
+
user_date=2009-07-13+11%3A25%3A23&
-
user_report_daily=0&
+
user_report_daily=0&
-
user_report_weekly=1&
+
user_report_weekly=1&
-
user_report_monthly=0&
+
user_report_monthly=0&
-
user_sitename=&
+
user_sitename=&
-
user_directory_hidden=0&
+
user_directory_hidden=0&
-
brokerage_employee_id=
+
brokerage_employee_id=
 +
</source>
[[Category:Resource Definitions]]
[[Category:Resource Definitions]]

Revision as of 14:50, 12 July 2010

The agents/ID resource references an individual agent account, where "ID" is the agent's ID number. Available methods are:

GET

Returns a list of account settings for the specified agent. The response includes the following fields:

  • 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

Example Response - XML 

<?xml version="1.0" encoding="UTF-8"?>
<agent version="1.0">
    <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>
</agent>

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":""
}
<source>
 
=== Example Response - TEXT (URI-encoded) ===
<source lang="text">
user_id=1234&
user_email=john.smith%40company.com&
user_status_id=1&
user_fname=John&
user_lname=Smith&
user_company_name=Shady+Acres+Brokerage&
user_email_work=john.smith%40company.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%3A25%3A23&
user_report_daily=0&
user_report_weekly=1&
user_report_monthly=0&
user_sitename=&
user_directory_hidden=0&
brokerage_employee_id=
Retrieved from "http://api.rezora.com/documentation/index.php?title=Resource_Definitions:Agents/ID"
Personal tools