| PUT | /api/order/{OrderId}/processed | Update order as customer processed, will also acknowledge order if not yet set. |
|---|
import Foundation
import ServiceStack
/**
* Order
*/
// @Api(Description="Order")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(TokenDto), StatusCode=202)
public class UpdateOrderClientProcessed : Codable
{
/**
* Order ID or Token
*/
// @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
public var orderId:String
/**
* Customer order reference in destination system
*/
// @ApiMember(Description="Customer order reference in destination system")
public var customerReference:String
/**
* Date and Time order was processed in destination system
*/
// @ApiMember(Description="Date and Time order was processed in destination system")
public var customerProcessedDate:Date
required public init(){}
}
public class TokenDto : ICommandResponse, Codable
{
public var token:String
required public init(){}
}
Swift UpdateOrderClientProcessed 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.
PUT /api/order/{OrderId}/processed HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customerReference: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}