Mercedes.Agency.Orchestration.API

<back to all web services

LinkedBackOrderCommAudit

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrderLinkedCommsGet the audit for back orders linked comms

export class BackOrderLinkedCommsAuditDateCriteria
{
    public From?: string;
    public To?: string;

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

export class LinkedBackOrderCommAudit
{
    public GssnIds?: string[];
    public DateCriteria?: BackOrderLinkedCommsAuditDateCriteria;

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

export enum BackOrderStatus
{
    Submitted = 1,
    Acknowledged = 2,
    Cancelled = 3,
    Completed = 4,
    Confirmed = 5,
}

export class BackOrderLinkedCommsAudit
{
    public Guid: string;
    public BackOrderReference: string;
    public UserId: string;
    public Showroom: string;
    public CommLinked: string;
    public SalesDescription: string;
    public Colour: string;
    public Upholstery: string;
    public Sellable: boolean;
    public LinkedDate: string;
    public Status: BackOrderStatus;

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

export class LinkedBackOrderCommAuditResponse
{
    public Audits: BackOrderLinkedCommsAudit[] = [];

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

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

<LinkedBackOrderCommAudit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Audits">
  <DateCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:From>0001-01-01T00:00:00</d2p1:From>
    <d2p1:To>0001-01-01T00:00:00</d2p1:To>
  </DateCriteria>
  <GssnIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GssnIds>
</LinkedBackOrderCommAudit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LinkedBackOrderCommAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses">
  <Audits xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:BackOrderLinkedCommsAudit>
      <d2p1:BackOrderReference>String</d2p1:BackOrderReference>
      <d2p1:Colour>String</d2p1:Colour>
      <d2p1:CommLinked>String</d2p1:CommLinked>
      <d2p1:Guid>String</d2p1:Guid>
      <d2p1:LinkedDate>String</d2p1:LinkedDate>
      <d2p1:SalesDescription>String</d2p1:SalesDescription>
      <d2p1:Sellable>false</d2p1:Sellable>
      <d2p1:Showroom>String</d2p1:Showroom>
      <d2p1:Status>Submitted</d2p1:Status>
      <d2p1:Upholstery>String</d2p1:Upholstery>
      <d2p1:UserId>String</d2p1:UserId>
    </d2p1:BackOrderLinkedCommsAudit>
  </Audits>
</LinkedBackOrderCommAuditResponse>