Mercedes.Agency.Orchestration.API

UpdateVehicleSwapRequest

VehicleSwap

The following routes are available for this service:
PUT	/v1/VehicleSwap	Updates vehicle swap, order and back order records	This endpoint validates a swap vehicle and then calls an endpoint in the Agency API to update vehicle swap, order and back order and sends a message to OneAgent with the updated order vehicle and offers

"use strict";
export class VehicleError {
    /** @param {{Field?:string,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Field;
    /** @type {string} */
    Message;
}
export class UpdateVehicleSwapResponse {
    /** @param {{Errors?:VehicleError[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?VehicleError[]} */
    Errors;
}
export class UpdateVehicleSwapRequest {
    /** @param {{VehicleSwapGuid?:string,OrderGuid?:string,BackOrderGuid?:string,GssnId?:string,Agent?:string,ExistingVin?:string,SwapVin?:string,PersonalisedItemOfferIds?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    VehicleSwapGuid;
    /** @type {string} */
    OrderGuid;
    /** @type {?string} */
    BackOrderGuid;
    /** @type {string} */
    GssnId;
    /** @type {string} */
    Agent;
    /** @type {string} */
    ExistingVin;
    /** @type {string} */
    SwapVin;
    /** @type {?number[]} */
    PersonalisedItemOfferIds;
}

JavaScript UpdateVehicleSwapRequest 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.

PUT /v1/VehicleSwap HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateVehicleSwapRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.VehicleSwap">
  <Agent>String</Agent>
  <BackOrderGuid>00000000-0000-0000-0000-000000000000</BackOrderGuid>
  <ExistingVin>String</ExistingVin>
  <GssnId>String</GssnId>
  <OrderGuid>00000000-0000-0000-0000-000000000000</OrderGuid>
  <PersonalisedItemOfferIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PersonalisedItemOfferIds>
  <SwapVin>String</SwapVin>
  <VehicleSwapGuid>00000000-0000-0000-0000-000000000000</VehicleSwapGuid>
</UpdateVehicleSwapRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateVehicleSwapResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <Errors>
    <VehicleError>
      <Field>String</Field>
      <Message>String</Message>
    </VehicleError>
  </Errors>
</UpdateVehicleSwapResponse>