POST Agent
New Agent records are required by external systems to for self-maintenance. This method is available only to systems requiring examiner-agent ownership. When an agent record is successfully created it will be tied to the examiner credentials used in the post.
Request Information
URI Parameters
None.
Body Parameters
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. |
Request Formats
application/json, text/json
{
"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-14T05:08:12.0447922-06:00",
"IsActive": true
}
application/xml, text/xml
<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-14T05:08:12.0447922-06:00</CreateDate> <IsActive>true</IsActive> </Agent>
application/x-www-form-urlencoded
Response Information
Resource Description
Agency ID
TransactionResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Log | Collection of string |
None. |
|
| Status | TransactionStatus |
None. |
|
| Code | string |
None. |
|
| ReturnID | string |
None. |
|
| TransObject | Object |
None. |
|
| LogString | string |
None. |
Response Formats
application/json, text/json
{
"Log": [
"sample string 1",
"sample string 2"
],
"Status": 0,
"Code": "sample string 1",
"ReturnID": "sample string 2",
"TransObject": {},
"LogString": "sample string 1\r\nsample string 2\r\n"
}
application/xml, text/xml
<TransactionResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Log>
<string>sample string 1</string>
<string>sample string 2</string>
</Log>
<Status>Not Yet Run</Status>
<Code>sample string 1</Code>
<ReturnID>sample string 2</ReturnID>
<TransObject />
</TransactionResult>