POST ImportDrivers
Creates drivers using an uploaded Excel file.
Request Information
URI Parameters
None.
Body Parameters
The data of the drivers.
ImportDriversDto| Name | Description | Type | Additional information |
|---|---|---|---|
| File | Collection of byte |
None. |
|
| NeedIdentification | boolean |
None. |
|
| IdCompanyContract | globally unique identifier |
None. |
|
| IdentificationsType | integer |
None. |
|
| IdIdentificationsTypeModel | globally unique identifier |
None. |
|
| IdProgram | globally unique identifier |
None. |
|
| IdLoyaltyProgram | globally unique identifier |
None. |
|
| IdHologramTypeModel | globally unique identifier |
None. |
|
| Address | ImportDocumentParameterAddressDto |
None. |
|
| ImportResult | ImportDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"File": "QEA=",
"NeedIdentification": true,
"IdCompanyContract": "fe055f45-fa7d-4efc-aab9-acf58051edb0",
"IdentificationsType": 1,
"IdIdentificationsTypeModel": "6a62e4d0-2928-4987-ad7b-f682e69bb789",
"IdProgram": "153fc585-8bac-4d77-9d66-b773e241fde7",
"IdLoyaltyProgram": "d4d39f80-f859-4bb6-b4e5-ad50ea3f7f81",
"IdHologramTypeModel": "32d5b554-ab0f-4e85-9ccd-9aac1904e09e",
"Address": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"ZipCode": "sample string 3",
"City": "sample string 4",
"ContactName": "sample string 5",
"ContactPhone": "sample string 6",
"IdCountry": "33aedbf0-45fe-4b7e-a3b9-b8b0b6118011",
"IdState": "49e84047-bfc6-40da-8fcd-f408827f1c0c",
"DeliveryAddressIsLocation": true
},
"ImportResult": {
"listItemError": [
{
"row": 1,
"errorList": [
"sample string 1",
"sample string 2"
]
},
{
"row": 1,
"errorList": [
"sample string 1",
"sample string 2"
]
}
],
"correctProcessedQuantity": 1,
"errorProcessedQuantity": 2,
"totalProcessedQuantity": 3,
"withErrors": true,
"successfullyImportedTotal": "Successfully Imported Total 1",
"failedToBeImportedTotal": "Failed To Be imported Total 2",
"successfullyUpdatedTotal": "Total Successfully Updated: 1",
"failedToBeUpdatedTotal": "Total Not Updated: 2",
"totalProcessed": "Total processed: 3",
"needIdentification": true,
"IdentificationResult": true,
"identificationOrderNumber": "sample string 3",
"identificationErrorText": "sample string 4",
"identificationMessageResult": "Identifier request created. Order Number: sample string 3"
}
}
application/xml, text/xml
Sample:
<ImportDriversDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
<Address>
<City>sample string 4</City>
<ContactName>sample string 5</ContactName>
<ContactPhone>sample string 6</ContactPhone>
<DeliveryAddressIsLocation>true</DeliveryAddressIsLocation>
<IdCountry>33aedbf0-45fe-4b7e-a3b9-b8b0b6118011</IdCountry>
<IdState>49e84047-bfc6-40da-8fcd-f408827f1c0c</IdState>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<ZipCode>sample string 3</ZipCode>
</Address>
<File>QEA=</File>
<IdCompanyContract>fe055f45-fa7d-4efc-aab9-acf58051edb0</IdCompanyContract>
<IdHologramTypeModel>32d5b554-ab0f-4e85-9ccd-9aac1904e09e</IdHologramTypeModel>
<IdIdentificationsTypeModel>6a62e4d0-2928-4987-ad7b-f682e69bb789</IdIdentificationsTypeModel>
<IdLoyaltyProgram>d4d39f80-f859-4bb6-b4e5-ad50ea3f7f81</IdLoyaltyProgram>
<IdProgram>153fc585-8bac-4d77-9d66-b773e241fde7</IdProgram>
<IdentificationsType>1</IdentificationsType>
<ImportResult>
<IdentificationResult>true</IdentificationResult>
<correctProcessedQuantity>1</correctProcessedQuantity>
<errorProcessedQuantity>2</errorProcessedQuantity>
<identificationErrorText>sample string 4</identificationErrorText>
<identificationOrderNumber>sample string 3</identificationOrderNumber>
<listItemError>
<ImportItemDto>
<errorList xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</errorList>
<row>1</row>
</ImportItemDto>
<ImportItemDto>
<errorList xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</errorList>
<row>1</row>
</ImportItemDto>
</listItemError>
<needIdentification>true</needIdentification>
<totalProcessedQuantity>3</totalProcessedQuantity>
</ImportResult>
<NeedIdentification>true</NeedIdentification>
</ImportDriversDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Object of ImportDto class.
ImportDriversDto| Name | Description | Type | Additional information |
|---|---|---|---|
| File | Collection of byte |
None. |
|
| NeedIdentification | boolean |
None. |
|
| IdCompanyContract | globally unique identifier |
None. |
|
| IdentificationsType | integer |
None. |
|
| IdIdentificationsTypeModel | globally unique identifier |
None. |
|
| IdProgram | globally unique identifier |
None. |
|
| IdLoyaltyProgram | globally unique identifier |
None. |
|
| IdHologramTypeModel | globally unique identifier |
None. |
|
| Address | ImportDocumentParameterAddressDto |
None. |
|
| ImportResult | ImportDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"File": "QEA=",
"NeedIdentification": true,
"IdCompanyContract": "be3b24c9-814b-497f-bcad-6d98ed532cc6",
"IdentificationsType": 1,
"IdIdentificationsTypeModel": "1d1a7359-d2f5-4b59-87db-1f4586806104",
"IdProgram": "ab779b4a-40d0-4013-a2ec-540d88b2bed2",
"IdLoyaltyProgram": "c8f35c63-c8e0-4695-9bf5-3e268e18d6c9",
"IdHologramTypeModel": "577ec450-be76-4be3-a34c-b51ec87ed634",
"Address": {
"Street1": "sample string 1",
"Street2": "sample string 2",
"ZipCode": "sample string 3",
"City": "sample string 4",
"ContactName": "sample string 5",
"ContactPhone": "sample string 6",
"IdCountry": "824bc3ce-ead6-4165-bc5e-9530105c7d60",
"IdState": "8810e5f3-e90f-45ad-9dd7-3242415d5e70",
"DeliveryAddressIsLocation": true
},
"ImportResult": {
"listItemError": [
{
"row": 1,
"errorList": [
"sample string 1",
"sample string 2"
]
},
{
"row": 1,
"errorList": [
"sample string 1",
"sample string 2"
]
}
],
"correctProcessedQuantity": 1,
"errorProcessedQuantity": 2,
"totalProcessedQuantity": 3,
"withErrors": true,
"successfullyImportedTotal": "Successfully Imported Total 1",
"failedToBeImportedTotal": "Failed To Be imported Total 2",
"successfullyUpdatedTotal": "Total Successfully Updated: 1",
"failedToBeUpdatedTotal": "Total Not Updated: 2",
"totalProcessed": "Total processed: 3",
"needIdentification": true,
"IdentificationResult": true,
"identificationOrderNumber": "sample string 3",
"identificationErrorText": "sample string 4",
"identificationMessageResult": "Identifier request created. Order Number: sample string 3"
}
}
application/xml, text/xml
Sample:
<ImportDriversDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
<Address>
<City>sample string 4</City>
<ContactName>sample string 5</ContactName>
<ContactPhone>sample string 6</ContactPhone>
<DeliveryAddressIsLocation>true</DeliveryAddressIsLocation>
<IdCountry>824bc3ce-ead6-4165-bc5e-9530105c7d60</IdCountry>
<IdState>8810e5f3-e90f-45ad-9dd7-3242415d5e70</IdState>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<ZipCode>sample string 3</ZipCode>
</Address>
<File>QEA=</File>
<IdCompanyContract>be3b24c9-814b-497f-bcad-6d98ed532cc6</IdCompanyContract>
<IdHologramTypeModel>577ec450-be76-4be3-a34c-b51ec87ed634</IdHologramTypeModel>
<IdIdentificationsTypeModel>1d1a7359-d2f5-4b59-87db-1f4586806104</IdIdentificationsTypeModel>
<IdLoyaltyProgram>c8f35c63-c8e0-4695-9bf5-3e268e18d6c9</IdLoyaltyProgram>
<IdProgram>ab779b4a-40d0-4013-a2ec-540d88b2bed2</IdProgram>
<IdentificationsType>1</IdentificationsType>
<ImportResult>
<IdentificationResult>true</IdentificationResult>
<correctProcessedQuantity>1</correctProcessedQuantity>
<errorProcessedQuantity>2</errorProcessedQuantity>
<identificationErrorText>sample string 4</identificationErrorText>
<identificationOrderNumber>sample string 3</identificationOrderNumber>
<listItemError>
<ImportItemDto>
<errorList xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</errorList>
<row>1</row>
</ImportItemDto>
<ImportItemDto>
<errorList xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</errorList>
<row>1</row>
</ImportItemDto>
</listItemError>
<needIdentification>true</needIdentification>
<totalProcessedQuantity>3</totalProcessedQuantity>
</ImportResult>
<NeedIdentification>true</NeedIdentification>
</ImportDriversDto>