POST Agency

New Agency records are required by external systems to for self-maintenance. This method is available only to systems requiring examiner-agency ownership. When an agency record is successfully created it will be tied to the examiner credentials used in the post.

Request Information

URI Parameters

None.

Body Parameters

Create Agency Request

Agency

Name	Description	Type	Additional information
AgencyID	The id of the Agency in SMM's system. This property may be ommitted if this number is unknown or otherwise unavailable.	integer	None.
AgencyFullName	The full name of the agency.	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 agency.	string	None.
Extension		string	None.
EmailAddress	A contact method for the agency.	string	None.
CreateDate	The date the agency was created in SMM's system. If placing a new order, this property should be ommitted.	date	None.
IsActive	Whether or not the agency is active in SMM's system. If placing a new order, this property should be ommitted.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "AgencyID": 1,
  "AgencyFullName": "sample string 2",
  "AddressLine1": "sample string 3",
  "Suite": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "Zip": "sample string 7",
  "PhoneNumber": "sample string 8",
  "Extension": "sample string 9",
  "EmailAddress": "sample string 10",
  "CreateDate": "2024-11-22T21:22:55.0180799-06:00",
  "IsActive": true
}

application/xml, text/xml

Sample:

<Agency xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AgencyID>1</AgencyID>
  <AgencyFullName>sample string 2</AgencyFullName>
  <AddressLine1>sample string 3</AddressLine1>
  <Suite>sample string 4</Suite>
  <City>sample string 5</City>
  <State>sample string 6</State>
  <Zip>sample string 7</Zip>
  <PhoneNumber>sample string 8</PhoneNumber>
  <Extension>sample string 9</Extension>
  <EmailAddress>sample string 10</EmailAddress>
  <CreateDate>2024-11-22T21:22:55.0180799-06:00</CreateDate>
  <IsActive>true</IsActive>
</Agency>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Agency'.

Response Information

Resource Description

Agency ID

TransactionResult

Name	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

Sample:

{
  "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

Sample:

<TransactionResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <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>