Mercedes.Agency.Orchestration.API

<back to all web services

UpdateCarConfiguratorRequest

CarConfigurator
Requires Authentication
The following routes are available for this service:
PUT/v1/configuratorRemoves a back order from a car configuratorThis endpoint calls Agency API when a ConfigurationCode is removed from a back order.
const std = @import("std");

pub const KeyInformation = struct {
    b_m7_n_s_t: ?[]const u8 = null,
    configuration_date: ?[]const u8 = null,
    model_year: ?[]const u8 = null,
    half_year: ?[]const u8 = null,
    type_class: ?[]const u8 = null,
    is_private_van: bool = false,
};

pub const EquipmentCache = struct {
    code: ?[]const u8 = null,
    description: ?[]const u8 = null,
    standard_flag: ?[]const u8 = null,
    price: f64 = 0,
    category: ?[]const u8 = null,
    importance: ?[]const u8 = null,
};

pub const OrderingOptions = struct {
    interior: ?[][]const u8 = null,
    exterior: ?[][]const u8 = null,
    options: ?[][]const u8 = null,
    wheel_options: []EquipmentCache = &.{},
    trim_options: []EquipmentCache = &.{},
    equipment_option_codes: []EquipmentCache = &.{},
    option_codes: []EquipmentCache = &.{},
};

pub const ResponseStatus = struct {
    error_code: ?[]const u8 = null,
    message: ?[]const u8 = null,
};

pub const CarConfiguratorResponse = struct {
    name: ?[]const u8 = null,
    key_information: ?KeyInformation = null,
    ordering_options: ?OrderingOptions = null,
    response_status: ?ResponseStatus = null,
    configurator_code: ?[]const u8 = null,
};

pub const UpdateCarConfiguratorRequest = struct {
    /// Configurator code
    // @ApiMember(Description="Configurator code", IsRequired=true)
    configurator_code: ?[]const u8 = null,

    /// BackOrder Guid
    // @ApiMember(Description="BackOrder Guid")
    guid: ?[]const u8 = null,

    /// GasId of the user making the request
    // @ApiMember(Description="GasId of the user making the request")
    gas_id: ?[]const u8 = null,
};

Zig UpdateCarConfiguratorRequest 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.

PUT /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,
	Guid: 00000000000000000000000000000000,
	GasId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	KeyInformation: 
	{
		BM7NST: String,
		ConfigurationDate: String,
		ModelYear: String,
		HalfYear: String,
		TypeClass: String,
		IsPrivateVan: False
	},
	OrderingOptions: 
	{
		Interior: 
		[
			String
		],
		Exterior: 
		[
			String
		],
		Options: 
		[
			String
		],
		WheelOptions: 
		[
			{
				Code: String,
				Description: String,
				StandardFlag: String,
				Price: 0,
				Category: String,
				Importance: String
			}
		],
		TrimOptions: 
		[
			{
				Code: String,
				Description: String,
				StandardFlag: String,
				Price: 0,
				Category: String,
				Importance: String
			}
		],
		EquipmentOptionCodes: 
		[
			{
				Code: String,
				Description: String,
				StandardFlag: String,
				Price: 0,
				Category: String,
				Importance: String
			}
		],
		OptionCodes: 
		[
			{
				Code: String,
				Description: String,
				StandardFlag: String,
				Price: 0,
				Category: String,
				Importance: String
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String
	},
	ConfiguratorCode: String
}