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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders
Imports Mercedes.Agency.API.Shared.POCO
Imports Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses

Namespace Global

    Namespace Mercedes.Agency.API.Shared.POCO

        Public Partial Class CriteriaBase
            Inherits JsonVersion
            Public Overridable Property Transmission As String() = New String(){}
            Public Overridable Property Fuel As String() = New String(){}
            Public Overridable Property Upholstery As String() = New String(){}
            Public Overridable Property Equipment As String() = New String(){}
            Public Overridable Property Line As String() = New String(){}
            Public Overridable Property BodyStyle As String() = New String(){}
            Public Overridable Property ColourGroup As String() = New String(){}
            Public Overridable Property Packages As String() = New String(){}
            Public Overridable Property Model As List(Of CriteriaModel) = New List(Of CriteriaModel)
            Public Overridable Property UrlReferrer As String
            Public Overridable Property PreferredDeliveryDate As String
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsNewModel As Boolean

            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsSmart As Boolean

            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property IsSpecialised As Boolean

            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property CriteriaDifference As CriteriaDifference
        End Class

        Public Partial Class CriteriaDifference
            Public Overridable Property Model As Boolean
            Public Overridable Property Transmission As Boolean
            Public Overridable Property Fuel As Boolean
            Public Overridable Property Upholstery As Boolean
            Public Overridable Property Equipment As Boolean
            Public Overridable Property Line As Boolean
            Public Overridable Property BodyStyle As Boolean
            Public Overridable Property ColourGroup As Boolean
            Public Overridable Property Packages As Boolean
            Public Overridable Property Engine As Boolean
            Public Overridable Property AdditionalInformation As Boolean
            Public Overridable Property UrlReferrer As Boolean
            Public Overridable Property PreferredDeliveryDate As Boolean
            Public Overridable Property IsSmart As Boolean
            Public Overridable Property IsSpecialised As Boolean
        End Class

        Public Partial Class CriteriaModel
            Public Overridable Property Description As String
            Public Overridable Property Id As Integer
        End Class

        Public Partial Class JsonVersion
            Implements IJsonVersion
            Public Overridable Property Version As Integer Implements IJsonVersion.Version
        End Class

        Public Partial Class V2Criteria
            Inherits CriteriaBase
            Public Overridable Property Engine As List(Of V2EngineCriteria) = New List(Of V2EngineCriteria)
        End Class

        Public Partial Class V2EngineCriteria
            Public Overridable Property Badge As String
            Public Overridable Property Brand As String
        End Class
    End Namespace

    Namespace Mercedes.Agency.Orchestration.API.Clients.AgencyApi.Responses

        Public Partial Class UpdateBackOrderResponse
        End Class
    End Namespace

    Namespace Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders

        Public Partial Class UpdateBackOrderRequest
            Implements IPut
            Public Overridable Property Guid As Guid
            Public Overridable Property AgentCriteria As V2Criteria
            Public Overridable Property AdditionalInformation As String
            Public Overridable Property ConfigCode As String
            Public Overridable Property MotabilityPricingId As Integer?
            Public Overridable Property AssistanceProviderId As Integer?
            Public Overridable Property AssistanceDetail As String
            Public Overridable Property IsCOPConverter As Boolean
            Public Overridable Property ConfiguratorCode As String
            Public Overridable Property IsOneAdminUpdate As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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" />