POST ImportVehicles
Creates vehicles using an uploaded Excel file.
Request Information
URI Parameters
None.
Body Parameters
The data of the vehicles.
ImportVehiclesDtoName | 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": "2048cc00-3acf-47f4-89ab-86d02f8b4f61", "IdentificationsType": 1, "IdIdentificationsTypeModel": "bee14d9d-d6e5-4e94-8bba-998de82a0333", "IdProgram": "fd8e5a67-e320-4988-ae78-8bdc5f0ad1ee", "IdLoyaltyProgram": "f7d36775-2901-4c7a-9004-b1070d049ff5", "IdHologramTypeModel": "620238fd-687e-4a50-ae79-af4730153159", "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": "b707ffbd-8f7c-451c-8dc8-4d9a217401da", "IdState": "485dd498-9846-41a7-854b-215b854eba25", "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:
<ImportVehiclesDto 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>b707ffbd-8f7c-451c-8dc8-4d9a217401da</IdCountry> <IdState>485dd498-9846-41a7-854b-215b854eba25</IdState> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <ZipCode>sample string 3</ZipCode> </Address> <File>QEA=</File> <IdCompanyContract>2048cc00-3acf-47f4-89ab-86d02f8b4f61</IdCompanyContract> <IdHologramTypeModel>620238fd-687e-4a50-ae79-af4730153159</IdHologramTypeModel> <IdIdentificationsTypeModel>bee14d9d-d6e5-4e94-8bba-998de82a0333</IdIdentificationsTypeModel> <IdLoyaltyProgram>f7d36775-2901-4c7a-9004-b1070d049ff5</IdLoyaltyProgram> <IdProgram>fd8e5a67-e320-4988-ae78-8bdc5f0ad1ee</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> </ImportVehiclesDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Object of ImportDto class.
ImportVehiclesDtoName | 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": "4c8c5dc9-3627-41e2-8ed9-4dbc087d6664", "IdentificationsType": 1, "IdIdentificationsTypeModel": "8f0c9f28-327a-488e-8a56-f6928e11e610", "IdProgram": "e16b9fdf-7c18-4bd5-b2a2-cd1c510a86da", "IdLoyaltyProgram": "b19161d0-342d-4cbd-995c-49efb46c7b41", "IdHologramTypeModel": "4e50f481-1984-4608-9792-3b9b003ef7ea", "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": "acd03d0a-e1f0-4293-95f5-2b495a7a6a0e", "IdState": "a7b9da77-057b-4969-84d9-1c843ce5f880", "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:
<ImportVehiclesDto 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>acd03d0a-e1f0-4293-95f5-2b495a7a6a0e</IdCountry> <IdState>a7b9da77-057b-4969-84d9-1c843ce5f880</IdState> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <ZipCode>sample string 3</ZipCode> </Address> <File>QEA=</File> <IdCompanyContract>4c8c5dc9-3627-41e2-8ed9-4dbc087d6664</IdCompanyContract> <IdHologramTypeModel>4e50f481-1984-4608-9792-3b9b003ef7ea</IdHologramTypeModel> <IdIdentificationsTypeModel>8f0c9f28-327a-488e-8a56-f6928e11e610</IdIdentificationsTypeModel> <IdLoyaltyProgram>b19161d0-342d-4cbd-995c-49efb46c7b41</IdLoyaltyProgram> <IdProgram>e16b9fdf-7c18-4bd5-b2a2-cd1c510a86da</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> </ImportVehiclesDto>