| 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 |
|---|
package dtos
type KeyInformation struct {
BM7NST *string `json:"bM7NST,omitempty"`
ConfigurationDate *string `json:"configurationDate,omitempty"`
ModelYear *string `json:"modelYear,omitempty"`
HalfYear *string `json:"halfYear,omitempty"`
TypeClass *string `json:"typeClass,omitempty"`
IsPrivateVan bool `json:"isPrivateVan,omitempty"`
}
type EquipmentCache struct {
Code string `json:"code"`
Description string `json:"description"`
StandardFlag string `json:"standardFlag"`
Price float64 `json:"price,omitempty"`
Category string `json:"category"`
Importance string `json:"importance"`
}
type OrderingOptions struct {
Interior []string `json:"interior,omitempty"`
Exterior []string `json:"exterior,omitempty"`
Options []string `json:"options,omitempty"`
WheelOptions []EquipmentCache `json:"wheelOptions"`
TrimOptions []EquipmentCache `json:"trimOptions"`
EquipmentOptionCodes []EquipmentCache `json:"equipmentOptionCodes"`
OptionCodes []EquipmentCache `json:"optionCodes"`
}
type ResponseStatus struct {
ErrorCode string `json:"errorCode"`
Message *string `json:"message,omitempty"`
}
type CarConfiguratorResponse struct {
Name *string `json:"name,omitempty"`
KeyInformation *KeyInformation `json:"keyInformation,omitempty"`
OrderingOptions *OrderingOptions `json:"orderingOptions,omitempty"`
ResponseStatus ResponseStatus `json:"responseStatus"`
ConfiguratorCode *string `json:"configuratorCode,omitempty"`
}
type CarConfiguratorRequest struct {
/** @description Configurator code */
// @ApiMember(Description="Configurator code", IsRequired=true)
ConfiguratorCode string `json:"configuratorCode"`
}
Go 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"}