DX STF Client API

Ping

Ping Requests

Ping

The following routes are available for this service:
POST	/api/ping	Test authentication and connectivity to API

import 'package:servicestack/servicestack.dart';

class PingResponse implements IConvertible
{
    String message = "";
    String glnNumber = "";

    PingResponse({this.message,this.glnNumber});
    PingResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* Ping
*/
// @Api(Description="Ping")
// @ApiResponse(Description="Ping response message", StatusCode=200)
class Ping implements IConvertible
{
    // @ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")
    String message = "";

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

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

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

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

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

Dart Ping DTOs

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

HTTP + CSV

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

POST /api/ping HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"message":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"message":"String","glnNumber":"String"}