GET Agent/{id}
This method will return a single agent object. It queries by the examiner credentials used and the agent id passed in.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Agent object
Agent| Name | Description | Type | Additional information |
|---|---|---|---|
| AgentID |
The id of the Agent in SMM's system. This property may be ommitted if this number is unknown or otherwise unavailable. |
integer |
None. |
| AgentFullName |
The full name of the agent. |
string |
None. |
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| AddressLine1 | string |
None. |
|
| Suite | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| PhoneNumber |
The main contact phone number for the agent. |
string |
None. |
| Extension | string |
None. |
|
| EmailAddress |
A contact method for the agency. |
string |
None. |
| CreateDate |
The date the agent was created in SMM's system. If placing a new order, this property should be ommitted. |
date |
None. |
| IsActive |
Whether or not the agent is active in SMM's system. If placing a new order, this property should be ommitted. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"AgentID": 1,
"AgentFullName": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"AddressLine1": "sample string 5",
"Suite": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"PhoneNumber": "sample string 10",
"Extension": "sample string 11",
"EmailAddress": "sample string 12",
"CreateDate": "2025-12-15T12:43:38.3533086-06:00",
"IsActive": true
}
application/xml, text/xml
Sample:
<Agent xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AgentID>1</AgentID> <AgentFullName>sample string 2</AgentFullName> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <AddressLine1>sample string 5</AddressLine1> <Suite>sample string 6</Suite> <City>sample string 7</City> <State>sample string 8</State> <Zip>sample string 9</Zip> <PhoneNumber>sample string 10</PhoneNumber> <Extension>sample string 11</Extension> <EmailAddress>sample string 12</EmailAddress> <CreateDate>2025-12-15T12:43:38.3533086-06:00</CreateDate> <IsActive>true</IsActive> </Agent>