Mercedes.Agency.Orchestration.API

<back to all web services

CarConfiguratorRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/configuratorValidate and save a car configurator code for a back orderThis endpoint calls Agency API to validate and save a car configurator code for a back order. The code is validated and saved in the database and returns a response from a third party CCS which provides car configuration details. These get saved to open search and returned to the front-end
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.CarConfigurator

Namespace Global

    Namespace Mercedes.Agency.API.Shared.POCO.CarConfigurator

        Public Partial Class CarConfiguratorResponse
            Public Overridable Property Name As String
            Public Overridable Property KeyInformation As KeyInformation
            Public Overridable Property OrderingOptions As OrderingOptions
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ConfiguratorCode As String
        End Class

        Public Partial Class KeyInformation
            Public Overridable Property BM7NST As String
            Public Overridable Property ConfigurationDate As String
            Public Overridable Property ModelYear As String
            Public Overridable Property HalfYear As String
        End Class

        Public Partial Class OrderingOptions
            Public Overridable Property Interior As List(Of String)
            Public Overridable Property Exterior As List(Of String)
            Public Overridable Property Other As List(Of String)
        End Class
    End Namespace

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

        Public Partial Class CarConfiguratorRequest
            Implements IPost
            '''<Summary>
            '''Configurator code
            '''</Summary>
            <ApiMember(Description:="Configurator code", IsRequired:=true)>
            Public Overridable Property ConfiguratorCode As String
        End Class
    End Namespace
End Namespace

VB.NET CarConfiguratorRequest DTOs

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

HTTP + JSV

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

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

{
	ConfiguratorCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	KeyInformation: 
	{
		BM7NST: String,
		ConfigurationDate: String,
		ModelYear: String,
		HalfYear: String
	},
	OrderingOptions: 
	{
		Interior: 
		[
			String
		],
		Exterior: 
		[
			String
		],
		Other: 
		[
			String
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ConfiguratorCode: String
}