DX STF Client API

UpdateReceivingAdviceClientProcessed

Receiving Advice Requests

Receiving Advice

The following routes are available for this service:
PUT	/api/receivingAdvice/{ReceivingAdviceId}/processed	Update ReceivingAdvice as customer processed, will also acknowledge ReceivingAdvice if not yet set.

import 'package:servicestack/servicestack.dart';

class TokenDto implements ICommandResponse, IConvertible
{
    String token = "";

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

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

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

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

/**
* Receiving Advice
*/
// @Api(Description="Receiving Advice")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof(TokenDto), StatusCode=202)
class UpdateReceivingAdviceClientProcessed implements IConvertible
{
    /**
    * ReceivingAdvice ID or Token
    */
    // @ApiMember(Description="ReceivingAdvice ID or Token", ExcludeInSchema=true, ParameterType="path")
    String receivingAdviceId = "";

    /**
    * Customer ReceivingAdvice reference in destination system
    */
    // @ApiMember(Description="Customer ReceivingAdvice reference in destination system")
    String customerReference = "";

    /**
    * Date and Time ReceivingAdvice was processed in destination system
    */
    // @ApiMember(Description="Date and Time ReceivingAdvice was processed in destination system")
    DateTime customerProcessedDate = DateTime(0);

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

    fromMap(Map<String, dynamic> json) {
        receivingAdviceId = json['receivingAdviceId'];
        customerReference = json['customerReference'];
        customerProcessedDate = JsonConverters.fromJson(json['customerProcessedDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'receivingAdviceId': receivingAdviceId,
        'customerReference': customerReference,
        'customerProcessedDate': JsonConverters.toJson(customerProcessedDate,'DateTime',context!)
    };

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

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

Dart UpdateReceivingAdviceClientProcessed DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"customerReference":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}