Mercedes.Agency.Orchestration.API

<back to all web services

UpdateVehicleSwapRequest

VehicleSwap
Requires Authentication
The following routes are available for this service:
PUT/v1/VehicleSwapUpdates vehicle swap, order and back order recordsThis 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
namespace Mercedes.Agency.API.Shared.POCO

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type VehicleError() = 
        member val Field:String = null with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type UpdateVehicleSwapResponse() = 
        member val Errors:ResizeArray<VehicleError> = null with get,set

    [<AllowNullLiteral>]
    type UpdateVehicleSwapRequest() = 
        interface IPost
        member val VehicleSwapGuid:Guid = new Guid() with get,set
        member val OrderGuid:Guid = new Guid() with get,set
        member val BackOrderGuid:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val GssnId:String = null with get,set
        member val Agent:String = null with get,set
        member val ExistingVin:String = null with get,set
        member val SwapVin:String = null with get,set
        member val PersonalisedItemOfferIds:Int32[] = null with get,set

F# UpdateVehicleSwapRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	VehicleSwapGuid: 00000000000000000000000000000000,
	OrderGuid: 00000000000000000000000000000000,
	BackOrderGuid: 00000000000000000000000000000000,
	GssnId: String,
	Agent: String,
	ExistingVin: String,
	SwapVin: String,
	PersonalisedItemOfferIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Errors: 
	[
		{
			Field: String,
			Message: String
		}
	]
}