Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkAllocationsRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkAllocations
"use strict";
export class ValidateBackOrderBulkAllocationsRequest {
    constructor(init) { Object.assign(this, init) }
}
export class BackOrderAllocation {
    /** @param {{Row?:number,Comm?:string,BackOrder?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Row;
    /** @type {string} */
    Comm;
    /** @type {string} */
    BackOrder;
}
export class InvalidBackOrderAllocation extends BackOrderAllocation {
    /** @param {{ValidationMessage?:string,Row?:number,Comm?:string,BackOrder?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ValidationMessage;
}
export class BackOrderBulkAllocationVehicles {
    /** @param {{TotalVehicles?:number,ValidVehicles?:number,WarningVehicles?:number,InvalidVehicles?:number,Valid?:BackOrderAllocation[],Warning?:InvalidBackOrderAllocation[],Invalid?:InvalidBackOrderAllocation[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalVehicles;
    /** @type {number} */
    ValidVehicles;
    /** @type {number} */
    WarningVehicles;
    /** @type {number} */
    InvalidVehicles;
    /** @type {BackOrderAllocation[]} */
    Valid = [];
    /** @type {InvalidBackOrderAllocation[]} */
    Warning = [];
    /** @type {InvalidBackOrderAllocation[]} */
    Invalid = [];
}
export class BackOrderBulkAllocationResponse {
    /** @param {{Message?:string,Vehicles?:BackOrderBulkAllocationVehicles,Successful?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Message;
    /** @type {BackOrderBulkAllocationVehicles} */
    Vehicles;
    /** @type {boolean} */
    Successful;
}

JavaScript ValidateBackOrderBulkAllocationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
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}