Mercedes.Agency.Orchestration.API

ValidateBackOrderBulkAllocationsRequest

The following routes are available for this service:
POST	/v1/BackOrder/ValidateBulkAllocations

import Foundation
import ServiceStack

public class ValidateBackOrderBulkAllocationsRequest : Codable
{
    required public init(){}
}

public class BackOrderBulkAllocationResponse : Codable
{
    public var message:String
    public var vehicles:BackOrderBulkAllocationVehicles
    public var successful:Bool

    required public init(){}
}

public class BackOrderBulkAllocationVehicles : Codable
{
    public var totalVehicles:Int
    public var validVehicles:Int
    public var warningVehicles:Int
    public var invalidVehicles:Int
    public var valid:[BackOrderAllocation] = []
    public var warning:[InvalidBackOrderAllocation] = []
    public var invalid:[InvalidBackOrderAllocation] = []

    required public init(){}
}

public class BackOrderAllocation : Codable
{
    public var row:Int
    public var comm:String
    public var backOrder:String

    required public init(){}
}

public class InvalidBackOrderAllocation : BackOrderAllocation
{
    public var validationMessage:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case validationMessage
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        validationMessage = try container.decodeIfPresent(String.self, forKey: .validationMessage)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if validationMessage != nil { try container.encode(validationMessage, forKey: .validationMessage) }
    }
}

Swift ValidateBackOrderBulkAllocationsRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: text/csv
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}