1Fetch Client API

<back to all web services

CheckAccount

The following routes are available for this service:
GET/checkaccountCheck account limit and remaining account amount
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ClientServiceModel;
using WebService.ClientServiceModel.Base;

namespace WebService.ClientServiceModel
{
    public partial class CheckAccount
        : ApiServiceRequest, ILogRequest
    {
    }

    public partial class CheckAccountResponse
        : 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")]
        public virtual decimal AccountLimit { 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")]
        public virtual decimal AccountRemaining { 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")]
        public virtual bool AllowDataProcessing { get; set; }
    }

}

namespace WebService.ClientServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { 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)]
        public virtual bool WasSuccessful { get; set; }
    }

}

C# CheckAccount 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 /checkaccount HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AccountLimit":0,"AccountRemaining":0,"AllowDataProcessing":false,"Description":"String","Heading":"String","WasSuccessful":false}