DX STF Client API

AcknowledgeSettlement

Settlement Requests

Settlement

The following routes are available for this service:
PUT	/api/settlement/{SettlementId}/acknowledge	Acknowledge Settlement as received

import 'package:servicestack/servicestack.dart';

/**
* 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)
class AcknowledgeSettlement implements IConvertible
{
    // @ApiMember(ExcludeInSchema=true, ParameterType="path")
    String settlementId = "";

    AcknowledgeSettlement({this.settlementId});
    AcknowledgeSettlement.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        settlementId = json['settlementId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'settlementId': settlementId
    };

    getTypeName() => "AcknowledgeSettlement";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'stf_api_uat.data_xchange.co.za', types: <String, TypeInfo> {
    'AcknowledgeSettlement': TypeInfo(TypeOf.Class, create:() => AcknowledgeSettlement()),
});

Dart AcknowledgeSettlement DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{}