}

/v1/account/settings

https://api.reporting.cloud/v1/account/settings

Returns detailed information about the account quota and general settings.

Authorization

This endpoint requires a "ReportingCloud-APIKey" or a "Basic" user authorization to access the user acount, data and templates. Only one of these two methods are required.

ReportingCloud-APIKey
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

An API Key needs to be generated using the portal or /v1/account/apikey endpoint. The authorization method and a space i.e. "ReportingCloud-APIKey " is then put before the actual API Key string.

Sample:

Authorization: ReportingCloud-APIKey oMDM4MrAqL9QEOpyzupnQW5NjvCNtvE5cVDaaLqxI

Basic
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

The username and password are combined into a string separated by a colon, e.g.: username:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string.

Sample:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l


Success Response

Return Value Description

200 (OK)

On success, the HTTP status code in the response header is 200 (OK). The response body contains a ReportingCloud AccountSettings object.

AccountSettings

Key Value Type Description
serialNumber String The serial number that is attached to the account. Possible values are FREE, TRIAL and a 13 character long serial number.
validUntil DateTime (String) Returns the date until the current subscription is valid. The date string includes the time zone of the server (UTC). Sample: 2016-06-06T11:25:44+00:00
createdDocuments Integer The number of created documents in the current month.
uploadedTemplates Integer The number of uploaded templates to the template storage.
maxDocuments Integer The maximum number of documents that can be created per month.
maxTemplates Integer The maximum number of templates that can be uploaded to the template storage.
proofingTransactions Integer The number of proofing transactions in the current month.
maxProofingTransactions Integer The maximum number of proofing transactions per month.

Error Response

Return Value Description

403 (Forbidden)

A 403 (Forbidden) is returned, if the user is not authorized.

Sample Requests

Request:

Results:

Request:

Results:

Request:

Results:

Request:

Results:

Request:

Results:

Get