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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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