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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GssnIds: 
	[
		String
	],
	DateCriteria: 
	{
		From: 0001-01-01,
		To: 0001-01-01
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Audits: 
	[
		{
			Guid: String,
			BackOrderReference: String,
			UserId: String,
			Showroom: String,
			CommLinked: String,
			SalesDescription: String,
			Colour: String,
			Upholstery: String,
			Sellable: False,
			LinkedDate: String,
			Status: Submitted
		}
	]
}