| GET | /checkaccount | Check account limit and remaining account amount |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
# @ApiMember(Description="Information about the response.", IsRequired=true)
description: Optional[str] = None
"""
Information about the response.
"""
# @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
heading: Optional[str] = None
"""
Heading or summary of the response.
"""
# @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
was_successful: bool = False
"""
Did the intended operation for this response complete successfully?
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckAccountResponse(ApiServiceResponse):
# @ApiMember(Description="The total monthly limit for account payments, will be negative if there is no limit")
account_limit: Decimal = decimal.Decimal(0)
"""
The total monthly limit for account payments, will be negative if there is no limit
"""
# @ApiMember(Description="The amount that can still be used this month, will be negative if there is no account limit")
account_remaining: Decimal = decimal.Decimal(0)
"""
The amount that can still be used this month, will be negative if there is no account limit
"""
# @ApiMember(Description="Shows if this account is allowed to place real orders or quotes")
allow_data_processing: bool = False
"""
Shows if this account is allowed to place real orders or quotes
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckAccount(ApiServiceRequest, ILogRequest):
pass
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
}