ProfileAPIImpl
User: marc Date: Mar 4, 2008 Time: 6:23:59 AM
THIS SOFTWARE IS COPYRIGHTED. THE SOFTWARE MAY NOT BE COPIED REPRODUCED, TRANSLATED, OR REDUCED TO ANY ELECTRONIC MEDIUM OR MACHINE READABLE FORM WITHOUT THE PRIOR WRITTEN CONSENT OF SOCO TECHNOLOGIES.The following resources are part of this group:
/profile/claim/{id}
Mount Point: /rest/profile/claim/{id}
POST
Claim a dormant user account
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Agent's unique identifier -- numeric ID or username -- on RealtyBaron.com | path | |
| api_key | This identifies your application. Please email help@realtybaron.com to request an API key. | form |
Response Body
| element: | response |
| media types: | */* application/xml application/json |
api response
/profile/flag/{id}
Mount Point: /rest/profile/flag/{id}
POST
Flags a profile for review by staff
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Agent's unique identifier -- numeric ID or username -- on RealtyBaron.com | path | |
| flag_type | Reason for flagging -- fraud, remove, low_ranking, or high_ranking. | form | |
| comment | user comment (optional) | form | |
| api_key | This identifies your application. Please email help@agentrank.com to request an API key. | form |
Response Body
| element: | response |
| media types: | */* application/xml application/json |
flag status
/profile/poke/{id}
Mount Point: /rest/profile/poke/{id}
POST
Poke an active profile for an update
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Agent's unique identifier -- numeric ID or username -- on RealtyBaron.com | path | |
| api_key | This identifies your application. Please email help@realtybaron.com to request an API key. | query |
Response Body
| element: | response |
| media types: | */* application/xml application/json |
api response
/profile/view/{id}
Mount Point: /rest/profile/view/{id}
GET
Get an agent's profile using their unique identifier on RealtyBaron.com
Parameters
| name | description | type | default |
|---|---|---|---|
| id | Agent's unique identifier -- numeric ID or username -- on RealtyBaron.com | path | |
| head_size | The size of the head shot -- thumbnail, xsmall, small, medium, large, xlarge, xxlarge | query | large |
| look_back | The number of years to "look back" for sale transactions and client reviews | query | 5 |
| api_key | This identifies your application. Please email help@agentrank.com to request an API key. | query |
Response Body
| element: | response |
| media types: | */* application/xml application/json |
agent's current profile