| POST | /v1/BackOrder/ValidateBulkStatusAllocations | Validates 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. |
|---|
import Foundation
import ServiceStack
public class ValidateBackOrderBulkStatusAllocationsRequest : Codable
{
required public init(){}
}
public class BackOrderBulkStatusAllocationsResponse : Codable
{
public var message:String
public var backOrders:BackOrderBulkStatusAllocation
public var successful:Bool
public var filename:String
required public init(){}
}
public class BackOrderBulkStatusAllocation : Codable
{
public var totalBackOrders:Int
public var validBackOrders:Int
public var invalidBackOrders:Int
public var valid:[BackOrderStatusAllocation] = []
public var invalid:[InvalidBackOrderStatusAllocation] = []
required public init(){}
}
public class BackOrderStatusAllocation : Codable
{
public var row:Int
public var backOrderReference:String
public var status:String
public var message:String
required public init(){}
}
public class InvalidBackOrderStatusAllocation : BackOrderStatusAllocation
{
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 ValidateBackOrderBulkStatusAllocationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: 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,
BackOrders:
{
TotalBackOrders: 2,
ValidBackOrders: 1,
InvalidBackOrders: 1,
Valid:
[
{
Row: 0,
BackOrderReference: String,
Status: String,
Message: String
}
],
Invalid:
[
{
ValidationMessage: String,
Row: 0,
BackOrderReference: String,
Status: String,
Message: String
}
]
},
Successful: False,
Filename: String
}