Skip to end of metadata
Go to start of metadata

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
http://<server>/webapi/rest/v1/info
HTTP MethodGET

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 Preferences 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
The rate limit configured for this server. By default, this is set to 100.
X-RateLimit-Remaining
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.
X-RateLimit-Reset
The time when the rate limit will next be reset. This is expressed as a UNIX timestamp in milliseconds (the number of milliseconds since January 1st 1970).

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:

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