| PUT | /api/receivingAdvice/{ReceivingAdviceId}/processed | Update ReceivingAdvice as customer processed, will also acknowledge ReceivingAdvice 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>
///Receiving Advice
///</summary>
[<Api(Description="Receiving Advice")>]
[<ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof<TokenDto>, StatusCode=202)>]
[<AllowNullLiteral>]
type UpdateReceivingAdviceClientProcessed() =
///<summary>
///ReceivingAdvice ID or Token
///</summary>
[<ApiMember(Description="ReceivingAdvice ID or Token", ExcludeInSchema=true, ParameterType="path")>]
member val ReceivingAdviceId:Guid = new Guid() with get,set
///<summary>
///Customer ReceivingAdvice reference in destination system
///</summary>
[<ApiMember(Description="Customer ReceivingAdvice reference in destination system")>]
member val CustomerReference:String = null with get,set
///<summary>
///Date and Time ReceivingAdvice was processed in destination system
///</summary>
[<ApiMember(Description="Date and Time ReceivingAdvice was processed in destination system")>]
member val CustomerProcessedDate:DateTime = new DateTime() with get,set
F# UpdateReceivingAdviceClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{}