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": "abf810af-0092-4636-b1a2-7813a3593ba8",
"IdentificationsType": 1,
"IdIdentificationsTypeModel": "4878f3f4-9169-4fb8-916c-975b5e4b70fc",
"IdProgram": "939c169a-eb58-445d-a063-55e572720f54",
"IdLoyaltyProgram": "7e5364a7-ebaf-4bd7-bed4-f1a6a3a137f3",
"IdHologramTypeModel": "2eb8fe2d-0768-4195-9bc9-5cba4e0dfc79",
"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": "4a931e11-c09b-40ff-90a1-96fc6bf64c2d",
"IdState": "97449c5b-d5a0-4d55-bf40-ca48c7391474",
"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",
"identificationSuccessQuantity": 5,
"identificationErrorQuantity": 6,
"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>4a931e11-c09b-40ff-90a1-96fc6bf64c2d</IdCountry>
<IdState>97449c5b-d5a0-4d55-bf40-ca48c7391474</IdState>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<ZipCode>sample string 3</ZipCode>
</Address>
<File>QEA=</File>
<IdCompanyContract>abf810af-0092-4636-b1a2-7813a3593ba8</IdCompanyContract>
<IdHologramTypeModel>2eb8fe2d-0768-4195-9bc9-5cba4e0dfc79</IdHologramTypeModel>
<IdIdentificationsTypeModel>4878f3f4-9169-4fb8-916c-975b5e4b70fc</IdIdentificationsTypeModel>
<IdLoyaltyProgram>7e5364a7-ebaf-4bd7-bed4-f1a6a3a137f3</IdLoyaltyProgram>
<IdProgram>939c169a-eb58-445d-a063-55e572720f54</IdProgram>
<IdentificationsType>1</IdentificationsType>
<ImportResult>
<IdentificationResult>true</IdentificationResult>
<correctProcessedQuantity>1</correctProcessedQuantity>
<errorProcessedQuantity>2</errorProcessedQuantity>
<identificationErrorQuantity>6</identificationErrorQuantity>
<identificationErrorText>sample string 4</identificationErrorText>
<identificationOrderNumber>sample string 3</identificationOrderNumber>
<identificationSuccessQuantity>5</identificationSuccessQuantity>
<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": "c55fb0a5-9ab8-4bfd-9f24-db90cf8d21a8",
"IdentificationsType": 1,
"IdIdentificationsTypeModel": "2bb3c178-3e9f-44a6-b123-a4e065c28e78",
"IdProgram": "c9edfbe6-c3ad-4ef9-bd89-8f13f98f616d",
"IdLoyaltyProgram": "0459ffe9-3387-4a78-a493-a6f04ad386c1",
"IdHologramTypeModel": "d0f9a391-c40e-4cbe-8e63-c38301c0e5ba",
"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": "d6a5d41d-d09a-407d-b296-cd699d037174",
"IdState": "3fe39328-c6ae-4062-9a32-8547e28988dc",
"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",
"identificationSuccessQuantity": 5,
"identificationErrorQuantity": 6,
"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>d6a5d41d-d09a-407d-b296-cd699d037174</IdCountry>
<IdState>3fe39328-c6ae-4062-9a32-8547e28988dc</IdState>
<Street1>sample string 1</Street1>
<Street2>sample string 2</Street2>
<ZipCode>sample string 3</ZipCode>
</Address>
<File>QEA=</File>
<IdCompanyContract>c55fb0a5-9ab8-4bfd-9f24-db90cf8d21a8</IdCompanyContract>
<IdHologramTypeModel>d0f9a391-c40e-4cbe-8e63-c38301c0e5ba</IdHologramTypeModel>
<IdIdentificationsTypeModel>2bb3c178-3e9f-44a6-b123-a4e065c28e78</IdIdentificationsTypeModel>
<IdLoyaltyProgram>0459ffe9-3387-4a78-a493-a6f04ad386c1</IdLoyaltyProgram>
<IdProgram>c9edfbe6-c3ad-4ef9-bd89-8f13f98f616d</IdProgram>
<IdentificationsType>1</IdentificationsType>
<ImportResult>
<IdentificationResult>true</IdentificationResult>
<correctProcessedQuantity>1</correctProcessedQuantity>
<errorProcessedQuantity>2</errorProcessedQuantity>
<identificationErrorQuantity>6</identificationErrorQuantity>
<identificationErrorText>sample string 4</identificationErrorText>
<identificationOrderNumber>sample string 3</identificationOrderNumber>
<identificationSuccessQuantity>5</identificationSuccessQuantity>
<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>