Mercedes.Agency.Orchestration.API

<back to all web services

CarConfiguratorRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/configuratorValidate and save a car configurator code for a back orderThis 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
"use strict";
export class KeyInformation {
    /** @param {{BM7NST?:string,ConfigurationDate?:string,ModelYear?:string,HalfYear?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    BM7NST;
    /** @type {?string} */
    ConfigurationDate;
    /** @type {?string} */
    ModelYear;
    /** @type {?string} */
    HalfYear;
}
export class OrderingOptions {
    /** @param {{Interior?:string[],Exterior?:string[],Other?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string[]} */
    Interior;
    /** @type {?string[]} */
    Exterior;
    /** @type {?string[]} */
    Other;
}
export class CarConfiguratorResponse {
    /** @param {{Name?:string,KeyInformation?:KeyInformation,OrderingOptions?:OrderingOptions,ResponseStatus?:ResponseStatus,ConfiguratorCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    Name;
    /** @type {?KeyInformation} */
    KeyInformation;
    /** @type {?OrderingOptions} */
    OrderingOptions;
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {?string} */
    ConfiguratorCode;
}
export class CarConfiguratorRequest {
    /** @param {{ConfiguratorCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Configurator code */
    ConfiguratorCode;
}

JavaScript CarConfiguratorRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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">
  <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.Agency.API.Shared.POCO.CarConfigurator">
  <ConfiguratorCode>String</ConfiguratorCode>
  <KeyInformation>
    <BM7NST>String</BM7NST>
    <ConfigurationDate>String</ConfigurationDate>
    <HalfYear>String</HalfYear>
    <ModelYear>String</ModelYear>
  </KeyInformation>
  <Name>String</Name>
  <OrderingOptions>
    <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>
    <Other xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Other>
  </OrderingOptions>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CarConfiguratorResponse>