DX STF Client API

UpdatePurchaseConditionClientProcessed

Purchase Conditions Requests

Purchase Conditions

The following routes are available for this service:
PUT	/api/purchaseCondition/{PurchaseConditionId}/processed	Update Purchase Condition as customer processed, will also acknowledge Purchase Condition 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.PurchaseCondition
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.PurchaseCondition

        '''<Summary>
        '''Purchase Conditions
        '''</Summary>
        <Api(Description:="Purchase Conditions")>
        <ApiResponse(Description:="Command received", IsDefaultResponse:=true, ResponseType:=GetType(TokenDto), StatusCode:=202)>
        Public Partial Class UpdatePurchaseConditionClientProcessed
            '''<Summary>
            '''PurchaseCondition ID or Token
            '''</Summary>
            <ApiMember(Description:="PurchaseCondition ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property PurchaseConditionId As Guid

            '''<Summary>
            '''Customer Purchase Condition reference in destination system
            '''</Summary>
            <ApiMember(Description:="Customer Purchase Condition reference in destination system")>
            Public Overridable Property CustomerReference As String

            '''<Summary>
            '''Date and Time Purchase Condition was processed in destination system
            '''</Summary>
            <ApiMember(Description:="Date and Time Purchase Condition was processed in destination system")>
            Public Overridable Property CustomerProcessedDate As Date
        End Class
    End Namespace
End Namespace

VB.NET 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

{}