| POST | /v1/BackOrder/ValidateBulkAllocations | Validates commission numbers allocated to back order reference numbers provided in a csv file. | Reads a csv file and parses a list of commission numbers and their allocated back order reference numbers then calls Vehicle Data API to validate the vehicles. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class ValidateBackOrderBulkAllocationsRequest
{
}
open class BackOrderBulkAllocationResponse
{
open var Message:String? = null
open var Vehicles:BackOrderBulkAllocationVehicles? = null
open var Successful:Boolean? = null
}
open class BackOrderBulkAllocationVehicles
{
open var TotalVehicles:Int? = null
open var ValidVehicles:Int? = null
open var WarningVehicles:Int? = null
open var InvalidVehicles:Int? = null
open var Valid:ArrayList<BackOrderAllocation> = ArrayList<BackOrderAllocation>()
open var Warning:ArrayList<InvalidBackOrderAllocation> = ArrayList<InvalidBackOrderAllocation>()
open var Invalid:ArrayList<InvalidBackOrderAllocation> = ArrayList<InvalidBackOrderAllocation>()
}
open class BackOrderAllocation
{
open var Row:Int? = null
open var Comm:String? = null
open var BackOrder:String? = null
}
open class InvalidBackOrderAllocation : BackOrderAllocation()
{
open var ValidationMessage:String? = null
}
Kotlin ValidateBackOrderBulkAllocationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/BackOrder/ValidateBulkAllocations HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Message: One or more errors in file,
Vehicles:
{
TotalVehicles: 3,
ValidVehicles: 1,
WarningVehicles: 1,
InvalidVehicles: 1,
Valid:
[
{
Row: 0,
Comm: String,
BackOrder: String
}
],
Warning:
[
{
ValidationMessage: String,
Row: 0,
Comm: String,
BackOrder: String
}
],
Invalid:
[
{
ValidationMessage: String,
Row: 0,
Comm: String,
BackOrder: String
}
]
},
Successful: False
}