| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CarConfiguratorRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders.CarConfigurator">
<ConfiguratorCode>String</ConfiguratorCode>
</CarConfiguratorRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CarConfiguratorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO.CarConfiguratorCodes">
<ConfiguratorCode>String</ConfiguratorCode>
<KeyInformation>
<BM7NST>String</BM7NST>
<ConfigurationDate>String</ConfigurationDate>
<HalfYear>String</HalfYear>
<IsPrivateVan>false</IsPrivateVan>
<ModelYear>String</ModelYear>
<TypeClass>String</TypeClass>
</KeyInformation>
<Name>String</Name>
<OrderingOptions>
<EquipmentOptionCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
<d3p1:EquipmentCache>
<d3p1:Category>String</d3p1:Category>
<d3p1:Code>String</d3p1:Code>
<d3p1:Description>String</d3p1:Description>
<d3p1:Importance>String</d3p1:Importance>
<d3p1:Price>0</d3p1:Price>
<d3p1:StandardFlag>String</d3p1:StandardFlag>
</d3p1:EquipmentCache>
</EquipmentOptionCodes>
<Exterior xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Exterior>
<Interior xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Interior>
<OptionCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
<d3p1:EquipmentCache>
<d3p1:Category>String</d3p1:Category>
<d3p1:Code>String</d3p1:Code>
<d3p1:Description>String</d3p1:Description>
<d3p1:Importance>String</d3p1:Importance>
<d3p1:Price>0</d3p1:Price>
<d3p1:StandardFlag>String</d3p1:StandardFlag>
</d3p1:EquipmentCache>
</OptionCodes>
<Options xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Options>
<TrimOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
<d3p1:EquipmentCache>
<d3p1:Category>String</d3p1:Category>
<d3p1:Code>String</d3p1:Code>
<d3p1:Description>String</d3p1:Description>
<d3p1:Importance>String</d3p1:Importance>
<d3p1:Price>0</d3p1:Price>
<d3p1:StandardFlag>String</d3p1:StandardFlag>
</d3p1:EquipmentCache>
</TrimOptions>
<WheelOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
<d3p1:EquipmentCache>
<d3p1:Category>String</d3p1:Category>
<d3p1:Code>String</d3p1:Code>
<d3p1:Description>String</d3p1:Description>
<d3p1:Importance>String</d3p1:Importance>
<d3p1:Price>0</d3p1:Price>
<d3p1:StandardFlag>String</d3p1:StandardFlag>
</d3p1:EquipmentCache>
</WheelOptions>
</OrderingOptions>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
</ResponseStatus>
</CarConfiguratorResponse>