| PUT | /api/orderResponse/{OrderResponseId}/processed | Update OrderResponse as customer processed, will also acknowledge OrderResponse if not yet set. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.OrderResponse
Imports DX.Framework.Core.Commands.Dto
Namespace Global
Namespace DX.Framework.Core.Commands.Dto
Public Partial Class TokenDto
Implements ICommandResponse
Public Overridable Property Token As Guid
End Class
End Namespace
Namespace DX.STF.Application.ClientApi.Messages.OrderResponse
'''<Summary>
'''Order Response
'''</Summary>
<Api(Description:="Order Response")>
<ApiResponse(Description:="Command received", IsDefaultResponse:=true, ResponseType:=GetType(TokenDto), StatusCode:=202)>
Public Partial Class UpdateOrderResponseClientProcessed
'''<Summary>
'''OrderResponse ID or Token
'''</Summary>
<ApiMember(Description:="OrderResponse ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
Public Overridable Property OrderResponseId As Guid
'''<Summary>
'''Customer OrderResponse reference in destination system
'''</Summary>
<ApiMember(Description:="Customer OrderResponse reference in destination system")>
Public Overridable Property CustomerReference As String
'''<Summary>
'''Date and Time OrderResponse was processed in destination system
'''</Summary>
<ApiMember(Description:="Date and Time OrderResponse was processed in destination system")>
Public Overridable Property CustomerProcessedDate As Date
End Class
End Namespace
End Namespace
VB.NET UpdateOrderResponseClientProcessed 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/orderResponse/{OrderResponseId}/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
{
}