Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkAllocationsRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkAllocations
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 ValidateBackOrderBulkAllocationsRequest() = 
        class end

    [<AllowNullLiteral>]
    type BackOrderAllocation() = 
        member val Row:Int32 = new Int32() with get,set
        member val Comm:String = null with get,set
        member val BackOrder:String = null with get,set

    [<AllowNullLiteral>]
    type InvalidBackOrderAllocation() = 
        inherit BackOrderAllocation()
        member val ValidationMessage:String = null with get,set

    [<AllowNullLiteral>]
    type BackOrderBulkAllocationVehicles() = 
        member val TotalVehicles:Int32 = new Int32() with get,set
        member val ValidVehicles:Int32 = new Int32() with get,set
        member val WarningVehicles:Int32 = new Int32() with get,set
        member val InvalidVehicles:Int32 = new Int32() with get,set
        member val Valid:ResizeArray<BackOrderAllocation> = null with get,set
        member val Warning:ResizeArray<InvalidBackOrderAllocation> = null with get,set
        member val Invalid:ResizeArray<InvalidBackOrderAllocation> = null with get,set

    [<AllowNullLiteral>]
    type BackOrderBulkAllocationResponse() = 
        member val Message:String = null with get,set
        member val Vehicles:BackOrderBulkAllocationVehicles = null with get,set
        member val Successful:Boolean = new Boolean() with get,set

F# ValidateBackOrderBulkAllocationsRequest 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/BackOrder/ValidateBulkAllocations HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Message: One or more errors in file,
	Vehicles: 
	{
		TotalVehicles: 3,
		ValidVehicles: 1,
		WarningVehicles: 1,
		InvalidVehicles: 1,
		Valid: 
		[
			{
				Row: 0,
				Comm: String,
				BackOrder: String
			}
		],
		Warning: 
		[
			{
				ValidationMessage: String,
				Row: 0,
				Comm: String,
				BackOrder: String
			}
		],
		Invalid: 
		[
			{
				ValidationMessage: String,
				Row: 0,
				Comm: String,
				BackOrder: String
			}
		]
	},
	Successful: False
}