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
import Foundation
import ServiceStack

/**
* Settlement
*/
// @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 class AcknowledgeSettlement : Codable
{
    // @ApiMember(ExcludeInSchema=true, ParameterType="path")
    public var settlementId:String

    required public init(){}
}

Swift AcknowledgeSettlement DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AcknowledgeSettlement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.Settlement">
  <SettlementId>00000000-0000-0000-0000-000000000000</SettlementId>
</AcknowledgeSettlement>