Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkStatusAllocationsRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkStatusAllocationsValidates back order references and statuses provided in a csv file for allocation to active back orders.Reads a csv file and parses a list of back order references, MBUK assistance statuses and messages for validation before allocation to active back orders.
BackOrderBulkStatusAllocationsResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformstringYes
BackOrdersformBackOrderBulkStatusAllocationYes
SuccessfulformboolNo
FilenameformstringYes
BackOrderBulkStatusAllocation Parameters:
NameParameterData TypeRequiredDescription
TotalBackOrdersformintNo
ValidBackOrdersformintNo
InvalidBackOrdersformintNo
ValidformList<BackOrderStatusAllocation>Yes
InvalidformList<InvalidBackOrderStatusAllocation>Yes
BackOrderStatusAllocation Parameters:
NameParameterData TypeRequiredDescription
RowformintNo
BackOrderReferenceformstringNo
StatusformstringNo
MessageformstringNo
InvalidBackOrderStatusAllocation Parameters:
NameParameterData TypeRequiredDescription
ValidationMessageformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/BackOrder/ValidateBulkStatusAllocations HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Message":"One or more errors in file","BackOrders":{"TotalBackOrders":2,"ValidBackOrders":1,"InvalidBackOrders":1,"Valid":[{"Row":0,"BackOrderReference":"String","Status":"String","Message":"String"}],"Invalid":[{"ValidationMessage":"String","Row":0,"BackOrderReference":"String","Status":"String","Message":"String"}]},"Successful":false,"Filename":"String"}