Web API help page

This Web API is a REST API to enable features of a configured Pointsharp ID from anywhere in its dedicated network. The features are divided into several sub categories that are explained here. The provided samples are to demonstrate the syntax of a function rather than to give an exact usage.

Please note, since the API enable features of a Pointsharp ID, it indicates that some of the API features explained here may only function with the corresponding license of the Pointsharp ID.

Response codes

If a non-successful HTTP code is retrieved in the response header from this REST API, then the response body will contain a brief message about the issue. If successful, then the requested data (if any) will be set in the body of the response. The following table is providing the description of all the HTTP codes that is supported by this REST API.

HTTP Code	Title	Description
200	OK	The expected result was retrieved. Review the request body to retrieve the response data.
400	Bad Request	A controlled error caused by the request data occurred. The error code indicates that the request was not fully executed rather than a fatal error. Review log for more information.
403	Forbidden	The requested path is blocked or disabled by configuration.
405	Method Not Allowed	The requested path is not yet supported by the current version of this API. It is used between API versions.
500	Internal Server Error	An unexpected error occurred caused by client data or internal settings. The error is considered a fatal error. Please review log for more information and contact the support if the cause of the error cannot be solved.

HTTP Code

Title

Description

200

The expected result was retrieved. Review the request body to retrieve the response data.

400

Bad Request

A controlled error caused by the request data occurred. The error code indicates that the request was not fully executed rather than a fatal error. Review log for more information.

403

Forbidden

The requested path is blocked or disabled by configuration.

405

Method Not Allowed

The requested path is not yet supported by the current version of this API. It is used between API versions.

500

Internal Server Error

An unexpected error occurred caused by client data or internal settings. The error is considered a fatal error. Please review log for more information and contact the support if the cause of the error cannot be solved.

Request headers

A REST API is using HTTP headers to enrich its communication capabilities. This REST API implements support for accept headers with four different media types (listed below).

Please note, if a server is not reachable, or if other server issues occur that is not related to this specific REST API, the response may be in HTML format.

XML (may not fully work for all configuration types)
- application/xml
- text/xml
JSON
- application/json
- text/json

This REST API also provides support for different optional accept media type parameters. The following table gives a description of each enabled feature through the additional parameters.

Parameter name	Description
Version	Set this parameter to use a specific version of this REST API (use 0, or exclude, for latest version).
IncludeType	Set this parameter to "true" to retrieve the exact class type information when retrieving the response data. This parameter is used to convert the response information into the exact class type of its origin, for example, converting items in a C# ArrayList on client side.
FilterPasswords	Set this parameter to "false" to include encrypted password data (do not set or set to "true" in order to lower the amont of sent data). This parameter is used during configuration distribution where the receiver have the decryption keys to decrypt the passwords.

Parameter name

Description

Version

Set this parameter to use a specific version of this REST API (use 0, or exclude, for latest version).

IncludeType

Set this parameter to "true" to retrieve the exact class type information when retrieving the response data. This parameter is used to convert the response information into the exact class type of its origin, for example, converting items in a C# ArrayList on client side.

FilterPasswords

Set this parameter to "false" to include encrypted password data (do not set or set to "true" in order to lower the amont of sent data). This parameter is used during configuration distribution where the receiver have the decryption keys to decrypt the passwords.