Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkAllocationsRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkAllocations
BackOrderBulkAllocationResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformstringYes
VehiclesformBackOrderBulkAllocationVehiclesYes
SuccessfulformboolNo
BackOrderBulkAllocationVehicles Parameters:
NameParameterData TypeRequiredDescription
TotalVehiclesformintNo
ValidVehiclesformintNo
WarningVehiclesformintNo
InvalidVehiclesformintNo
ValidformList<BackOrderAllocation>Yes
WarningformList<InvalidBackOrderAllocation>Yes
InvalidformList<InvalidBackOrderAllocation>Yes
BackOrderAllocation Parameters:
NameParameterData TypeRequiredDescription
RowformintNo
CommformstringYes
BackOrderformstringYes
InvalidBackOrderAllocation Parameters:
NameParameterData TypeRequiredDescription
ValidationMessageformstringYes

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

HTTP + 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
}