1Fetch Client API

<back to all web services

Test

The following routes are available for this service:
GET/testSimple test method to confirm the services are working
import 'package:servicestack/servicestack.dart';

class TestResult implements IConvertible
{
    bool? WasSuccessful;
    String? Description;

    TestResult({this.WasSuccessful,this.Description});
    TestResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class TestResponse implements IConvertible
{
    String? Environment;
    Map<String,TestResult?>? Tests;
    bool? WasSuccessful;
    String? DB;
    bool? DebugMode;
    bool? ServerGC;

    TestResponse({this.Environment,this.Tests,this.WasSuccessful,this.DB,this.DebugMode,this.ServerGC});
    TestResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Environment = json['Environment'];
        Tests = JsonConverters.fromJson(json['Tests'],'Map<String,TestResult?>',context!);
        WasSuccessful = json['WasSuccessful'];
        DB = json['DB'];
        DebugMode = json['DebugMode'];
        ServerGC = json['ServerGC'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Environment': Environment,
        'Tests': JsonConverters.toJson(Tests,'Map<String,TestResult?>',context!),
        'WasSuccessful': WasSuccessful,
        'DB': DB,
        'DebugMode': DebugMode,
        'ServerGC': ServerGC
    };

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

class Test implements IConvertible
{
    /**
    * An email address a test email will be sent to
    */
    // @ApiMember(Description="An email address a test email will be sent to")
    String? Smtp;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.1fetch.co.za', types: <String, TypeInfo> {
    'TestResult': TypeInfo(TypeOf.Class, create:() => TestResult()),
    'TestResponse': TypeInfo(TypeOf.Class, create:() => TestResponse()),
    'Map<String,TestResult?>': TypeInfo(TypeOf.Class, create:() => Map<String,TestResult?>()),
    'Test': TypeInfo(TypeOf.Class, create:() => Test()),
});

Dart Test 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.

GET /test HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Environment":"String","Tests":{"String":{"WasSuccessful":false,"Description":"String"}},"WasSuccessful":false,"DB":"String","DebugMode":false,"ServerGC":false}