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 .xml suffix or ?format=xml

HTTP + XML

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <DB>String</DB>
  <DebugMode>false</DebugMode>
  <Environment>String</Environment>
  <ServerGC>false</ServerGC>
  <Tests xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringTestResultflr_Pus7X>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <Description>String</Description>
        <WasSuccessful>false</WasSuccessful>
      </d2p1:Value>
    </d2p1:KeyValueOfstringTestResultflr_Pus7X>
  </Tests>
</TestResponse>