DX STF Client API

<back to all web services

UpdatePurchaseConditionClientProcessed

Purchase Conditions Requests

Purchase Conditions

Requires Authentication
The following routes are available for this service:
PUT/api/purchaseCondition/{PurchaseConditionId}/processedUpdate Purchase Condition as customer processed, will also acknowledge Purchase Condition 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>
    ///Purchase Conditions
    ///</summary>
    [<Api(Description="Purchase Conditions")>]
    [<ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof<TokenDto>, StatusCode=202)>]
    [<AllowNullLiteral>]
    type UpdatePurchaseConditionClientProcessed() = 
        ///<summary>
        ///PurchaseCondition ID or Token
        ///</summary>
        [<ApiMember(Description="PurchaseCondition ID or Token", ExcludeInSchema=true, ParameterType="path")>]
        member val PurchaseConditionId:Guid = new Guid() with get,set

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

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

F# UpdatePurchaseConditionClientProcessed DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/purchaseCondition/{PurchaseConditionId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{}