Mercedes.Agency.Orchestration.API

<back to all web services

GetVehicleBackOrderValidateRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/vehicle/backordervalidate/{VehicleIdentifier}Validate Vehicle assignment to BackOrderValidate Vehicle assignment to BackOrder by Vin or Commission Number
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


class GetVehicleBackOrderValidateResponse
    include ServiceStack::DTO

    # @return [String]
    attr_accessor :commission_number
    # @return [String]
    attr_accessor :vin
    # @return [TrueClass]
    attr_accessor :is_display_stock
    # @return [TrueClass]
    attr_accessor :specialist
    # @return [String]
    attr_accessor :display_retailer
    # @return [TrueClass]
    attr_accessor :is_valid
    # @return [String]
    attr_accessor :error_message
    # @return [TrueClass]
    attr_accessor :not_motability

    def self.properties
        {
            commission_number: { name: 'commissionNumber' },
            vin: { name: 'vin' },
            is_display_stock: { name: 'isDisplayStock' },
            specialist: { name: 'specialist' },
            display_retailer: { name: 'displayRetailer' },
            is_valid: { name: 'isValid' },
            error_message: { name: 'errorMessage' },
            not_motability: { name: 'notMotability' },
        }
    end

end

class GetVehicleBackOrderValidateRequest
    include ServiceStack::DTO

    # @return [String]
    attr_accessor :vehicle_identifier
    # @return [String]
    attr_accessor :back_order_guid

    def self.properties
        {
            vehicle_identifier: { name: 'vehicleIdentifier' },
            back_order_guid: { name: 'backOrderGuid' },
        }
    end

    def response_type() = GetVehicleBackOrderValidateResponse
    def get_type_name() = 'GetVehicleBackOrderValidateRequest'
end

Ruby GetVehicleBackOrderValidateRequest 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.

POST /v1/vehicle/backordervalidate/{VehicleIdentifier} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	VehicleIdentifier: String,
	BackOrderGuid: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CommissionNumber: String,
	Vin: String,
	IsDisplayStock: False,
	Specialist: False,
	DisplayRetailer: String,
	IsValid: False,
	ErrorMessage: String,
	NotMotability: False
}