POST api/admin/Inventory/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
RequestOfInventorySearchName | Description | Type | Additional information |
---|---|---|---|
Value |
InventorySearch |
None. |
|
Authentication |
Authentication |
None. |
Request Formats
application/json, text/json
Sample:
{ "Value": { "SearchKey": 1, "DealerLicenseType": "sample string 1", "DealerLicenseNumber": 1, "DealerLicenseSuffix": 1, "AgentCustomerNumber": 1, "LicensePlateNumber": "sample string 2" }, "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> <SearchKey>1</SearchKey> <DealerLicenseType>sample string 1</DealerLicenseType> <DealerLicenseNumber>1</DealerLicenseNumber> <DealerLicenseSuffix>1</DealerLicenseSuffix> <AgentCustomerNumber>1</AgentCustomerNumber> <LicensePlateNumber>sample string 2</LicensePlateNumber> </Value> </Request>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseOfSearchResultOfInventorySearchResultName | Description | Type | Additional information |
---|---|---|---|
Value |
SearchResultOfInventorySearchResult |
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": [ { "Agent": { "AgentCustomerNumber": 1, "DealerLicenseType": "sample string 1", "DealerLicenseNumber": 1, "DealerLicenseSuffix": 1, "AgentName": "sample string 2", "DoingBusinessAs": [ { "SequenceNumber": 1, "Name": "sample string 1" }, { "SequenceNumber": 1, "Name": "sample string 1" } ] }, "Inventory": [ { "AgencyCode": 1, "CountyCode": 1, "InventoryCode": "sample string 1", "LicensePlateNumber": "sample string 2", "InventoryStatusCode": "sample string 3", "InventoryUsedDate": "2025-04-24" }, { "AgencyCode": 1, "CountyCode": 1, "InventoryCode": "sample string 1", "LicensePlateNumber": "sample string 2", "InventoryStatusCode": "sample string 3", "InventoryUsedDate": "2025-04-24" } ], "TotalInventoryCount": 1, "DecalCount": 1 }, { "Agent": { "AgentCustomerNumber": 1, "DealerLicenseType": "sample string 1", "DealerLicenseNumber": 1, "DealerLicenseSuffix": 1, "AgentName": "sample string 2", "DoingBusinessAs": [ { "SequenceNumber": 1, "Name": "sample string 1" }, { "SequenceNumber": 1, "Name": "sample string 1" } ] }, "Inventory": [ { "AgencyCode": 1, "CountyCode": 1, "InventoryCode": "sample string 1", "LicensePlateNumber": "sample string 2", "InventoryStatusCode": "sample string 3", "InventoryUsedDate": "2025-04-24" }, { "AgencyCode": 1, "CountyCode": 1, "InventoryCode": "sample string 1", "LicensePlateNumber": "sample string 2", "InventoryStatusCode": "sample string 3", "InventoryUsedDate": "2025-04-24" } ], "TotalInventoryCount": 1, "DecalCount": 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": "782f2dcf-4be0-411e-a4fd-4a165f54f42f" }
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> <InventorySearchResult> <Agent> <AgentCustomerNumber>1</AgentCustomerNumber> <DealerLicenseType>sample string 1</DealerLicenseType> <DealerLicenseNumber>1</DealerLicenseNumber> <DealerLicenseSuffix>1</DealerLicenseSuffix> <AgentName>sample string 2</AgentName> <DoingBusinessAs> <DoingBusinessAs> <SequenceNumber>1</SequenceNumber> <Name>sample string 1</Name> </DoingBusinessAs> <DoingBusinessAs> <SequenceNumber>1</SequenceNumber> <Name>sample string 1</Name> </DoingBusinessAs> </DoingBusinessAs> </Agent> <Inventory> <Inventory> <AgencyCode>1</AgencyCode> <CountyCode>1</CountyCode> <InventoryCode>sample string 1</InventoryCode> <LicensePlateNumber>sample string 2</LicensePlateNumber> <InventoryStatusCode>sample string 3</InventoryStatusCode> <InventoryUsedDate>2025-04-24T02:37:19.9503748-04:00</InventoryUsedDate> </Inventory> <Inventory> <AgencyCode>1</AgencyCode> <CountyCode>1</CountyCode> <InventoryCode>sample string 1</InventoryCode> <LicensePlateNumber>sample string 2</LicensePlateNumber> <InventoryStatusCode>sample string 3</InventoryStatusCode> <InventoryUsedDate>2025-04-24T02:37:19.9503748-04:00</InventoryUsedDate> </Inventory> </Inventory> <TotalInventoryCount>1</TotalInventoryCount> <DecalCount>1</DecalCount> </InventorySearchResult> <InventorySearchResult> <Agent> <AgentCustomerNumber>1</AgentCustomerNumber> <DealerLicenseType>sample string 1</DealerLicenseType> <DealerLicenseNumber>1</DealerLicenseNumber> <DealerLicenseSuffix>1</DealerLicenseSuffix> <AgentName>sample string 2</AgentName> <DoingBusinessAs> <DoingBusinessAs> <SequenceNumber>1</SequenceNumber> <Name>sample string 1</Name> </DoingBusinessAs> <DoingBusinessAs> <SequenceNumber>1</SequenceNumber> <Name>sample string 1</Name> </DoingBusinessAs> </DoingBusinessAs> </Agent> <Inventory> <Inventory> <AgencyCode>1</AgencyCode> <CountyCode>1</CountyCode> <InventoryCode>sample string 1</InventoryCode> <LicensePlateNumber>sample string 2</LicensePlateNumber> <InventoryStatusCode>sample string 3</InventoryStatusCode> <InventoryUsedDate>2025-04-24T02:37:19.9503748-04:00</InventoryUsedDate> </Inventory> <Inventory> <AgencyCode>1</AgencyCode> <CountyCode>1</CountyCode> <InventoryCode>sample string 1</InventoryCode> <LicensePlateNumber>sample string 2</LicensePlateNumber> <InventoryStatusCode>sample string 3</InventoryStatusCode> <InventoryUsedDate>2025-04-24T02:37:19.9503748-04:00</InventoryUsedDate> </Inventory> </Inventory> <TotalInventoryCount>1</TotalInventoryCount> <DecalCount>1</DecalCount> </InventorySearchResult> </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>782f2dcf-4be0-411e-a4fd-4a165f54f42f</RequestId> </Response>