Mercedes.Agency.Orchestration.API

<back to all web services

GetVehicleBackOrderValidateRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/vehicle/backordervalidate/{VehicleIdentifier}Validate Vehicle assignment to BackOrder by Vin or Commission Number
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 GetVehicleBackOrderValidateResponse:
    commission_number: Optional[str] = None
    vin: Optional[str] = None
    is_display_stock: bool = False
    specialist: bool = False
    display_retailer: Optional[str] = None
    is_valid: bool = False
    error_message: Optional[str] = None
    not_motability: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVehicleBackOrderValidateRequest(IPost):
    vehicle_identifier: Optional[str] = None
    back_order_guid: Optional[str] = None

Python GetVehicleBackOrderValidateRequest 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/vehicle/backordervalidate/{VehicleIdentifier} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetVehicleBackOrderValidateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <BackOrderGuid>00000000-0000-0000-0000-000000000000</BackOrderGuid>
  <VehicleIdentifier>String</VehicleIdentifier>
</GetVehicleBackOrderValidateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetVehicleBackOrderValidateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <CommissionNumber>String</CommissionNumber>
  <DisplayRetailer>String</DisplayRetailer>
  <ErrorMessage>String</ErrorMessage>
  <IsDisplayStock>false</IsDisplayStock>
  <IsValid>false</IsValid>
  <NotMotability>false</NotMotability>
  <Specialist>false</Specialist>
  <Vin>String</Vin>
</GetVehicleBackOrderValidateResponse>