| 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 |
|---|
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 CarConfiguratorRequest = struct {
/// Configurator code
// @ApiMember(Description="Configurator code", IsRequired=true)
configurator_code: ?[]const u8 = null,
};
Zig CarConfiguratorRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"ConfiguratorCode":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}