Resources

API Authentication

This REST service provides end points that allow a client to login, logout and perform password resets. The structure of each of these requests and associated responses are discussed in three sections below.

To enhance understanding of the REST procedures presented on this page, please choose your preferred scripting/programming language in the select box below;





REST Login

Login Request
Login Response



The content type header of a login request, as with all other request of this service, should be set to application/json as shown in the Login Request example code above. Correspondingly, the body of the request is a JSON object with three properties, i.e., the userName, password and apiToken value assigned by the user’s organization.

A successful login request will have a response similar to what is contained in the Login Response code box. The assigned sessionID parameter value must be included with any subsequent request. The sessionIdleTimeSec parameter value indicates how long, in seconds, an authenticated session can be idle for before being automatically logged out by the service. The purpose of the useAttachmentProxy value is discussed on the data submission page.

Note that 5 successive failed authentication attempts will lead to the ban of the REST client from using this service for 30 minutes or more.




REST Logout

Logout Request
Logout Response



To logout a REST client simply supply the authenticated sessionID parameter value assigned at login to the end point and manner shown in the Logout Request code box above.




REST Reset Password

Password Reset Request
Password Reset Response



To reset/change a user password, the REST client must supply the user name, current password as well as the new password to the specified end point as exemplified in the Reset Password Request code box below.

5 successive failed password reset attempts will lead to the ban of the client from using this REST service for 30 minutes or more.


Click here for examples on how to submit completed forms to the REST service.