1Fetch Client API

Test

The following routes are available for this service:
GET	/test	Simple test method to confirm the services are working

"use strict";
export class TestResult {
    /** @param {{WasSuccessful?:boolean,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    WasSuccessful;
    /** @type {string} */
    Description;
}
export class TestResponse {
    /** @param {{Environment?:string,Tests?:{ [index: string]: TestResult; },WasSuccessful?:boolean,DB?:string,DebugMode?:boolean,ServerGC?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Environment;
    /** @type {{ [index: string]: TestResult; }} */
    Tests;
    /** @type {boolean} */
    WasSuccessful;
    /** @type {string} */
    DB;
    /** @type {boolean} */
    DebugMode;
    /** @type {boolean} */
    ServerGC;
}
export class Test {
    /** @param {{Smtp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description An email address a test email will be sent to */
    Smtp;
}

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

GET /test HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/csv

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

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