1Fetch Client API

CheckAccount

The following routes are available for this service:
GET	/checkaccount	Check account limit and remaining account amount

namespace WebService.ClientServiceModel

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

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CheckAccountResponse() = 
        inherit ApiServiceResponse()
        ///<summary>
        ///The total monthly limit for account payments, will be negative if there is no limit
        ///</summary>
        [<ApiMember(Description="The total monthly limit for account payments, will be negative if there is no limit")>]
        member val AccountLimit:Decimal = new Decimal() with get,set

        ///<summary>
        ///The amount that can still be used this month, will be negative if there is no account limit
        ///</summary>
        [<ApiMember(Description="The amount that can still be used this month, will be negative if there is no account limit")>]
        member val AccountRemaining:Decimal = new Decimal() with get,set

        ///<summary>
        ///Shows if this account is allowed to place real orders or quotes
        ///</summary>
        [<ApiMember(Description="Shows if this account is allowed to place real orders or quotes")>]
        member val AllowDataProcessing:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

    [<AllowNullLiteral>]
    type CheckAccount() = 
        inherit ApiServiceRequest()

F# CheckAccount 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 /checkaccount HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml

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

<CheckAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
  <AccountLimit>0</AccountLimit>
  <AccountRemaining>0</AccountRemaining>
  <AllowDataProcessing>false</AllowDataProcessing>
</CheckAccountResponse>