DX STF Client API

UpdateReceivingAdviceClientProcessed

Receiving Advice Requests

Receiving Advice

The following routes are available for this service:
PUT	/api/receivingAdvice/{ReceivingAdviceId}/processed	Update ReceivingAdvice as customer processed, will also acknowledge ReceivingAdvice 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.ReceivingAdvice
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.ReceivingAdvice

        '''<Summary>
        '''Receiving Advice
        '''</Summary>
        <Api(Description:="Receiving Advice")>
        <ApiResponse(Description:="Command received", IsDefaultResponse:=true, ResponseType:=GetType(TokenDto), StatusCode:=202)>
        Public Partial Class UpdateReceivingAdviceClientProcessed
            '''<Summary>
            '''ReceivingAdvice ID or Token
            '''</Summary>
            <ApiMember(Description:="ReceivingAdvice ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property ReceivingAdviceId As Guid

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

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

VB.NET UpdateReceivingAdviceClientProcessed 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/receivingAdvice/{ReceivingAdviceId}/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

{}