API reference

https://docs.hslynk.com/?urls.primaryName=Global%20API#/consents

What is a consent ?

A consent is permission to access a client's data, granted by that client to another organizational group. In HSLynk, a consent will be given by the client for a specific global project or a group of global projects. Users associated with those global projects can access all the client's information like enrollments, exits, disabilities, veteran status etc.

What information is included in a client consent ?

A consent specifies the list of global projects and the time frame (start and end times) during which its effective.

• A customer admin (or other user roles as the customer configures) can create a consent using the API. https://docs.hslynk.com/#/consents/POST_clients-clientId-consents

• Also, customer admin (or other user roles as the customer configures) can upload the consent document provided by the client using the API below. https://docs.hslynk.com/#/consents/POST_clients-clientid-consents-consentid-documents

How to retrieve consents ?

Consents that are provided by a client can be retrieved via the following API https://docs.hslynk.com/#/consents/GET_clients-clientId-consents

Also, the response to this API contains the reference to the consent document, if its already uploaded.

How can I add or delete a project to an existing consent?

• Adding a new project to an existing consent can be done via the following API https://docs.hslynk.com/#/consents/PUT_clients-clientId-consents-consentId-projects

• Deleting a project from an existing consent can be done via the following API https://docs.hslynk.com/#/consents/DELETE_clients-clientId-consents-consentId-projects-globalProjectId

How do we upload a client's consent document ?

A consent document can be uploaded using the API. If a new consent document is uploaded, the existing consent document will be overridden. https://docs.hslynk.com/#/consents/POST_clients-clientid-consents-consentid-documents

How do we download a client's consent document ?

A consent document can be deleted using the API https://docs.hslynk.com/#/consents/GET_clients-clientid-consents-consentid-documents

Additional information

What is a global project ?

A global project is composed of version specific HMIS projects, and soon, generic projects. A global project will be automatically created when a version specific HMIS project is created, based on source system ID and the project name.

• API to create a global project https://docs.hslynk.com/#/default/POST_global-projects

How users can be associated with a global project ?

A customer admin can add users of a specific project group to a global project.

• API to associate users to a global project https://docs.hslynk.com/#/default/PUT_global-projects-%24globalProjectId-users