GetUsers

Returns the list of users.

JavaScript library method 

patientportal.users.getUsers({
    text: <text>,
    name: <name>,
    department: <department>,
    division: <division>,
    email: <email>,
    employeeNumber: <employee-number>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb URL
GET /patientportalapi/users/users

URL Parameters

Parameter Type Description
text string (optional) Any text the API will try to filter by name, email or employee number.
name string (optional) Name filter.
department string (optional) Key of the department provided by the API upon GetDepartments.
division string (optional) Key of the division provided by the API upon GetDepartments.
email string (optional) Email filter.
employee-number string (optional) Employee number filter.
page-sort-column int (optional)

The column index to sort the result:

  • 0 – User’s name
  • 1 – Email address
  • 2 – Account type
  • 3 – Employee number

By default the result is sorted by the user name.
page-sort-descending int (optional) True to sort result descending.
page-number int (optional) Required page number. Default 1.
page-size int (optional) Required page size. Default 10. Minimum 5. Maximum 50.

Returns

UserData[]

Returned JSON 

{
    "Items": [
        {
            "Title": "Mr",
            "Name": "John",
            "Surname": "Lemon",
            "SexType": 1,
            "Initials": "JL",
            "DateOfBirth": "1958-08-02T00:00:00",
            "Mobile": "+444 895 523 411",
            "Telephone": "+444 525 111 555",
            "EmailAddress": "<john.lemon@test.com>",
            "WorkEmailAddress": "<john.lemon@mywork.com>",
            "Address": {
                "Address1": "Studio 99",
                "Address2": "Backlok Street",
                "Address3": "Camden",
                "City": "London",
                "County": "",
                "PostCode": "N1 7NK",
                "Country": "United Kingdom"
            },
            "NextOfKin": {
                "Relationship": "Mam",
                "Name": "Mariel",
                "Surname": "Lemon",
                "Mobile": "+444 895 111 222",
                "WorkTelephone": "+444 525 111 555",
                "Address": {
                    "Address1": "Studio 1",
                    "Address2": "Cardwell Roa",
                    "Address3": "Camden",
                    "City": "London",
                    "County": "",
                    "PostCode": "N1 7NK",
                    "Country": "United Kingdom"
                }
            },
            "AllPatientsVisible": false,
            "AllNonAssignedPatientsVisible": false,
            "Rights": [
                {
                    "Key": "0f0f8997-a161-455e-a498-96138096f539",
                    "Name": "Case management",
                    "Description": "The user can refer patients and manage the referrals."
                }
            ],
            "AccessibleDepartments": [
                {
                    "Key": "D01",
                    "Name": "HR"
                },
                {
                    "Key": "D02",
                    "Name": "Research"
                }
            ],
            "LastLogin": "2015-01-01T10:41:10.547"
        }
    ],
    "TotalCount":1,
    "CurrentPage":1,
    "PageSize":10,
    "SortColumn": 0,
    "SortDescending": false
}