| GET | /checkaccount | Check account limit and remaining account amount |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CheckAccount extends ApiServiceRequest implements ILogRequest
{
}
public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
public String getApiKey() { return ApiKey; }
public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
}
public static class CheckAccountResponse extends 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")
public BigDecimal AccountLimit = 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")
public BigDecimal AccountRemaining = 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")
public Boolean AllowDataProcessing = null;
public BigDecimal getAccountLimit() { return AccountLimit; }
public CheckAccountResponse setAccountLimit(BigDecimal value) { this.AccountLimit = value; return this; }
public BigDecimal getAccountRemaining() { return AccountRemaining; }
public CheckAccountResponse setAccountRemaining(BigDecimal value) { this.AccountRemaining = value; return this; }
public Boolean isAllowDataProcessing() { return AllowDataProcessing; }
public CheckAccountResponse setAllowDataProcessing(Boolean value) { this.AllowDataProcessing = value; return this; }
}
public static class ApiServiceResponse implements IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
public String Description = null;
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public String Heading = 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)
public Boolean WasSuccessful = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
}
}
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
}