| POST | /v1/configurator | Validate and save a car configurator code for a back order | This 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 |
|---|
"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[],WheelOptions?:EquipmentCache[],TrimOptions?:EquipmentCache[],OptionCodes?:EquipmentCache[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string[]} */
Interior;
/** @type {?string[]} */
Exterior;
/** @type {?string[]} */
Options;
/** @type {EquipmentCache[]} */
WheelOptions = [];
/** @type {EquipmentCache[]} */
TrimOptions = [];
/** @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 CarConfiguratorRequest {
/** @param {{ConfiguratorCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Configurator code */
ConfiguratorCode;
}
JavaScript CarConfiguratorRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"ConfiguratorCode":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Name":"String","KeyInformation":{"BM7NST":"String","ConfigurationDate":"String","ModelYear":"String","HalfYear":"String"},"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"}],"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"}