| 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 |
|---|
export class KeyInformation
{
public BM7NST?: string;
public ConfigurationDate?: string;
public ModelYear?: string;
public HalfYear?: string;
public constructor(init?: Partial<KeyInformation>) { (Object as any).assign(this, init); }
}
export class OrderingOptions
{
public Interior?: string[];
public Exterior?: string[];
public Other?: string[];
public constructor(init?: Partial<OrderingOptions>) { (Object as any).assign(this, init); }
}
export class CarConfiguratorResponse
{
public Name?: string;
public KeyInformation?: KeyInformation;
public OrderingOptions?: OrderingOptions;
public ResponseStatus: ResponseStatus;
public ConfiguratorCode?: string;
public constructor(init?: Partial<CarConfiguratorResponse>) { (Object as any).assign(this, init); }
}
export class CarConfiguratorRequest implements IPost
{
/** @description Configurator code */
// @ApiMember(Description="Configurator code", IsRequired=true)
public ConfiguratorCode: string;
public constructor(init?: Partial<CarConfiguratorRequest>) { (Object as any).assign(this, init); }
}
TypeScript CarConfiguratorRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ConfiguratorCode":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}