Articles in this section

Managing Licenses

A license grants access to the PainChek system.  Your user id is linked to your license and all data (patients, assessments, comments, etc) are also linked back to the license.

Key License fields

Field

Type

Comment

start

Mandatory Date

The start date of the license

expiry

Mandatory Date

The end date of the license (after this date, the license can no longer be used)

is_expiring

Mandatory boolean

Indicates if the license is expiring "soon".
type Mandatory Integer 1=Commercial (institutional), 2=Private (personal)
holder Mandatory JSON Object A JSON object containing the details of the user or company the license is linked to.

Listing Licenses

To list details of your PainChek license (in the User Acceptance Environment), you can issue this command:

curl https://ap.ua.painchek.com/api/license/licenses/

 

Sample return data:

 Collapse source
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [{
        "uuid": "a89e0cc1-fd90-4721-b09b-7f527f5ff626",
        "number": "A89E0CC1-FD90",
        "start": "2017-08-25",
        "expiry": "2018-12-31",
        "is_expiring": false,
        "type": 2,
        "holder": {
            "first_name": "Wile E",
            "last_name": "Coyote",
            "email": "wile.e.coyote@acme.com",
            "phone": "0414 000 111",
            "mobile": "0414 000 111",
            "company_name": "ACME Ltd",
            "company_address": "35 Orange Street",
            "company_postcode": "2000",
            "company_city": "Sydney",
            "company_state": "Not applicable",
            "company_country": "AU",
            "company_phone": "0414 000 111"
        },
        "deleted_at": null
    }]
}

Creating a License

(warning) This is an unsupported action and should not be attempted

Updating a License

(warning) This is an unsupported action and should not be attempted