1Fetch Client API

Test

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestResult:
    was_successful: bool = False
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestResponse:
    environment: Optional[str] = None
    tests: Optional[Dict[str, TestResult]] = None
    was_successful: bool = False
    db: Optional[str] = None
    debug_mode: bool = False
    server_g_c: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Test:
    # @ApiMember(Description="An email address a test email will be sent to")
    smtp: Optional[str] = None
    """
    An email address a test email will be sent to
    """

Python 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
}