GET Agency

This method will return a list of agency objects all tied to the examiner credentials supplied.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of Agency objects

Collection of 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.

Response 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:36:20.7957616-06:00",
    "IsActive": true
  },
  {
    "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:36:20.7957616-06:00",
    "IsActive": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfAgency xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Agency>
    <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:36:20.7957616-06:00</CreateDate>
    <IsActive>true</IsActive>
  </Agency>
  <Agency>
    <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:36:20.7957616-06:00</CreateDate>
    <IsActive>true</IsActive>
  </Agency>
</ArrayOfAgency>