LinkWatch
  • Documentation
    • Authorization
    • UserAccount
    • HealthProfessional
    • Patient
    • TypeIdentifier
    • Observation
    • Measurement
    • Questionnaire
    • GenericResponse
  • API
  • Postman

Authorization

To access the resources in LinkWatch API, the user first need to request an access token. This is done with the login method, which returns the access token in the response header. The access token are valid for 12 hours then they expires. To check if the token is still valid, the method Ping can be called.

Login

Login a user with credentials in the body which contains information about the user and password. With a successful login, an access token is returned in the response headers named “Token”. More detail information found at Login

Example

POST: {baseurl}/api/v1/authentication/login

Request
Body
{
 "UserName": "{username}",
 "Password": "{password}"
}
Headers

Accept: application/json
Content-Type: application/json

Response
Body
{
 "Result": "AA",
 "Message": "Patient"
}
Headers

Token: 09FDA49F-1D96-4A8E-9F99-FD7A4DED103C

Logout

Logout a user and removes the access token. Reuire an valid access token in the request header. More detail information found at Logout

Example

POST: {baseurl}/api/v1/authentication/logout

Request
Headers

Accept: application/json
Token: 09FDA49F-1D96-4A8E-9F99-FD7A4DED103C

Response
Body
{
 "Result": "AA",
 "Message": ""
}
Headers

Content-Type: application/json

Ping

Ping the service to see if the access token is still valid. Requires the access token in the request header. More detail information found at Ping

Example

GET: {baseurl}/api/v1/authentication/ping

Request
Headers

Accept: application/json
Token: 09FDA49F-1D96-4A8E-9F99-FD7A4DED103C

Response
Body
true
Headers

Content-Type: application/json


© 2025 - LinkWatch API