Mercedes.Agency.Orchestration.API

ValidateBackOrderBulkAllocationsRequest

BackOrder

The following routes are available for this service:
POST	/v1/BackOrder/ValidateBulkAllocations	Validates commission numbers allocated to back order reference numbers provided in a csv file.	Reads a csv file and parses a list of commission numbers and their allocated back order reference numbers then calls Vehicle Data API to validate the vehicles.

namespace Mercedes.Agency.API.Shared.POCO

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ValidateBackOrderBulkAllocationsRequest() = 
        class end

    [<AllowNullLiteral>]
    type BackOrderAllocation() = 
        member val Row:Int32 = new Int32() with get,set
        member val Comm:String = null with get,set
        member val BackOrder:String = null with get,set

    [<AllowNullLiteral>]
    type InvalidBackOrderAllocation() = 
        inherit BackOrderAllocation()
        member val ValidationMessage:String = null with get,set

    [<AllowNullLiteral>]
    type BackOrderBulkAllocationVehicles() = 
        member val TotalVehicles:Int32 = new Int32() with get,set
        member val ValidVehicles:Int32 = new Int32() with get,set
        member val WarningVehicles:Int32 = new Int32() with get,set
        member val InvalidVehicles:Int32 = new Int32() with get,set
        member val Valid:ResizeArray<BackOrderAllocation> = null with get,set
        member val Warning:ResizeArray<InvalidBackOrderAllocation> = null with get,set
        member val Invalid:ResizeArray<InvalidBackOrderAllocation> = null with get,set

    [<AllowNullLiteral>]
    type BackOrderBulkAllocationResponse() = 
        member val Message:String = null with get,set
        member val Vehicles:BackOrderBulkAllocationVehicles = null with get,set
        member val Successful:Boolean = new Boolean() with get,set

F# ValidateBackOrderBulkAllocationsRequest 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/ValidateBulkAllocations HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ValidateBackOrderBulkAllocationsRequest 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

<BackOrderBulkAllocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.Business.Poco">
  <Successful>false</Successful>
  <Vehicles>
    <Invalid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
      <d3p1:InvalidBackOrderAllocation>
        <d3p1:BackOrder>String</d3p1:BackOrder>
        <d3p1:Comm>String</d3p1:Comm>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:ValidationMessage>String</d3p1:ValidationMessage>
      </d3p1:InvalidBackOrderAllocation>
    </Invalid>
    <Valid xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
      <d3p1:BackOrderAllocation>
        <d3p1:BackOrder>String</d3p1:BackOrder>
        <d3p1:Comm>String</d3p1:Comm>
        <d3p1:Row>0</d3p1:Row>
      </d3p1:BackOrderAllocation>
    </Valid>
    <Warning xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
      <d3p1:InvalidBackOrderAllocation>
        <d3p1:BackOrder>String</d3p1:BackOrder>
        <d3p1:Comm>String</d3p1:Comm>
        <d3p1:Row>0</d3p1:Row>
        <d3p1:ValidationMessage>String</d3p1:ValidationMessage>
      </d3p1:InvalidBackOrderAllocation>
    </Warning>
  </Vehicles>
</BackOrderBulkAllocationResponse>