GetRecalls

Returns the list of recalls.

JavaScript library method

patientportal.recalls.getRecalls({
    patient: <patient>,
    dueFrom: <due-from>,
    dueTo: <due-to>,
    pageSortColumn: <page-sort-column>,
    pageSortDescending: <page-sort-descending>,
    pageNumber: <page-number>,
    pageSize: <page-size>
});

HTTP Method

Verb	URL
GET	/patientportalapi/recalls/recalls

URL Parameters

Parameter	Type	Description
patient	string (optional)	The key of the patient provided by the API upon GetPatients.
due-from	DateTime (optional)	Due date filter..
due-to	DateTime (optional)	Due date filter.
page-sort-column	int (optional)	The column index to sort the result: 0 – Due date 1 – Created date 2 – Reminder date 3 – Appointment type name Default: 0
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

RecallData[]

Returned JSON

{
    "Items": [
        {
            "Key": "3bdd966cf6f9c0c6872ee0551da74c4d",
            "DueDate": "2017-03-14T00:00:00",
            "Reason": "Test",
            "AppointmentType": {
                "Key": "CN",
                "Name": "Consultation",
                "CancellationPolicy": "You will be charged at 50% of the full price if you cancel the appointment within 72 hours. You will be charged at 90% of the full price if you do not turn up.",
                "CanBookAppointment": true,
                "CanReferPatient": false,
                "TelemedicineOption": true,
                "CanAddServices": false
            },
            "Patient": {
                "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"
                }
            },
            "Clinician": {
                "Key": 84,
                "FullName": "Dr. House"
            }
        }
    ],
    "TotalCount":24,
    "CurrentPage":1,
    "PageSize":10,
    "SortColumn": 0,
    "SortDescending": false
}