Mercedes.Agency.Orchestration.API

<back to all web services

UpdateBackOrderRequest

BackOrder
Requires Authentication
The following routes are available for this service:
PUT/v1/backorder/{Guid}Update Back Order by Guid
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 UpdateBackOrderResponse:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JsonVersion(IJsonVersion):
    version: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CriteriaModel:
    description: Optional[str] = None
    id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CriteriaDifference:
    model: bool = False
    transmission: bool = False
    fuel: bool = False
    upholstery: bool = False
    equipment: bool = False
    line: bool = False
    body_style: bool = False
    colour_group: bool = False
    packages: bool = False
    engine: bool = False
    additional_information: bool = False
    url_referrer: bool = False
    preferred_delivery_date: bool = False
    is_smart: bool = False
    is_specialised: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CriteriaBase(JsonVersion):
    transmission: List[str] = field(default_factory=list)
    fuel: List[str] = field(default_factory=list)
    upholstery: List[str] = field(default_factory=list)
    equipment: List[str] = field(default_factory=list)
    line: List[str] = field(default_factory=list)
    body_style: List[str] = field(default_factory=list)
    colour_group: List[str] = field(default_factory=list)
    packages: List[str] = field(default_factory=list)
    model: List[CriteriaModel] = field(default_factory=list)
    url_referrer: Optional[str] = None
    preferred_delivery_date: Optional[str] = None
    # @ApiMember(ExcludeInSchema=true)
    is_new_model: bool = False

    # @ApiMember(ExcludeInSchema=true)
    is_smart: bool = False

    # @ApiMember(ExcludeInSchema=true)
    is_specialised: bool = False

    # @ApiMember(ExcludeInSchema=true)
    criteria_difference: Optional[CriteriaDifference] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V2EngineCriteria:
    badge: Optional[str] = None
    brand: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V2Criteria(CriteriaBase):
    engine: List[V2EngineCriteria] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateBackOrderRequest(IPut):
    guid: Optional[str] = None
    agent_criteria: Optional[V2Criteria] = None
    additional_information: Optional[str] = None
    config_code: Optional[str] = None
    motability_pricing_id: Optional[int] = None
    assistance_provider_id: Optional[int] = None
    assistance_detail: Optional[str] = None
    is_c_o_p_converter: bool = False
    configurator_code: Optional[str] = None
    is_one_admin_update: bool = False

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

PUT /v1/backorder/{Guid} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBackOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders">
  <AdditionalInformation>String</AdditionalInformation>
  <AgentCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:Version>0</d2p1:Version>
    <d2p1:BodyStyle xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:BodyStyle>
    <d2p1:ColourGroup xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:ColourGroup>
    <d2p1:CriteriaDifference>
      <d2p1:AdditionalInformation>false</d2p1:AdditionalInformation>
      <d2p1:BodyStyle>false</d2p1:BodyStyle>
      <d2p1:ColourGroup>false</d2p1:ColourGroup>
      <d2p1:Engine>false</d2p1:Engine>
      <d2p1:Equipment>false</d2p1:Equipment>
      <d2p1:Fuel>false</d2p1:Fuel>
      <d2p1:IsSmart>false</d2p1:IsSmart>
      <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
      <d2p1:Line>false</d2p1:Line>
      <d2p1:Model>false</d2p1:Model>
      <d2p1:Packages>false</d2p1:Packages>
      <d2p1:PreferredDeliveryDate>false</d2p1:PreferredDeliveryDate>
      <d2p1:Transmission>false</d2p1:Transmission>
      <d2p1:Upholstery>false</d2p1:Upholstery>
      <d2p1:UrlReferrer>false</d2p1:UrlReferrer>
    </d2p1:CriteriaDifference>
    <d2p1:Equipment xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Equipment>
    <d2p1:Fuel xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Fuel>
    <d2p1:IsNewModel>false</d2p1:IsNewModel>
    <d2p1:IsSmart>false</d2p1:IsSmart>
    <d2p1:IsSpecialised>false</d2p1:IsSpecialised>
    <d2p1:Line xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Line>
    <d2p1:Model>
      <d2p1:CriteriaModel>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:CriteriaModel>
    </d2p1:Model>
    <d2p1:Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Packages>
    <d2p1:PreferredDeliveryDate>String</d2p1:PreferredDeliveryDate>
    <d2p1:Transmission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Transmission>
    <d2p1:Upholstery xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Upholstery>
    <d2p1:UrlReferrer>String</d2p1:UrlReferrer>
    <d2p1:Engine>
      <d2p1:V2EngineCriteria>
        <d2p1:Badge>String</d2p1:Badge>
        <d2p1:Brand>String</d2p1:Brand>
      </d2p1:V2EngineCriteria>
    </d2p1:Engine>
  </AgentCriteria>
  <AssistanceDetail>String</AssistanceDetail>
  <AssistanceProviderId>0</AssistanceProviderId>
  <ConfigCode>String</ConfigCode>
  <ConfiguratorCode>String</ConfiguratorCode>
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <IsCOPConverter>false</IsCOPConverter>
  <IsOneAdminUpdate>false</IsOneAdminUpdate>
  <MotabilityPricingId>0</MotabilityPricingId>
</UpdateBackOrderRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateBackOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses" />