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.
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders
Imports Mercedes.Agency.Orchestration.API.Business.Poco.BulkStatusAllocation
Imports Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation

Namespace Global

    Namespace Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation

        Public Partial Class BackOrderStatusAllocation
            Public Overridable Property Row As Integer
            Public Overridable Property BackOrderReference As String
            Public Overridable Property Status As String
            Public Overridable Property Message As String
        End Class

        Public Partial Class InvalidBackOrderStatusAllocation
            Inherits BackOrderStatusAllocation
            Public Overridable Property ValidationMessage As String
        End Class
    End Namespace

    Namespace Mercedes.Agency.Orchestration.API.Business.Poco.BulkStatusAllocation

        Public Partial Class BackOrderBulkStatusAllocation
            Public Overridable Property TotalBackOrders As Integer
            Public Overridable Property ValidBackOrders As Integer
            Public Overridable Property InvalidBackOrders As Integer
            Public Overridable Property Valid As List(Of BackOrderStatusAllocation) = New List(Of BackOrderStatusAllocation)
            Public Overridable Property Invalid As List(Of InvalidBackOrderStatusAllocation) = New List(Of InvalidBackOrderStatusAllocation)
        End Class

        Public Partial Class BackOrderBulkStatusAllocationsResponse
            Public Overridable Property Message As String
            Public Overridable Property BackOrders As BackOrderBulkStatusAllocation
            Public Overridable Property Successful As Boolean
            Public Overridable Property Filename As String
        End Class
    End Namespace

    Namespace Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders

        Public Partial Class ValidateBackOrderBulkStatusAllocationsRequest
        End Class
    End Namespace
End Namespace

VB.NET 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
}