GET IdentificationsToAssign?entityId={entityId}&isDriver={isDriver}&companyContractId={companyContractId}&searchText={searchText}
Gets all the identifications, represented as IdentificationDto.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| entityId |
Filter for the contract of the identifications, null for all (optional, null by default). |
globally unique identifier |
Required |
| isDriver |
Filter for the contract of the identifications, null for all (optional, null by default). |
boolean |
Required |
| companyContractId |
Filter for the label of the identifications, null for all (optional, null by default). |
globally unique identifier |
None. |
| searchText |
Filter for the PAN of the identifications, null for all (optional, null by default). |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
A collection of identifications.
Collection of IdentificationCompactDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Description | string |
None. |
|
| RequirePin | boolean |
None. |
|
| PinDigits | integer |
None. |
|
| PIN | string |
None. |
|
| Instalable | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "5bf3ee24-6cc5-4997-8bef-ed70fa5a10b2",
"Description": "sample string 2",
"RequirePin": true,
"PinDigits": 1,
"PIN": "sample string 4",
"Instalable": true
},
{
"Id": "5bf3ee24-6cc5-4997-8bef-ed70fa5a10b2",
"Description": "sample string 2",
"RequirePin": true,
"PinDigits": 1,
"PIN": "sample string 4",
"Instalable": true
}
]
application/xml, text/xml
Sample:
<ArrayOfIdentificationCompactDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
<IdentificationCompactDto>
<Description>sample string 2</Description>
<Id>5bf3ee24-6cc5-4997-8bef-ed70fa5a10b2</Id>
<Instalable>true</Instalable>
<PIN>sample string 4</PIN>
<PinDigits>1</PinDigits>
<RequirePin>true</RequirePin>
</IdentificationCompactDto>
<IdentificationCompactDto>
<Description>sample string 2</Description>
<Id>5bf3ee24-6cc5-4997-8bef-ed70fa5a10b2</Id>
<Instalable>true</Instalable>
<PIN>sample string 4</PIN>
<PinDigits>1</PinDigits>
<RequirePin>true</RequirePin>
</IdentificationCompactDto>
</ArrayOfIdentificationCompactDto>