Mercedes.Agency.Orchestration.API

LinkedBackOrderCommAudit

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderLinkedCommsAuditDateCriteria:
    from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
    to: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkedBackOrderCommAudit:
    gssn_ids: Optional[List[str]] = None
    date_criteria: Optional[BackOrderLinkedCommsAuditDateCriteria] = None


class BackOrderStatus(IntEnum):
    SUBMITTED = 1
    ACKNOWLEDGED = 2
    CANCELLED = 3
    COMPLETED = 4
    CONFIRMED = 5


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderLinkedCommsAudit:
    guid: Optional[str] = None
    back_order_reference: Optional[str] = None
    user_id: Optional[str] = None
    showroom: Optional[str] = None
    comm_linked: Optional[str] = None
    sales_description: Optional[str] = None
    colour: Optional[str] = None
    upholstery: Optional[str] = None
    sellable: bool = False
    linked_date: Optional[str] = None
    status: Optional[BackOrderStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LinkedBackOrderCommAuditResponse:
    audits: List[BackOrderLinkedCommsAudit] = field(default_factory=list)

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