| GET | /checkaccount | Check account limit and remaining account amount |
|---|
"use strict";
export class ApiServiceRequest {
/** @param {{ApiKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
ApiKey;
}
export class ApiServiceResponse {
/** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Information about the response. */
Description;
/**
* @type {string}
* @description Heading or summary of the response. */
Heading;
/**
* @type {boolean}
* @description Did the intended operation for this response complete successfully? */
WasSuccessful;
}
export class CheckAccountResponse extends ApiServiceResponse {
/** @param {{AccountLimit?:number,AccountRemaining?:number,AllowDataProcessing?:boolean,Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description The total monthly limit for account payments, will be negative if there is no limit */
AccountLimit;
/**
* @type {number}
* @description The amount that can still be used this month, will be negative if there is no account limit */
AccountRemaining;
/**
* @type {boolean}
* @description Shows if this account is allowed to place real orders or quotes */
AllowDataProcessing;
}
export class CheckAccount extends ApiServiceRequest {
/** @param {{ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
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
}