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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders;
using Mercedes.Agency.API.Shared.POCO.CarConfigurator;

namespace Mercedes.Agency.API.Shared.POCO.CarConfigurator
{
    public partial class CarConfiguratorResponse
    {
        public virtual string Name { get; set; }
        public virtual KeyInformation KeyInformation { get; set; }
        public virtual OrderingOptions OrderingOptions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string ConfiguratorCode { get; set; }
    }

    public partial class KeyInformation
    {
        public virtual string BM7NST { get; set; }
        public virtual string ConfigurationDate { get; set; }
        public virtual string ModelYear { get; set; }
        public virtual string HalfYear { get; set; }
    }

    public partial class OrderingOptions
    {
        public virtual List<string> Interior { get; set; }
        public virtual List<string> Exterior { get; set; }
        public virtual List<string> Other { get; set; }
    }

}

namespace Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders
{
    public partial class CarConfiguratorRequest
        : IPost
    {
        ///<summary>
        ///Configurator code
        ///</summary>
        [ApiMember(Description="Configurator code", IsRequired=true)]
        public virtual string ConfiguratorCode { get; set; }
    }

}

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