POST DriversUpdateRequestOrderByTemplate
Handles the upload and validation of a Driver Update Template file. 1. Validates that the uploaded file has a supported extension (.xls or .xlsx). 2. Uses to check if the file structure matches the expected format. 3. If validation fails, returns the corresponding errors. 4. If validation passes, creates a background process to handle the file asynchronously, avoiding blocking the HTTP request.
Request Information
URI Parameters
None.
Body Parameters
Data transfer object containing the network, contract, file information, and whether to create associated Driver App users.
DriversUpdateRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| File | Collection of byte |
None. |
|
| FileName | string |
None. |
|
| IdNetwork | globally unique identifier |
None. |
|
| IdCompanyContract | globally unique identifier |
None. |
|
| CreateDriverAppUsers | boolean |
None. |
Request Formats
application/json, text/json
{
"File": "QEA=",
"FileName": "sample string 1",
"IdNetwork": "3df7be58-1f04-45c9-97cc-638d4275460d",
"IdCompanyContract": "c662a53e-2ab7-4e63-861a-a94bc60d97cb",
"CreateDriverAppUsers": true
}
application/xml, text/xml
<DriversUpdateRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model.Driver"> <CreateDriverAppUsers>true</CreateDriverAppUsers> <File>QEA=</File> <FileName>sample string 1</FileName> <IdCompanyContract>c662a53e-2ab7-4e63-861a-a94bc60d97cb</IdCompanyContract> <IdNetwork>3df7be58-1f04-45c9-97cc-638d4275460d</IdNetwork> </DriversUpdateRequestDto>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
- 200 OK with validation errors if the file is invalid. - 200 OK with a success message if the background process is created successfully. - 200 OK with Success = false if no file was provided. - 400 BadRequest with an error message if an exception occurs.
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.