Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkStatusAllocationsRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkStatusAllocationsValidates back order references and statuses provided in a csv file for allocation to active back orders.Reads a csv file and parses a list of back order references, MBUK assistance statuses and messages for validation before allocation to active back orders.
namespace Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation

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

    [<AllowNullLiteral>]
    type ValidateBackOrderBulkStatusAllocationsRequest() = 
        class end

    [<AllowNullLiteral>]
    type BackOrderStatusAllocation() = 
        member val Row:Int32 = new Int32() with get,set
        member val BackOrderReference:String = null with get,set
        member val Status:String = null with get,set
        member val Message:String = null with get,set

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

    [<AllowNullLiteral>]
    type BackOrderBulkStatusAllocation() = 
        member val TotalBackOrders:Int32 = new Int32() with get,set
        member val ValidBackOrders:Int32 = new Int32() with get,set
        member val InvalidBackOrders:Int32 = new Int32() with get,set
        member val Valid:ResizeArray<BackOrderStatusAllocation> = null with get,set
        member val Invalid:ResizeArray<InvalidBackOrderStatusAllocation> = null with get,set

    [<AllowNullLiteral>]
    type BackOrderBulkStatusAllocationsResponse() = 
        member val Message:String = null with get,set
        member val BackOrders:BackOrderBulkStatusAllocation = null with get,set
        member val Successful:Boolean = new Boolean() with get,set
        member val Filename:String = null with get,set

F# ValidateBackOrderBulkStatusAllocationsRequest 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/ValidateBulkStatusAllocations 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,
	BackOrders: 
	{
		TotalBackOrders: 2,
		ValidBackOrders: 1,
		InvalidBackOrders: 1,
		Valid: 
		[
			{
				Row: 0,
				BackOrderReference: String,
				Status: String,
				Message: String
			}
		],
		Invalid: 
		[
			{
				ValidationMessage: String,
				Row: 0,
				BackOrderReference: String,
				Status: String,
				Message: String
			}
		]
	},
	Successful: False,
	Filename: String
}