Mercedes.Agency.Orchestration.API

CreateOneAdminBackOrderRequest

BackOrder

The following routes are available for this service:
POST	/v1/oneAdmin/backorder	Creates a back order with vehicle criteria	Create Back Order (called from One Admin) It calls the v1/backorder in the Agency API, where the order is created The details of the back order are sent to OneAgent Validation checks are performed on the input request.

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.Orchestration.API.Clients.AgencyApi.Requests
Imports Mercedes.Agency.API.Shared.Enums
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 Address
            Public Overridable Property [Property] As String
            Public Overridable Property Street As String
            Public Overridable Property Town As String
            Public Overridable Property County As String
            Public Overridable Property Locality As String
            Public Overridable Property Postcode As String
        End Class

        Public Partial Class Criteria
            Inherits CriteriaBase
            Public Overridable Property Engine As String() = New String(){}
        End Class

        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 Customer
            Inherits SalesforceCustomer
            Public Overridable Property ProfileId As Guid?
            Public Overridable Property Preferences As Preferences
        End Class

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

        Public Partial Class OutrightPurchase
            Public Overridable Property IsOutrightPurchase As Boolean
            Public Overridable Property Reference As String
            Public Overridable Property DiscountRate As Decimal
            Public Overridable Property Bm7NST As String
            Public Overridable Property IsBackOrder As Boolean
            Public Overridable Property IsCOPConverter As Boolean
        End Class

        Public Partial Class Preferences
            Public Overridable Property OptinEmail As Boolean
            Public Overridable Property OptinPost As Boolean
            Public Overridable Property OptinSMS As Boolean
            Public Overridable Property OptinTelephone As Boolean
        End Class

        Public Partial Class SalesforceCustomer
            Implements ICustomer
            Public Overridable Property CustomerId As String Implements ICustomer.CustomerId
            Public Overridable Property IsCiam As Boolean Implements ICustomer.IsCiam
            Public Overridable Property CompanyName As String Implements ICustomer.CompanyName
            Public Overridable Property Title As String Implements ICustomer.Title
            Public Overridable Property Firstname As String Implements ICustomer.Firstname
            Public Overridable Property Surname As String Implements ICustomer.Surname
            Public Overridable Property EmailAddress As String Implements ICustomer.EmailAddress
            Public Overridable Property Telephone As String Implements ICustomer.Telephone
            Public Overridable Property Address As Address Implements ICustomer.Address
            Public Overridable Property Mode As CustomerMode Implements ICustomer.Mode
        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.Requests

        Public Partial Class CreateBackOrderBase
            Public Overridable Property GssnId As String
            Public Overridable Property AdditionalInformation As String
            Public Overridable Property ConfigCode As String
            Public Overridable Property Source As Source
            Public Overridable Property TagUrl As String
            Public Overridable Property Customer As Customer
            Public Overridable Property CustomerCriteria As Criteria
            Public Overridable Property AgentCriteria As V2Criteria
            Public Overridable Property OutrightPurchase As OutrightPurchase
            Public Overridable Property GasId As String
            Public Overridable Property Motability As Boolean
            Public Overridable Property MotabilityPricingId As Integer?
            Public Overridable Property AssistanceProviderId As Integer?
            Public Overridable Property AssistanceDetail As String
            Public Overridable Property ConfiguratorCode As String
        End Class
    End Namespace

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

        Public Partial Class CreateBackOrderResponse
            Public Overridable Property Guid As String
            Public Overridable Property Reference As String
        End Class
    End Namespace

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

        Public Partial Class CreateOneAdminBackOrderRequest
            Inherits CreateBackOrderBase
            Implements IPost
        End Class
    End Namespace
End Namespace

VB.NET CreateOneAdminBackOrderRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/oneAdmin/backorder HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GssnId":"String","AdditionalInformation":"String","ConfigCode":"String","Source":"OnlineShowroom","TagUrl":"String","Customer":{"ProfileId":"00000000000000000000000000000000","Preferences":{"OptinEmail":false,"OptinPost":false,"OptinSMS":false,"OptinTelephone":false},"CustomerId":"String","IsCiam":false,"CompanyName":"String","Title":"String","Firstname":"String","Surname":"String","EmailAddress":"String","Telephone":"String","Address":{"Property":"String","Street":"String","Town":"String","County":"String","Locality":"String","Postcode":"String"},"Mode":"Private"},"CustomerCriteria":{"Engine":["String"],"Transmission":["String"],"Fuel":["String"],"Upholstery":["String"],"Equipment":["String"],"Line":["String"],"BodyStyle":["String"],"ColourGroup":["String"],"Packages":["String"],"Model":[{"Description":"String","Id":0}],"UrlReferrer":"String","PreferredDeliveryDate":"String","IsNewModel":false,"IsSmart":false,"IsSpecialised":false,"CriteriaDifference":{"Model":false,"Transmission":false,"Fuel":false,"Upholstery":false,"Equipment":false,"Line":false,"BodyStyle":false,"ColourGroup":false,"Packages":false,"Engine":false,"AdditionalInformation":false,"UrlReferrer":false,"PreferredDeliveryDate":false,"IsSmart":false,"IsSpecialised":false},"Version":0},"AgentCriteria":{"Engine":[{"Badge":"String","Brand":"String"}],"Transmission":["String"],"Fuel":["String"],"Upholstery":["String"],"Equipment":["String"],"Line":["String"],"BodyStyle":["String"],"ColourGroup":["String"],"Packages":["String"],"Model":[{"Description":"String","Id":0}],"UrlReferrer":"String","PreferredDeliveryDate":"String","IsNewModel":false,"IsSmart":false,"IsSpecialised":false,"CriteriaDifference":{"Model":false,"Transmission":false,"Fuel":false,"Upholstery":false,"Equipment":false,"Line":false,"BodyStyle":false,"ColourGroup":false,"Packages":false,"Engine":false,"AdditionalInformation":false,"UrlReferrer":false,"PreferredDeliveryDate":false,"IsSmart":false,"IsSpecialised":false},"Version":0},"OutrightPurchase":{"IsOutrightPurchase":false,"Reference":"String","DiscountRate":0,"Bm7NST":"String","IsBackOrder":false,"IsCOPConverter":false},"GasId":"String","Motability":false,"MotabilityPricingId":0,"AssistanceProviderId":0,"AssistanceDetail":"String","ConfiguratorCode":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Guid":"String","Reference":"String"}