1Fetch Client API

Test

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


export class TestResult
{
    public WasSuccessful: boolean;
    public Description: string;

    public constructor(init?: Partial<TestResult>) { (Object as any).assign(this, init); }
}

export class TestResponse
{
    public Environment: string;
    public Tests: { [index: string]: TestResult; };
    public WasSuccessful: boolean;
    public DB: string;
    public DebugMode: boolean;
    public ServerGC: boolean;

    public constructor(init?: Partial<TestResponse>) { (Object as any).assign(this, init); }
}

export class Test
{
    /** @description An email address a test email will be sent to */
    // @ApiMember(Description="An email address a test email will be sent to")
    public Smtp: string;

    public constructor(init?: Partial<Test>) { (Object as any).assign(this, init); }
}

TypeScript Test DTOs

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

HTTP + JSV

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/jsv

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

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