AppointmentSchedules.get

Returns AppointmentSchedule with given id

Responses

🟢200OK

application/json

AppointmentSchedule data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (AppointmentSchedule)

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_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_type

string <uri>

required

Relation to AppointmentType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AppointmentType' 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.

reply_company_email

string <uri>

optional

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

appointment_description

string

required

String value.

Example:

string

appointment_duration

number <double>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

4.32

appointment_location

string

required

String value.

Example:

string

appointment_location_type

enum<integer>

optional

Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom

Allowed values:

012

Example:

appointment_owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

appointment_subject

string

required

String value.

Example:

string

appointment_subject_uses_schedule_name

boolean

required

Boolean value.

Example:

false

appointment_type_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

availability_tzid

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

buffer_time_after

integer <int32>

required

Whole natural number.

Example:

buffer_time_before

integer <int32>

required

Whole natural number.

Example:

confirmation_page_type

enum<integer>

optional

Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl

Allowed values:

Example:

confirmation_page_url

string

optional

URL - HTTP address.

Example:

string

is_enabled

boolean

required

Boolean value.

Example:

false

minimum_notice_time

integer <int32>

required

Whole natural number.

Example:

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

planning_day_offset

integer <int32>

required

Whole natural number.

Example:

planning_period_from

string <date>

optional

Date information.

Example:

2019-01-01

planning_period_to

string <date>

optional

Date information.

Example:

2019-01-01

planning_type

enum<integer>

optional

Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period

Allowed values:

012

Example:

reminder_email_enabled

boolean

required

Boolean value.

Example:

false

reminder_email_offset

integer <int32>

required

Whole natural number.

Example:

reminder_email_offset_type

enum<integer>

optional

Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week

Allowed values:

0123

Example:

reply_company_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

schedule_name

string

required

String value.

Example:

string

time_increment

integer <int32>

required

Whole natural number.

Example:

type

enum<integer>

optional

Integer enum value: 0 - OneToOne, 1 - Group

Allowed values:

Example:

url

string

required

String value.

Example:

string

additional_fields_data

array [object {3}]

required

availability_data

object

required

appointment_invitees_data

array [object {3}]

required

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_owner": "http://example.com",
        "appointment_type": "http://example.com",
        "owner": "http://example.com",
        "reply_company_email": "http://example.com",
        "appointment_description": "string",
        "appointment_duration": "4.32",
        "appointment_location": "string",
        "appointment_location_type": 0,
        "appointment_owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "appointment_subject": "string",
        "appointment_subject_uses_schedule_name": false,
        "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "availability_tzid": "string",
        "buffer_time_after": 1,
        "buffer_time_before": 1,
        "confirmation_page_type": 0,
        "confirmation_page_url": "string",
        "is_enabled": false,
        "minimum_notice_time": 1,
        "name": "string",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "planning_day_offset": 1,
        "planning_period_from": "2019-01-01",
        "planning_period_to": "2019-01-01",
        "planning_type": 0,
        "reminder_email_enabled": false,
        "reminder_email_offset": 1,
        "reminder_email_offset_type": 0,
        "reply_company_email_id": "01234567-abcd-dcba-ffff-000000000000",
        "schedule_name": "string",
        "time_increment": 1,
        "type": 0,
        "url": "string",
        "additional_fields_data": [
            {
                "field_id": "01234567-abcd-dcba-ffff-000000000000",
                "label": "string",
                "is_required": false
            }
        ],
        "availability_data": {},
        "appointment_invitees_data": [
            {
                "entity_id": "01234567-abcd-dcba-ffff-000000000000",
                "email": "string",
                "type": 1
            }
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

AppointmentSchedules.get

Request

Request samples

Responses