| 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 |
|---|
import Foundation
import ServiceStack
public class CarConfiguratorRequest : IPost, Codable
{
/**
* Configurator code
*/
// @ApiMember(Description="Configurator code", IsRequired=true)
public var configuratorCode:String
required public init(){}
}
public class CarConfiguratorResponse : Codable
{
public var name:String
public var keyInformation:KeyInformation
public var orderingOptions:OrderingOptions
public var responseStatus:ResponseStatus
public var configuratorCode:String
required public init(){}
}
public class KeyInformation : Codable
{
public var bM7NST:String
public var configurationDate:String
public var modelYear:String
public var halfYear:String
required public init(){}
}
public class OrderingOptions : Codable
{
public var interior:[String]
public var exterior:[String]
public var options:[String]
required public init(){}
}
Swift CarConfiguratorRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
ConfiguratorCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Name: String,
KeyInformation:
{
BM7NST: String,
ConfigurationDate: String,
ModelYear: String,
HalfYear: String
},
OrderingOptions:
{
Interior:
[
String
],
Exterior:
[
String
],
Options:
[
String
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ConfiguratorCode: String
}