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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CarConfiguratorRequest : IPost
{
    /**
    * Configurator code
    */
    @ApiMember(Description="Configurator code", IsRequired=true)
    open var ConfiguratorCode:String? = null
}

open class CarConfiguratorResponse
{
    open var Name:String? = null
    open var KeyInformation:KeyInformation? = null
    open var OrderingOptions:OrderingOptions? = null
    open var ResponseStatus:ResponseStatus? = null
    open var ConfiguratorCode:String? = null
}

open class KeyInformation
{
    open var BM7NST:String? = null
    open var ConfigurationDate:String? = null
    open var ModelYear:String? = null
    open var HalfYear:String? = null
}

open class OrderingOptions
{
    open var Interior:ArrayList<String>? = null
    open var Exterior:ArrayList<String>? = null
    open var Other:ArrayList<String>? = null
}

Kotlin 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
}