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.
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.BulkStatusAllocation;
using Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation;

namespace Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation
{
    public partial class BackOrderStatusAllocation
    {
        public virtual int Row { get; set; }
        public virtual string BackOrderReference { get; set; }
        public virtual string Status { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class InvalidBackOrderStatusAllocation
        : BackOrderStatusAllocation
    {
        public virtual string ValidationMessage { get; set; }
    }

}

namespace Mercedes.Agency.Orchestration.API.Business.Poco.BulkStatusAllocation
{
    public partial class BackOrderBulkStatusAllocation
    {
        public virtual int TotalBackOrders { get; set; }
        public virtual int ValidBackOrders { get; set; }
        public virtual int InvalidBackOrders { get; set; }
        public virtual List<BackOrderStatusAllocation> Valid { get; set; } = [];
        public virtual List<InvalidBackOrderStatusAllocation> Invalid { get; set; } = [];
    }

    public partial class BackOrderBulkStatusAllocationsResponse
    {
        public virtual string Message { get; set; }
        public virtual BackOrderBulkStatusAllocation BackOrders { get; set; }
        public virtual bool Successful { get; set; }
        public virtual string Filename { get; set; }
    }

}

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

}

C# ValidateBackOrderBulkStatusAllocationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ValidateBackOrderBulkStatusAllocationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BackOrderBulkStatusAllocationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Business.Poco.BulkStatusAllocation">
  <BackOrders>
    <Invalid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation">
      <d3p1:InvalidBackOrderStatusAllocation>
        <d3p1:BackOrderReference>String</d3p1:BackOrderReference>
        <d3p1:Message>String</d3p1:Message>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:Status>String</d3p1:Status>
        <d3p1:ValidationMessage>String</d3p1:ValidationMessage>
      </d3p1:InvalidBackOrderStatusAllocation>
    </Invalid>
    <Valid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO.BulkStatusAllocation">
      <d3p1:BackOrderStatusAllocation>
        <d3p1:BackOrderReference>String</d3p1:BackOrderReference>
        <d3p1:Message>String</d3p1:Message>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:Status>String</d3p1:Status>
      </d3p1:BackOrderStatusAllocation>
    </Valid>
  </BackOrders>
  <Filename>String</Filename>
</BackOrderBulkStatusAllocationsResponse>