Mercedes.Agency.Orchestration.API

ValidateBackOrderBulkAllocationsRequest

BackOrder

The following routes are available for this service:
POST	/v1/BackOrder/ValidateBulkAllocations	Validates commission numbers allocated to back order reference numbers provided in a csv file.	Reads a csv file and parses a list of commission numbers and their allocated back order reference numbers then calls Vehicle Data API to validate the vehicles.

"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 .xml suffix or ?format=xml

HTTP + XML

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

<ValidateBackOrderBulkAllocationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BackOrderBulkAllocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Business.Poco">
  <Vehicles>
    <Invalid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
      <d3p1:InvalidBackOrderAllocation>
        <d3p1:BackOrder>String</d3p1:BackOrder>
        <d3p1:Comm>String</d3p1:Comm>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:ValidationMessage>String</d3p1:ValidationMessage>
      </d3p1:InvalidBackOrderAllocation>
    </Invalid>
    <Valid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
      <d3p1:BackOrderAllocation>
        <d3p1:BackOrder>String</d3p1:BackOrder>
        <d3p1:Comm>String</d3p1:Comm>
        <d3p1:Row>0</d3p1:Row>
      </d3p1:BackOrderAllocation>
    </Valid>
    <Warning xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
      <d3p1:InvalidBackOrderAllocation>
        <d3p1:BackOrder>String</d3p1:BackOrder>
        <d3p1:Comm>String</d3p1:Comm>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:ValidationMessage>String</d3p1:ValidationMessage>
      </d3p1:InvalidBackOrderAllocation>
    </Warning>
  </Vehicles>
</BackOrderBulkAllocationResponse>