Mercedes.Agency.Orchestration.API

<back to all web services

ValidateBackOrderBulkAllocationsRequest

Requires Authentication
The following routes are available for this service:
POST/v1/BackOrder/ValidateBulkAllocations
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders;
using Mercedes.Agency.Orchestration.API.Business.Poco;
using Mercedes.Agency.API.Shared.POCO;

namespace Mercedes.Agency.API.Shared.POCO
{
    public partial class BackOrderAllocation
    {
        public virtual int Row { get; set; }
        public virtual string Comm { get; set; }
        public virtual string BackOrder { get; set; }
    }

    public partial class InvalidBackOrderAllocation
        : BackOrderAllocation
    {
        public virtual string ValidationMessage { get; set; }
    }

}

namespace Mercedes.Agency.Orchestration.API.Business.Poco
{
    public partial class BackOrderBulkAllocationResponse
    {
        public virtual string Message { get; set; }
        public virtual BackOrderBulkAllocationVehicles Vehicles { get; set; }
        public virtual bool Successful { get; set; }
    }

    public partial class BackOrderBulkAllocationVehicles
    {
        public virtual int TotalVehicles { get; set; }
        public virtual int ValidVehicles { get; set; }
        public virtual int WarningVehicles { get; set; }
        public virtual int InvalidVehicles { get; set; }
        public virtual List<BackOrderAllocation> Valid { get; set; } = [];
        public virtual List<InvalidBackOrderAllocation> Warning { get; set; } = [];
        public virtual List<InvalidBackOrderAllocation> Invalid { get; set; } = [];
    }

}

namespace Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders
{
    public partial class ValidateBackOrderBulkAllocationsRequest
    {
    }

}

C# 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
}