POST ImportDrivers

Creates drivers using an uploaded Excel file.

Request Information

URI Parameters

None.

Body Parameters

The data of the drivers.

Name	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": "c7926661-9813-4c4d-a480-b562d49de18e",
  "IdentificationsType": 1,
  "IdIdentificationsTypeModel": "ba987d00-5f0c-4420-a558-e9d86fc58af6",
  "IdProgram": "8aa8b7d4-6862-4685-b434-6154d2280d0e",
  "IdLoyaltyProgram": "657bbc2c-c73e-4942-9894-d828389fce87",
  "IdHologramTypeModel": "d4525711-b643-44c3-8b5c-2cb60abd85d7",
  "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": "7c15186d-df70-4a35-a899-10bd95dd0011",
    "IdState": "f09893f9-6c9c-4a69-bc54-ba740a963022",
    "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>7c15186d-df70-4a35-a899-10bd95dd0011</IdCountry>
    <IdState>f09893f9-6c9c-4a69-bc54-ba740a963022</IdState>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
    <ZipCode>sample string 3</ZipCode>
  </Address>
  <File>QEA=</File>
  <IdCompanyContract>c7926661-9813-4c4d-a480-b562d49de18e</IdCompanyContract>
  <IdHologramTypeModel>d4525711-b643-44c3-8b5c-2cb60abd85d7</IdHologramTypeModel>
  <IdIdentificationsTypeModel>ba987d00-5f0c-4420-a558-e9d86fc58af6</IdIdentificationsTypeModel>
  <IdLoyaltyProgram>657bbc2c-c73e-4942-9894-d828389fce87</IdLoyaltyProgram>
  <IdProgram>8aa8b7d4-6862-4685-b434-6154d2280d0e</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	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": "ee8b8d5d-5de7-462b-a971-7d23761be337",
  "IdentificationsType": 1,
  "IdIdentificationsTypeModel": "0ca4b956-5d54-45d8-aaec-9c3d9f35182c",
  "IdProgram": "0c063691-9c56-4da8-b656-150760b12f61",
  "IdLoyaltyProgram": "8495b391-f785-419e-9c61-b126b796a4aa",
  "IdHologramTypeModel": "8a39c2fc-83b4-4e81-a6e3-2d95c572f3b4",
  "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": "27678d68-9053-4514-ac04-d76d17962cd8",
    "IdState": "dc5f1f20-a2ee-4c4c-904a-35c1adda118e",
    "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>27678d68-9053-4514-ac04-d76d17962cd8</IdCountry>
    <IdState>dc5f1f20-a2ee-4c4c-904a-35c1adda118e</IdState>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
    <ZipCode>sample string 3</ZipCode>
  </Address>
  <File>QEA=</File>
  <IdCompanyContract>ee8b8d5d-5de7-462b-a971-7d23761be337</IdCompanyContract>
  <IdHologramTypeModel>8a39c2fc-83b4-4e81-a6e3-2d95c572f3b4</IdHologramTypeModel>
  <IdIdentificationsTypeModel>0ca4b956-5d54-45d8-aaec-9c3d9f35182c</IdIdentificationsTypeModel>
  <IdLoyaltyProgram>8495b391-f785-419e-9c61-b126b796a4aa</IdLoyaltyProgram>
  <IdProgram>0c063691-9c56-4da8-b656-150760b12f61</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>