Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkAllocationsRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkAllocations

export class ValidateBackOrderBulkAllocationsRequest
{

    public constructor(init?: Partial<ValidateBackOrderBulkAllocationsRequest>) { (Object as any).assign(this, init); }
}

export class BackOrderAllocation
{
    public Row: number;
    public Comm: string;
    public BackOrder: string;

    public constructor(init?: Partial<BackOrderAllocation>) { (Object as any).assign(this, init); }
}

export class InvalidBackOrderAllocation extends BackOrderAllocation
{
    public ValidationMessage: string;

    public constructor(init?: Partial<InvalidBackOrderAllocation>) { super(init); (Object as any).assign(this, init); }
}

export class BackOrderBulkAllocationVehicles
{
    public TotalVehicles: number;
    public ValidVehicles: number;
    public WarningVehicles: number;
    public InvalidVehicles: number;
    public Valid: BackOrderAllocation[] = [];
    public Warning: InvalidBackOrderAllocation[] = [];
    public Invalid: InvalidBackOrderAllocation[] = [];

    public constructor(init?: Partial<BackOrderBulkAllocationVehicles>) { (Object as any).assign(this, init); }
}

export class BackOrderBulkAllocationResponse
{
    public Message: string;
    public Vehicles: BackOrderBulkAllocationVehicles;
    public Successful: boolean;

    public constructor(init?: Partial<BackOrderBulkAllocationResponse>) { (Object as any).assign(this, init); }
}

TypeScript ValidateBackOrderBulkAllocationsRequest DTOs

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
}