1Fetch Client API

<back to all web services

CheckAccount

export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public ApiKey: string;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public Description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public Heading: string;

    /** @description 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 WasSuccessful: boolean;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class CheckAccountResponse extends ApiServiceResponse
{
    /** @description 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 AccountLimit: number;

    /** @description 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 AccountRemaining: number;

    /** @description 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 AllowDataProcessing: boolean;

    public constructor(init?: Partial<CheckAccountResponse>) { super(init); (Object as any).assign(this, init); }
}

export class CheckAccount extends ApiServiceRequest implements ILogRequest
{

    public constructor(init?: Partial<CheckAccount>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CheckAccount DTOs

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
}