| GET | /checkaccount | Check account limit and remaining account amount |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CheckAccount : ApiServiceRequest(), ILogRequest
{
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
}
open class CheckAccountResponse : ApiServiceResponse()
{
/**
* The total monthly limit for account payments, will be negative if there is no limit
*/
@ApiMember(Description="The total monthly limit for account payments, will be negative if there is no limit")
var AccountLimit:BigDecimal? = null
/**
* The amount that can still be used this month, will be negative if there is no account limit
*/
@ApiMember(Description="The amount that can still be used this month, will be negative if there is no account limit")
var AccountRemaining:BigDecimal? = null
/**
* Shows if this account is allowed to place real orders or quotes
*/
@ApiMember(Description="Shows if this account is allowed to place real orders or quotes")
var AllowDataProcessing:Boolean? = null
}
open class ApiServiceResponse : IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
var Description:String? = null
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
var Heading:String? = null
/**
* Did the intended operation for this response complete successfully?
*/
@ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
var WasSuccessful:Boolean? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AccountLimit: 0,
AccountRemaining: 0,
AllowDataProcessing: False,
Description: String,
Heading: String,
WasSuccessful: False
}