Mercedes.Agency.Orchestration.API

<back to all web services

VehicleSwapActiveRequest

VehicleSwapActive
Requires Authentication
The following routes are available for this service:
GET/v1/VehicleSwap/ActiveGet Active Vehicle Swap recordsThis endpoint calls the same named endpoint in the Agency API to return active Vehicle Swap records.
VehicleSwapActiveResponse Parameters:
NameParameterData TypeRequiredDescription
ActiveVehicleSwapsformList<VehicleSwapActive>Yes
VehicleSwapActive Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ReferenceformstringYes
OrderTypeformstringYes
VehicleSwapGuidformGuidNo
OrderGuidformGuidNo
ShowroomformstringNo
CommissionNumberformstringNo
RequestReasonformstringNo
SentToCesarformboolNo
CreationDateformDateTimeNo
MaintenanceDateformDateTime?No

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.

GET /v1/VehicleSwap/Active HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ActiveVehicleSwaps: 
	[
		{
			Id: 0,
			Reference: String,
			OrderType: String,
			VehicleSwapGuid: 00000000000000000000000000000000,
			OrderGuid: 00000000000000000000000000000000,
			Showroom: String,
			CommissionNumber: String,
			RequestReason: String,
			SentToCesar: False,
			CreationDate: 0001-01-01,
			MaintenanceDate: 0001-01-01
		}
	]
}