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
import Foundation
import ServiceStack

public class LinkedBackOrderCommAudit : Codable
{
    public var gssnIds:[String]
    public var dateCriteria:BackOrderLinkedCommsAuditDateCriteria

    required public init(){}
}

public class BackOrderLinkedCommsAuditDateCriteria : Codable
{
    public var from:Date?
    public var to:Date?

    required public init(){}
}

public class LinkedBackOrderCommAuditResponse : Codable
{
    public var audits:[BackOrderLinkedCommsAudit] = []

    required public init(){}
}

public class BackOrderLinkedCommsAudit : Codable
{
    public var guid:String
    public var backOrderReference:String
    public var userId:String
    public var showroom:String
    public var commLinked:String
    public var salesDescription:String
    public var colour:String
    public var upholstery:String
    public var sellable:Bool
    public var linkedDate:String
    public var status:BackOrderStatus

    required public init(){}
}

public enum BackOrderStatus : Int, Codable
{
    case Submitted = 1
    case Acknowledged = 2
    case Cancelled = 3
    case Completed = 4
    case Confirmed = 5
}


Swift 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
		}
	]
}