Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkAllocationsRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkAllocations
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidateBackOrderBulkAllocationsRequest:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderAllocation:
    row: int = 0
    comm: Optional[str] = None
    back_order: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvalidBackOrderAllocation(BackOrderAllocation):
    validation_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderBulkAllocationVehicles:
    total_vehicles: int = 0
    valid_vehicles: int = 0
    warning_vehicles: int = 0
    invalid_vehicles: int = 0
    valid: List[BackOrderAllocation] = field(default_factory=list)
    warning: List[InvalidBackOrderAllocation] = field(default_factory=list)
    invalid: List[InvalidBackOrderAllocation] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderBulkAllocationResponse:
    message: Optional[str] = None
    vehicles: Optional[BackOrderBulkAllocationVehicles] = None
    successful: bool = False

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