DX STF Client API

<back to all web services

UpdateOrderResponseClientProcessed

Order Response Requests

Order Response

Requires Authentication
The following routes are available for this service:
PUT/api/orderResponse/{OrderResponseId}/processedUpdate OrderResponse as customer processed, will also acknowledge OrderResponse if not yet set.
namespace DX.Framework.Core.Commands.Dto

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

    [<AllowNullLiteral>]
    type TokenDto() = 
        member val Token:Guid = new Guid() with get,set

    ///<summary>
    ///Order Response
    ///</summary>
    [<Api(Description="Order Response")>]
    [<ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof<TokenDto>, StatusCode=202)>]
    [<AllowNullLiteral>]
    type UpdateOrderResponseClientProcessed() = 
        ///<summary>
        ///OrderResponse ID or Token
        ///</summary>
        [<ApiMember(Description="OrderResponse ID or Token", ExcludeInSchema=true, ParameterType="path")>]
        member val OrderResponseId:Guid = new Guid() with get,set

        ///<summary>
        ///Customer OrderResponse reference in destination system
        ///</summary>
        [<ApiMember(Description="Customer OrderResponse reference in destination system")>]
        member val CustomerReference:String = null with get,set

        ///<summary>
        ///Date and Time OrderResponse was processed in destination system
        ///</summary>
        [<ApiMember(Description="Date and Time OrderResponse was processed in destination system")>]
        member val CustomerProcessedDate:DateTime = new DateTime() with get,set

F# UpdateOrderResponseClientProcessed DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}