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