DX STF Client API

<back to all web services

AcknowledgeSettlement

Settlement Requests

Settlement

Requires Authentication
The following routes are available for this service:
PUT/api/settlement/{SettlementId}/acknowledgeAcknowledge Settlement as received
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.Settlement;

namespace DX.STF.Application.ClientApi.Messages.Settlement
{
    ///<summary>
    ///Settlement
    ///</summary>
    [Api(Description="Settlement")]
    [ApiResponse(Description="Updated", IsDefaultResponse=true, StatusCode=204)]
    [ApiResponse(Description="GLN does not have required access", StatusCode=403)]
    [ApiResponse(Description="Document not found", StatusCode=404)]
    public partial class AcknowledgeSettlement
    {
        [ApiMember(ExcludeInSchema=true, ParameterType="path")]
        public virtual Guid SettlementId { get; set; }
    }

}

C# AcknowledgeSettlement DTOs

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

HTTP + JSV

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

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

{
	
}