Global (non-oAuth) Parameters

All of the parameters below are required, unless otherwise noted.

ha_version

The Hyves API version. Should be the desired API version. This parameter is not to be confused with oauth_version, which specifies the version of oAuth that is being used, and should be "1.0", if present.

ha_fancylayout

Either "true" or "false"; sets the format of the returned strings. See ha_fancylayout.

ha_format

The output format, either "xml" or "json". See ha_format.

ha_callback

Optional. If specified , defines the javascript function to be called with the result. See ha_format.

ha_language

Optional. Force a given language instead of using the language of the logged in user. Values can be "en" or "nl" ofr english and dutch.

Note: this parameter will only work (correctly) in API-version 2.0 and up.

ha_method

The API method to call. This parameter is not to be confused with the HTTP-method (usually "GET" or "POST"), which is needed to calculate the oauth_signature. See methods.

ha_page

Optional for some methods, not allowed for others (see APIMethods). The page number to show for paginated results, base 1 (default = 1).

ha_resultsperpage

Optional for some methods, not allowed for others (see APIMethods). The page number to show for paginated results, default = 12.

ha_responsefields

Optional for some methods, not allowed for others (see APIMethods). Functions will return extra information only when it's explicitly asked for through this parameter. See an example.

ha_returnfields

Optional. Filter API results server-side to save bandwith/processtime. For more info see APIHaReturnfields.

Note: this parameter will only work (correctly) in API-version 2.0 and up.

ha_responsecode_always_200

Optional for all methods, will always return header responsecode 200 (even when errors occur), this is necessary when using JSONP calls.