Info Endpoint

The /info endpoint returns general information about the SuperWEB2 instance you are connecting to. At present, this endpoint returns information about the dataset languages that are available on this server. It may be expanded in future to include additional information about the system configuration.

Overview

Endpoint	https://<server>/webapi/rest/v1/info
HTTP Method	GET

Request Headers

Accept-Language	The language that labels will be returned in (setting this is equivalent to changing the dataset and user interface language in SuperWEB2).	Optional. If not set, the server default language will be used.
APIKey	The API Key to use to authenticate this request. You can obtain your API key from the Account page in SuperWEB2.	Required in all requests.

If-None-Match	If you provide a known Etag value, then (if the response has not changed) this endpoint will return a 304 response instead of the response body. 304 responses do not count against your rate limit usage.	Optional. If not set, the request will count against your rate limit usage.

Response Headers

X-RateLimit

X-RateLimit-Schema

X-RateLimit-Table

The global, schema, and table rate limits (if configured).

The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies.

X-RateLimit-Remaining

X-RateLimit-Remaining-Schema

X-RateLimit-Remaining-Table

The number of requests remaining for the current rate limiting period. If this value drops to 0 then you will not be able to submit any further requests using this API key until the limit resets.

The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies.

X-RateLimit-Reset

X-RateLimit-Reset-Schema

X-RateLimit-Reset-Table

The time when the rate limit will next be reset. This is expressed as a UNIX timestamp in milliseconds (milliseconds since January 1st 1970).

The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies.

Etag	The checksum of the response. You can store this and use it in the `If-None-Match` header in subsequent requests. This will allow you to check whether the resource has changed without affecting your rate limit.

Response Body

Following is an example response. This example indicates that 3 dataset languages are configured on this server, English, French and German:

CODE

{
  "languages": [
    {
      "locale": "de",
      "displayName": "Deutsch"
    },
    {
      "locale": "en",
      "displayName": "English"
    },
    {
      "locale": "fr",
      "displayName": "français"
    }
  ]
}