ListShiftSegmentsByShiftInstanceSids

Lists shift segments for the specified shift instances for the org sending the request.
If @include_scheduling_activity is set to true then the related scheduling activity for the shift segment will be returned in the scheduling activity field.
If @include_activity is set to true then the related non skill activity for the scheduling activity will be returned in the scheduling activities member non skill activity field.
The given @shift_instance_sids must all belong to the given @schedule_type.
Errors:

grpc.Invalid: the request data is invalid.

grpc.NotFound: a shift instance doesn't exist.

grpc.Internal: error occurs when getting the data.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "shift_instance_sids": [
        0
    ],
    "include_scheduling_activity": true,
    "include_activity": true,
    "schedule_type": "DRAFT"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "shift_segments": [
        {
            "shift_segment_sid": 0,
            "shift_instance_sid": 0,
            "order_in_shift_instance": 0,
            "width_in_minutes": 0,
            "start_minute_in_shift": 0,
            "scheduling_activity_sid": 0,
            "scheduling_activity": {
                "scheduling_activity_sid": 0,
                "is_skill_activity": true,
                "activity_sid": "string",
                "member_non_skill_activity": {
                    "non_skill_activity_sid": 0,
                    "name": "string",
                    "description": "string",
                    "datetime_set_to_inactive": "1s",
                    "red": 0,
                    "green": 0,
                    "blue": 0,
                    "transparency": 0,
                    "inherited_from_entity": {
                        "parent_sid": 0,
                        "parent_type": "CALL_CENTER_NODE"
                    }
                },
                "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                "pause_codes": [
                    "string"
                ],
                "reason_codes": [
                    {
                        "reason_code_id": 0,
                        "name": "string",
                        "scheduling_activity_sid": 0,
                        "is_planned": true,
                        "is_paid": true,
                        "is_default": true,
                        "datetime_set_to_inactive": "1s"
                    }
                ]
            },
            "call_stats_by_skill_collection": [
                {
                    "num_calls": 0,
                    "percent_fit": 0,
                    "skill_collection": {
                        "skill_profile_category_sid": 0,
                        "skill_profile_category_type": "SINGLE_SKILL_PROFILE"
                    }
                }
            ],
            "reason_code_id": 0
        }
    ]
}

🟢200Success