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 .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">
  <Successful>false</Successful>
  <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>