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.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ValidateBackOrderBulkStatusAllocationsRequest
{
}

open class BackOrderBulkStatusAllocationsResponse
{
    open var Message:String? = null
    open var BackOrders:BackOrderBulkStatusAllocation? = null
    open var Successful:Boolean? = null
    open var Filename:String? = null
}

open class BackOrderBulkStatusAllocation
{
    open var TotalBackOrders:Int? = null
    open var ValidBackOrders:Int? = null
    open var InvalidBackOrders:Int? = null
    open var Valid:ArrayList<BackOrderStatusAllocation> = ArrayList<BackOrderStatusAllocation>()
    open var Invalid:ArrayList<InvalidBackOrderStatusAllocation> = ArrayList<InvalidBackOrderStatusAllocation>()
}

open class BackOrderStatusAllocation
{
    open var Row:Int? = null
    open var BackOrderReference:String? = null
    open var Status:String? = null
    open var Message:String? = null
}

open class InvalidBackOrderStatusAllocation : BackOrderStatusAllocation()
{
    open var ValidationMessage:String? = null
}

Kotlin 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
}