POST api/admin/Agent/Search

Click on the link to the left for code examples. Also refer to the DHSMV System Specification document for additional insight.

Request Information

URI Parameters

None.

Body Parameters

RequestOfAgentSearch

Name	Description	Type	Additional information
Value		AgentSearch	None.
Authentication		Authentication	None.

Request Formats

application/json, text/json

Sample:

{
  "Value": {
    "DealerLicenseType": "sample string 1",
    "DealerLicenseNumber": 1,
    "DealerLicenseSuffix": 1,
    "AgentCustomerNumber": 1,
    "FEID": "sample string 2",
    "FEIDSuffix": 1,
    "RowStartNumber": 1,
    "NumberRowsReturn": 1,
    "SearchKey": 1,
    "AgentStatusCode": "sample string 3"
  },
  "Authentication": {
    "AgentCustomerNumber": 1,
    "DealerLicenseType": "sample string 1",
    "DealerLicenseNumber": 1,
    "DealerLicenseSuffix": 1,
    "EmpCustomerNumber": 1,
    "LogNumber": 1,
    "DealerLicensePin": "sample string 2",
    "EmployeeType": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Authentication>
    <AgentCustomerNumber>1</AgentCustomerNumber>
    <DealerLicenseType>sample string 1</DealerLicenseType>
    <DealerLicenseNumber>1</DealerLicenseNumber>
    <DealerLicenseSuffix>1</DealerLicenseSuffix>
    <EmpCustomerNumber>1</EmpCustomerNumber>
    <LogNumber>1</LogNumber>
    <DealerLicensePin>sample string 2</DealerLicensePin>
    <EmployeeType>sample string 3</EmployeeType>
  </Authentication>
  <Value>
    <DealerLicenseType>sample string 1</DealerLicenseType>
    <DealerLicenseNumber>1</DealerLicenseNumber>
    <DealerLicenseSuffix>1</DealerLicenseSuffix>
    <AgentCustomerNumber>1</AgentCustomerNumber>
    <FEID>sample string 2</FEID>
    <FEIDSuffix>1</FEIDSuffix>
    <RowStartNumber>1</RowStartNumber>
    <NumberRowsReturn>1</NumberRowsReturn>
    <SearchKey>1</SearchKey>
    <AgentStatusCode>sample string 3</AgentStatusCode>
  </Value>
</Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfSearchResultOfAgentSearchResult

Name	Type	Additional information
Value	SearchResultOfAgentSearchResult	None.
ErrorMessages	Collection of ErrorMessage	None.
InfoMessages	Collection of InfoMessage	None.
LogNumber	integer	None.
Notifications	Collection of Notification	None.
RequestId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "Value": {
    "Results": [
      {
        "AgentCustomerNumber": 1,
        "AgentName": "sample string 1",
        "DealerLicenseType": "sample string 2",
        "DealerLicenseNumber": 1,
        "DealerLicenseSuffix": 1,
        "DealerLicenseStatus": "sample string 3",
        "DealerLicenseLocationStatus": "sample string 4",
        "AgentStatusCode": "sample string 5",
        "AgentServiceTypeCode": "sample string 6",
        "DBAs": [
          {
            "SequenceNumber": 1,
            "Name": "sample string 1"
          },
          {
            "SequenceNumber": 1,
            "Name": "sample string 1"
          }
        ],
        "MetalPlateInventoryStatusCode": "sample string 7",
        "AgentHostAgencies": [
          {
            "HostCountyCode": 1,
            "HostAgencyCode": 1,
            "HostAgencyName": "sample string 1",
            "AgentHostAgencyStatusCode": "sample string 2",
            "StartDate": "2025-04-24",
            "EndDate": "2025-04-24"
          },
          {
            "HostCountyCode": 1,
            "HostAgencyCode": 1,
            "HostAgencyName": "sample string 1",
            "AgentHostAgencyStatusCode": "sample string 2",
            "StartDate": "2025-04-24",
            "EndDate": "2025-04-24"
          }
        ],
        "EFSEligible": true,
        "ETREligible": true,
        "StartDate": "2025-04-24",
        "EndDate": "2025-04-24",
        "NaicCode": 1
      },
      {
        "AgentCustomerNumber": 1,
        "AgentName": "sample string 1",
        "DealerLicenseType": "sample string 2",
        "DealerLicenseNumber": 1,
        "DealerLicenseSuffix": 1,
        "DealerLicenseStatus": "sample string 3",
        "DealerLicenseLocationStatus": "sample string 4",
        "AgentStatusCode": "sample string 5",
        "AgentServiceTypeCode": "sample string 6",
        "DBAs": [
          {
            "SequenceNumber": 1,
            "Name": "sample string 1"
          },
          {
            "SequenceNumber": 1,
            "Name": "sample string 1"
          }
        ],
        "MetalPlateInventoryStatusCode": "sample string 7",
        "AgentHostAgencies": [
          {
            "HostCountyCode": 1,
            "HostAgencyCode": 1,
            "HostAgencyName": "sample string 1",
            "AgentHostAgencyStatusCode": "sample string 2",
            "StartDate": "2025-04-24",
            "EndDate": "2025-04-24"
          },
          {
            "HostCountyCode": 1,
            "HostAgencyCode": 1,
            "HostAgencyName": "sample string 1",
            "AgentHostAgencyStatusCode": "sample string 2",
            "StartDate": "2025-04-24",
            "EndDate": "2025-04-24"
          }
        ],
        "EFSEligible": true,
        "ETREligible": true,
        "StartDate": "2025-04-24",
        "EndDate": "2025-04-24",
        "NaicCode": 1
      }
    ],
    "TotalRecordCount": 1
  },
  "ErrorMessages": [
    {
      "Parameters": [
        "sample string 1",
        "sample string 2"
      ],
      "DeveloperMessage": "sample string 1",
      "ErrorCode": 401,
      "ExceptionMessage": ""
    },
    {
      "Parameters": [
        "sample string 1",
        "sample string 2"
      ],
      "DeveloperMessage": "sample string 1",
      "ErrorCode": 401,
      "ExceptionMessage": ""
    }
  ],
  "InfoMessages": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ],
  "LogNumber": 1,
  "Notifications": [
    {
      "NotificationId": 1,
      "NotificationType": "sample string 1"
    },
    {
      "NotificationId": 1,
      "NotificationType": "sample string 1"
    }
  ],
  "RequestId": "21e8d61f-a2a7-4300-8b5b-24edea2bc072"
}

