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
namespace WebService.ClientServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TestResult() = 
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val Description:String = null with get,set

    [<AllowNullLiteral>]
    type TestResponse() = 
        member val Environment:String = null with get,set
        member val Tests:Dictionary<String, TestResult> = new Dictionary<String, TestResult>() with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val DB:String = null with get,set
        member val DebugMode:Boolean = new Boolean() with get,set
        member val ServerGC:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Test() = 
        ///<summary>
        ///An email address a test email will be sent to
        ///</summary>
        [<ApiMember(Description="An email address a test email will be sent to")>]
        member val Smtp:String = null with get,set

F# 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>