GET api/Vendor/SelectIDBadge/{auth}
Use this method to select ID Badge information for a courier
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| auth |
The authorization GUID returned from the security API |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Information related to the ID badge
IDBadgeItem| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| BadgeFound | boolean |
None. |
|
| FullName | string |
None. |
|
| BadgeID | string |
None. |
|
| ExpirationDate | date |
None. |
|
| BackgroundColor | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| STANumber | string |
None. |
|
| PhotoImageData | string |
None. |
|
| CourierType | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"BadgeFound": true,
"FullName": "sample string 4",
"BadgeID": "sample string 5",
"ExpirationDate": "2025-11-01T05:27:56.8674226-07:00",
"BackgroundColor": "sample string 6",
"FirstName": "sample string 7",
"LastName": "sample string 8",
"STANumber": "sample string 9",
"PhotoImageData": "sample string 10",
"CourierType": "sample string 11"
}
application/xml, text/xml
Sample:
<IDBadgeItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <BackgroundColor>sample string 6</BackgroundColor> <BadgeFound>true</BadgeFound> <BadgeID>sample string 5</BadgeID> <CourierType>sample string 11</CourierType> <ErrorMessage>sample string 2</ErrorMessage> <ExpirationDate>2025-11-01T05:27:56.8674226-07:00</ExpirationDate> <FirstName>sample string 7</FirstName> <FullName>sample string 4</FullName> <IsSuccessful>true</IsSuccessful> <LastName>sample string 8</LastName> <PhotoImageData>sample string 10</PhotoImageData> <STANumber>sample string 9</STANumber> </IDBadgeItem>