application/xml, text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Value>
    <Results>
      <AgentSearchResult>
        <AgentCustomerNumber>1</AgentCustomerNumber>
        <AgentName>sample string 1</AgentName>
        <DealerLicenseType>sample string 2</DealerLicenseType>
        <DealerLicenseNumber>1</DealerLicenseNumber>
        <DealerLicenseSuffix>1</DealerLicenseSuffix>
        <DealerLicenseStatus>sample string 3</DealerLicenseStatus>
        <DealerLicenseLocationStatus>sample string 4</DealerLicenseLocationStatus>
        <AgentStatusCode>sample string 5</AgentStatusCode>
        <AgentServiceTypeCode>sample string 6</AgentServiceTypeCode>
        <DBAs>
          <DoingBusinessAs>
            <SequenceNumber>1</SequenceNumber>
            <Name>sample string 1</Name>
          </DoingBusinessAs>
          <DoingBusinessAs>
            <SequenceNumber>1</SequenceNumber>
            <Name>sample string 1</Name>
          </DoingBusinessAs>
        </DBAs>
        <MetalPlateInventoryStatusCode>sample string 7</MetalPlateInventoryStatusCode>
        <AgentHostAgencies>
          <AgentHostAgency>
            <HostCountyCode>1</HostCountyCode>
            <HostAgencyCode>1</HostAgencyCode>
            <HostAgencyName>sample string 1</HostAgencyName>
            <AgentHostAgencyStatusCode>sample string 2</AgentHostAgencyStatusCode>
            <StartDate>2025-04-24</StartDate>
            <EndDate>2025-04-24</EndDate>
          </AgentHostAgency>
          <AgentHostAgency>
            <HostCountyCode>1</HostCountyCode>
            <HostAgencyCode>1</HostAgencyCode>
            <HostAgencyName>sample string 1</HostAgencyName>
            <AgentHostAgencyStatusCode>sample string 2</AgentHostAgencyStatusCode>
            <StartDate>2025-04-24</StartDate>
            <EndDate>2025-04-24</EndDate>
          </AgentHostAgency>
        </AgentHostAgencies>
        <EFSEligible>true</EFSEligible>
        <ETREligible>true</ETREligible>
        <StartDate>2025-04-24</StartDate>
        <EndDate>2025-04-24</EndDate>
        <NaicCode>1</NaicCode>
      </AgentSearchResult>
      <AgentSearchResult>
        <AgentCustomerNumber>1</AgentCustomerNumber>
        <AgentName>sample string 1</AgentName>
        <DealerLicenseType>sample string 2</DealerLicenseType>
        <DealerLicenseNumber>1</DealerLicenseNumber>
        <DealerLicenseSuffix>1</DealerLicenseSuffix>
        <DealerLicenseStatus>sample string 3</DealerLicenseStatus>
        <DealerLicenseLocationStatus>sample string 4</DealerLicenseLocationStatus>
        <AgentStatusCode>sample string 5</AgentStatusCode>
        <AgentServiceTypeCode>sample string 6</AgentServiceTypeCode>
        <DBAs>
          <DoingBusinessAs>
            <SequenceNumber>1</SequenceNumber>
            <Name>sample string 1</Name>
          </DoingBusinessAs>
          <DoingBusinessAs>
            <SequenceNumber>1</SequenceNumber>
            <Name>sample string 1</Name>
          </DoingBusinessAs>
        </DBAs>
        <MetalPlateInventoryStatusCode>sample string 7</MetalPlateInventoryStatusCode>
        <AgentHostAgencies>
          <AgentHostAgency>
            <HostCountyCode>1</HostCountyCode>
            <HostAgencyCode>1</HostAgencyCode>
            <HostAgencyName>sample string 1</HostAgencyName>
            <AgentHostAgencyStatusCode>sample string 2</AgentHostAgencyStatusCode>
            <StartDate>2025-04-24</StartDate>
            <EndDate>2025-04-24</EndDate>
          </AgentHostAgency>
          <AgentHostAgency>
            <HostCountyCode>1</HostCountyCode>
            <HostAgencyCode>1</HostAgencyCode>
            <HostAgencyName>sample string 1</HostAgencyName>
            <AgentHostAgencyStatusCode>sample string 2</AgentHostAgencyStatusCode>
            <StartDate>2025-04-24</StartDate>
            <EndDate>2025-04-24</EndDate>
          </AgentHostAgency>
        </AgentHostAgencies>
        <EFSEligible>true</EFSEligible>
        <ETREligible>true</ETREligible>
        <StartDate>2025-04-24</StartDate>
        <EndDate>2025-04-24</EndDate>
        <NaicCode>1</NaicCode>
      </AgentSearchResult>
    </Results>
    <TotalRecordCount>1</TotalRecordCount>
  </Value>
  <ErrorMessages>
    <ErrorMessage>
      <Parameters>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Parameters>
      <DeveloperMessage>sample string 1</DeveloperMessage>
      <ErrorCode>AuthorizationError</ErrorCode>
    </ErrorMessage>
    <ErrorMessage>
      <Parameters>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Parameters>
      <DeveloperMessage>sample string 1</DeveloperMessage>
      <ErrorCode>AuthorizationError</ErrorCode>
    </ErrorMessage>
  </ErrorMessages>
  <InfoMessages>
    <InfoMessage>
      <Message>sample string 1</Message>
    </InfoMessage>
    <InfoMessage>
      <Message>sample string 1</Message>
    </InfoMessage>
  </InfoMessages>
  <LogNumber>1</LogNumber>
  <Notifications>
    <Notification>
      <NotificationId>1</NotificationId>
      <NotificationType>sample string 1</NotificationType>
    </Notification>
    <Notification>
      <NotificationId>1</NotificationId>
      <NotificationType>sample string 1</NotificationType>
    </Notification>
  </Notifications>
  <RequestId>21e8d61f-a2a7-4300-8b5b-24edea2bc072</RequestId>
</Response>