POST | /v1/BackOrder/ValidateBulkAllocations |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Message | form | string | Yes | |
Vehicles | form | BackOrderBulkAllocationVehicles | Yes | |
Successful | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalVehicles | form | int | No | |
ValidVehicles | form | int | No | |
WarningVehicles | form | int | No | |
InvalidVehicles | form | int | No | |
Valid | form | List<BackOrderAllocation> | Yes | |
Warning | form | List<InvalidBackOrderAllocation> | Yes | |
Invalid | form | List<InvalidBackOrderAllocation> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Row | form | int | No | |
Comm | form | string | Yes | |
BackOrder | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ValidationMessage | form | string | Yes |
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 }