Mercedes.Agency.Orchestration.API

<back to all web services

ProcessBulkAllocationRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/PerformBulkAllocationsBulk allocates commission numbers to back ordersTakes a list of previously validated commission numbers and back order reference numbers, calls Vehicle Data API to fetch vehicle details before calling Agency API to update back orders in bulk with all vehicle details.
"use strict";
export class ProcessBulkAllocationResponse {
    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 ProcessBulkAllocationRequest {
    /** @param {{Allocations?:BackOrderAllocation[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BackOrderAllocation[]} */
    Allocations = [];
}

JavaScript ProcessBulkAllocationRequest 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/PerformBulkAllocations HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProcessBulkAllocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders">
  <Allocations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:BackOrderAllocation>
      <d2p1:BackOrder>String</d2p1:BackOrder>
      <d2p1:Comm>String</d2p1:Comm>
      <d2p1:Row>0</d2p1:Row>
    </d2p1:BackOrderAllocation>
  </Allocations>
</ProcessBulkAllocationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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