DX STF Client API

AcknowledgeReceivingAdvice

Receiving Advice Requests

Receiving Advice

The following routes are available for this service:
PUT	/api/receivingAdvice/{ReceivingAdviceId}/acknowledge	Acknowledge ReceivingAdvice as received

namespace DX.STF.Application.ClientApi.Messages.ReceivingAdvice

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

    ///<summary>
    ///Receiving Advice
    ///</summary>
    [<Api(Description="Receiving Advice")>]
    [<ApiResponse(Description="Updated", IsDefaultResponse=true, StatusCode=204)>]
    [<ApiResponse(Description="GLN does not have required access", StatusCode=403)>]
    [<ApiResponse(Description="Document not found", StatusCode=404)>]
    [<AllowNullLiteral>]
    type AcknowledgeReceivingAdvice() = 
        [<ApiMember(ExcludeInSchema=true, ParameterType="path")>]
        member val ReceivingAdviceId:Guid = new Guid() with get,set

F# AcknowledgeReceivingAdvice DTOs

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

HTTP + CSV

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

PUT /api/receivingAdvice/{ReceivingAdviceId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}