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

import 'package:servicestack/servicestack.dart';

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

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

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

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

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

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

Dart AcknowledgeReceivingAdvice 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/receivingAdvice/{ReceivingAdviceId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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