Mercedes.Agency.Orchestration.API

ValidateBackOrderBulkStatusAllocationsRequest

BackOrder

The following routes are available for this service:
POST	/v1/BackOrder/ValidateBulkStatusAllocations	Validates back order references and statuses provided in a csv file for allocation to active back orders.	Reads a csv file and parses a list of back order references, MBUK assistance statuses and messages for validation before allocation to active back orders.


export class ValidateBackOrderBulkStatusAllocationsRequest
{

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

export class BackOrderStatusAllocation
{
    public Row: number;
    public BackOrderReference: string;
    public Status: string;
    public Message: string;

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

export class InvalidBackOrderStatusAllocation extends BackOrderStatusAllocation
{
    public ValidationMessage: string;

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

export class BackOrderBulkStatusAllocation
{
    public TotalBackOrders: number;
    public ValidBackOrders: number;
    public InvalidBackOrders: number;
    public Valid: BackOrderStatusAllocation[] = [];
    public Invalid: InvalidBackOrderStatusAllocation[] = [];

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

export class BackOrderBulkStatusAllocationsResponse
{
    public Message: string;
    public BackOrders: BackOrderBulkStatusAllocation;
    public Successful: boolean;
    public Filename: string;

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

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

<ValidateBackOrderBulkStatusAllocationsRequest 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

<BackOrderBulkStatusAllocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Business.Poco.BulkStatusAllocation">
  <BackOrders>
    <Invalid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation">
      <d3p1:InvalidBackOrderStatusAllocation>
        <d3p1:BackOrderReference>String</d3p1:BackOrderReference>
        <d3p1:Message>String</d3p1:Message>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:Status>String</d3p1:Status>
        <d3p1:ValidationMessage>String</d3p1:ValidationMessage>
      </d3p1:InvalidBackOrderStatusAllocation>
    </Invalid>
    <Valid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation">
      <d3p1:BackOrderStatusAllocation>
        <d3p1:BackOrderReference>String</d3p1:BackOrderReference>
        <d3p1:Message>String</d3p1:Message>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:Status>String</d3p1:Status>
      </d3p1:BackOrderStatusAllocation>
    </Valid>
  </BackOrders>
  <Filename>String</Filename>
</BackOrderBulkStatusAllocationsResponse>