AppointmentReminders.get

Returns AppointmentReminder with given id

Responses

🟢200OK

application/json

AppointmentReminder data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (AppointmentReminder)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

appointment

string <uri>

required

Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

appointment_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

end_date_offset

integer <int32>

required

Whole natural number.

Example:

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

snooze_date

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

status

enum<integer>

optional

Integer enum value: 0 - Snoozed, 1 - Scheduled, 2 - Dismissed

Allowed values:

012

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "appointment": "http://example.com",
        "owner": "http://example.com",
        "appointment_id": "01234567-abcd-dcba-ffff-000000000000",
        "end_date_offset": 1,
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "snooze_date": "2019-01-01T00:00:00",
        "status": 0,
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error

AppointmentReminders.get

Request

Request samples

Responses