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": "a1ac7a0d-0247-40bc-81ab-621f2f7426e7", "IdentificationsType": 1, "IdIdentificationsTypeModel": "830fd493-7764-4fe7-a9f4-ef501f08a6ad", "IdProgram": "f07c9292-12d0-4cab-8cd5-439bf2730a11", "IdLoyaltyProgram": "6b3fed57-8c83-4983-9866-4d4df8f62c87", "IdHologramTypeModel": "eab59bcd-e0f8-43e3-9a03-c8895440590b", "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": "61981f3d-f232-4113-8d92-e5ec57408be0", "IdState": "ed09cdd7-1984-4068-88c8-fa4da8a1017f", "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>61981f3d-f232-4113-8d92-e5ec57408be0</IdCountry> <IdState>ed09cdd7-1984-4068-88c8-fa4da8a1017f</IdState> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <ZipCode>sample string 3</ZipCode> </Address> <File>QEA=</File> <IdCompanyContract>a1ac7a0d-0247-40bc-81ab-621f2f7426e7</IdCompanyContract> <IdHologramTypeModel>eab59bcd-e0f8-43e3-9a03-c8895440590b</IdHologramTypeModel> <IdIdentificationsTypeModel>830fd493-7764-4fe7-a9f4-ef501f08a6ad</IdIdentificationsTypeModel> <IdLoyaltyProgram>6b3fed57-8c83-4983-9866-4d4df8f62c87</IdLoyaltyProgram> <IdProgram>f07c9292-12d0-4cab-8cd5-439bf2730a11</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": "df88c03e-b422-4461-846d-0c0fd552dc18", "IdentificationsType": 1, "IdIdentificationsTypeModel": "4d7f105f-50ec-4375-983d-f6f808755464", "IdProgram": "d80c4b1f-141e-458a-8ca7-4f1c7d1c0645", "IdLoyaltyProgram": "61cc67ed-bdd1-4189-ba25-3cfc9f987ab1", "IdHologramTypeModel": "5cb34462-265a-412f-b574-a04326fac4e0", "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": "eee33b2d-fcc8-4048-bf65-33a147e597f3", "IdState": "01cd46a3-f9cf-4bc2-83ae-878d1778e9ce", "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>eee33b2d-fcc8-4048-bf65-33a147e597f3</IdCountry> <IdState>01cd46a3-f9cf-4bc2-83ae-878d1778e9ce</IdState> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <ZipCode>sample string 3</ZipCode> </Address> <File>QEA=</File> <IdCompanyContract>df88c03e-b422-4461-846d-0c0fd552dc18</IdCompanyContract> <IdHologramTypeModel>5cb34462-265a-412f-b574-a04326fac4e0</IdHologramTypeModel> <IdIdentificationsTypeModel>4d7f105f-50ec-4375-983d-f6f808755464</IdIdentificationsTypeModel> <IdLoyaltyProgram>61cc67ed-bdd1-4189-ba25-3cfc9f987ab1</IdLoyaltyProgram> <IdProgram>d80c4b1f-141e-458a-8ca7-4f1c7d1c0645</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>