| PUT | /v1/configurator | Removes a back order from a car configurator | This endpoint calls Agency API when a ConfigurationCode is removed from a back order. |
|---|
"use strict";
export class KeyInformation {
/** @param {{BM7NST?:string,ConfigurationDate?:string,ModelYear?:string,HalfYear?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
BM7NST;
/** @type {?string} */
ConfigurationDate;
/** @type {?string} */
ModelYear;
/** @type {?string} */
HalfYear;
}
export class EquipmentCache {
/** @param {{Code?:string,Description?:string,StandardFlag?:string,Price?:number,Category?:string,Importance?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Description;
/** @type {string} */
StandardFlag;
/** @type {number} */
Price;
/** @type {string} */
Category;
/** @type {string} */
Importance;
}
export class OrderingOptions {
/** @param {{Interior?:string[],Exterior?:string[],Options?:string[],OptionCodes?:EquipmentCache[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string[]} */
Interior;
/** @type {?string[]} */
Exterior;
/** @type {?string[]} */
Options;
/** @type {?EquipmentCache[]} */
OptionCodes;
}
export class CarConfiguratorResponse {
/** @param {{Name?:string,KeyInformation?:KeyInformation,OrderingOptions?:OrderingOptions,ResponseStatus?:ResponseStatus,ConfiguratorCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
Name;
/** @type {?KeyInformation} */
KeyInformation;
/** @type {?OrderingOptions} */
OrderingOptions;
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {?string} */
ConfiguratorCode;
}
export class UpdateCarConfiguratorRequest {
/** @param {{ConfiguratorCode?:string,Guid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Configurator code */
ConfiguratorCode;
/**
* @type {?string}
* @description BackOrder Guid */
Guid;
}
JavaScript UpdateCarConfiguratorRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
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
],
Options:
[
String
],
OptionCodes:
[
{
Code: String,
Description: String,
StandardFlag: String,
Price: 0,
Category: String,
Importance: String
}
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ConfiguratorCode: String
}