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
namespace Mercedes.Agency.API.Shared.POCO.CarConfigurator

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type KeyInformation() = 
        member val BM7NST:String = null with get,set
        member val ConfigurationDate:String = null with get,set
        member val ModelYear:String = null with get,set
        member val HalfYear:String = null with get,set

    [<AllowNullLiteral>]
    type OrderingOptions() = 
        member val Interior:ResizeArray<String> = null with get,set
        member val Exterior:ResizeArray<String> = null with get,set
        member val Other:ResizeArray<String> = null with get,set

    [<AllowNullLiteral>]
    type CarConfiguratorResponse() = 
        member val Name:String = null with get,set
        member val KeyInformation:KeyInformation = null with get,set
        member val OrderingOptions:OrderingOptions = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ConfiguratorCode:String = null with get,set

    [<AllowNullLiteral>]
    type CarConfiguratorRequest() = 
        interface IPost
        ///<summary>
        ///Configurator code
        ///</summary>
        [<ApiMember(Description="Configurator code", IsRequired=true)>]
        member val ConfiguratorCode:String = null with get,set

F# 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
}