Mercedes.Agency.Orchestration.API

LinkedBackOrderCommAudit

The following routes are available for this service:
POST	/v1/BackOrderLinkedComms		Get the audit for back orders linked comms

"use strict";
export class BackOrderLinkedCommsAuditDateCriteria {
    /** @param {{From?:string,To?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    From;
    /** @type {?string} */
    To;
}
export class LinkedBackOrderCommAudit {
    /** @param {{GssnIds?:string[],DateCriteria?:BackOrderLinkedCommsAuditDateCriteria}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string[]} */
    GssnIds;
    /** @type {?BackOrderLinkedCommsAuditDateCriteria} */
    DateCriteria;
}
/** @typedef {number} */
export var BackOrderStatus;
(function (BackOrderStatus) {
    BackOrderStatus[BackOrderStatus["Submitted"] = 1] = "Submitted"
    BackOrderStatus[BackOrderStatus["Acknowledged"] = 2] = "Acknowledged"
    BackOrderStatus[BackOrderStatus["Cancelled"] = 3] = "Cancelled"
    BackOrderStatus[BackOrderStatus["Completed"] = 4] = "Completed"
    BackOrderStatus[BackOrderStatus["Confirmed"] = 5] = "Confirmed"
})(BackOrderStatus || (BackOrderStatus = {}));
export class BackOrderLinkedCommsAudit {
    /** @param {{Guid?:string,BackOrderReference?:string,UserId?:string,Showroom?:string,CommLinked?:string,SalesDescription?:string,Colour?:string,Upholstery?:string,Sellable?:boolean,LinkedDate?:string,Status?:BackOrderStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    BackOrderReference;
    /** @type {string} */
    UserId;
    /** @type {string} */
    Showroom;
    /** @type {string} */
    CommLinked;
    /** @type {string} */
    SalesDescription;
    /** @type {string} */
    Colour;
    /** @type {string} */
    Upholstery;
    /** @type {boolean} */
    Sellable;
    /** @type {string} */
    LinkedDate;
    /** @type {BackOrderStatus} */
    Status;
}
export class LinkedBackOrderCommAuditResponse {
    /** @param {{Audits?:BackOrderLinkedCommsAudit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BackOrderLinkedCommsAudit[]} */
    Audits = [];
}

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