ListShiftInstancesBySid

Lists the shift instances with the corresponding @shift_instance_sids for the org sending the request.
If @include_shift_template is set to true then the related shift template for the shift instances will be returned in the shift template field.
If @include_shift_segments is set to true then the related shift segments for the shift instances will be returned in the shift segments field.
If @include_shift_segment_call_stats is set to true then the related shift segment call stats for the shift segments will be returned in the call stats by skill collection field on the shift segments.
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.
@include_shift_segments must be true to take effect.
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. @include_scheduling_activity must be true to take effect.
The given @shift_instance_sids must all belong to the given @schedule_type.
Errors:

grpc.Invalid: @shift_instance_sids in the request are invalid.

grpc.Internal: error occurs when listing the shift instances or their shift segments.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the ListShiftInstancesBySid RPC

schedule_type

enum<string>

schedule_type

optional

The schedule type that the shift instances are associated with.
All @shift_instance_sids must belong to the same type of schedule.

Allowed values:

DRAFTPUBLISHED

include_shift_segments

boolean

include_shift_segments

optional

If true, the shift segments will be included in the returned shift instances.
If false, the instances will be returned without any shift segments.

include_shift_template

boolean

include_shift_template

optional

Set to true to include shift template in the returned shift instance.

include_scheduling_activity

boolean

include_scheduling_activity

optional

Set to true to include scheduling activity in each of the returned shift segments.
Only effective when include_shift_segments is also set to true.

include_activity

boolean

include_activity

optional

Set to true to include non skill activity in each of the returned scheduling activities.
Only effective when include_scheduling_activity and include_shift_segments are also set to true.

include_shift_segment_call_stats

boolean

include_shift_segment_call_stats

optional

Set to true to include shift segment call stats in each of the returned shift segments.
Only effective when @include_shift_segments is also set to true.

shift_instance_sids

array[integer <int64> | string]

shift_instance_sids

optional

ID of the shift instances to list.

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the ListShiftInstancesBySid RPC

shift_instances

array[object (ShiftInstance) {12}]

shift_instances

optional

The shift instances that match the given @shift_instance_sids.

start_datetime

string <date-time>

start_datetime

optional

The start time for this shift instance

Examples:

1s1.000340012s

schedule_type

enum<string>

schedule_type

optional

Type of schedule that this shift instance belongs to.

Allowed values:

DRAFTPUBLISHED

shift_template

object (ShiftTemplate)

shift_template

optional

The shift template used to create this shift instance.

is_locked

boolean

is_locked

optional

Tells the scheduler to leave this instance in tact when performing 'build schedule'.
If set to false, the instance will not be locked and may be lost when a new schedule is built.

width_in_minutes

integer <int32>

width_in_minutes

optional

The duration of this shift instance in minutes.

shift_segments

array[object (ShiftSegment) {9}]

shift_segments

optional

The following field is only returned in List requests of the entity.
The ordered set of shift segments for this shift instance.

planned_shrinkage_percent

number <float>

planned_shrinkage_percent

optional

the percentage shrinkage expected for this shift [0.0, 100.0]. 0.0 = no shrinkage, 100 = no agents

shift_instance_sid

integer <int64> | string

shift_instance_sid

optional

ID of the shift instance.

shift_template_sid

integer <int64> | string

shift_template_sid

optional

ID of shift template that this shift instance belongs to.

originating_program_node_sid

integer <int64> | string

originating_program_node_sid

deprecated

ID of the program node that the shift instance belongs to, which may be different that the one that the @parent_shift_template_sid belongs to.

schedule_sid

integer <int64> | string

schedule_sid

optional

ID of the schedule that this shift instance belongs to.
May either point to a published or draft schedule.

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

ID for the wfm agent that is scheduled to this shift.

Example

{
  "shift_instances": [
    {
      "start_datetime": "1s",
      "schedule_type": "DRAFT",
      "shift_template": {
        "datetime_set_to_inactive": "1s",
        "name": "string",
        "description": "string",
        "is_tourshift": true,
        "min_shift_width": 0,
        "max_shift_width": 0,
        "min_agents": 0,
        "max_agents": 0,
        "shift_start_boundary_minutes": 0,
        "same_time_each_DOW": true,
        "same_length_per_agent": true,
        "member_placement_rules": [
          {
            "member_scheduling_activity": {
              "activity_sid": "string",
              "member_non_skill_activity": {
                "datetime_set_to_inactive": "1s",
                "inherited_from_entity": {
                  "parent_type": "CALL_CENTER_NODE",
                  "parent_sid": 0
                },
                "name": "string",
                "description": "string",
                "red": 0,
                "green": 0,
                "blue": 0,
                "transparency": 0,
                "non_skill_activity_sid": 0
              },
              "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
              "is_skill_activity": true,
              "reason_codes": [
                {
                  "datetime_set_to_inactive": "1s",
                  "name": "string",
                  "is_planned": true,
                  "is_paid": true,
                  "is_default": true,
                  "reason_code_id": 0,
                  "scheduling_activity_sid": 0
                }
              ],
              "scheduling_activity_sid": 0,
              "pause_codes": [
                "string"
              ]
            },
            "activity_order": 0,
            "min_duration_minutes": 0,
            "max_duration_minutes": 0,
            "placement_rule_sid": 0,
            "shift_template_sid": 0,
            "scheduling_activity_sid": 0,
            "schedule_scenario_sid": 0
          }
        ],
        "DOW_placements": [
          {
            "placement_type": "MUST_NOT",
            "day_of_week": "MON",
            "start_minute": 0,
            "end_minute": 0,
            "week_number": 0
          }
        ],
        "member_agent_groups": [
          {
            "parent_entity": {
              "parent_type": "CALL_CENTER_NODE",
              "parent_sid": 0
            },
            "datetime_set_to_inactive": "1s",
            "name": "string",
            "description": "string",
            "member_constraint_rules": [
              {
                "scheduling_activity": {
                  "activity_sid": "string",
                  "member_non_skill_activity": {
                    "datetime_set_to_inactive": "1s",
                    "inherited_from_entity": {
                      "parent_type": "CALL_CENTER_NODE",
                      "parent_sid": 0
                    },
                    "name": "string",
                    "description": "string",
                    "red": 0,
                    "green": 0,
                    "blue": 0,
                    "transparency": 0,
                    "non_skill_activity_sid": 0
                  },
                  "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                  "is_skill_activity": true,
                  "reason_codes": [
                    {
                      "datetime_set_to_inactive": "1s",
                      "name": "string",
                      "is_planned": true,
                      "is_paid": true,
                      "is_default": true,
                      "reason_code_id": 0,
                      "scheduling_activity_sid": 0
                    }
                  ],
                  "scheduling_activity_sid": 0,
                  "pause_codes": [
                    "string"
                  ]
                }
              }
            ],
            "member_wfm_agents": [
              {
                "tcn_agent_sid": "string",
                "datetime_set_to_inactive": "1s",
                "created_at": "1s",
                "name": "string",
                "member_constraint_rules": [
                  {
                    "scheduling_activity": {
                      "activity_sid": "string",
                      "member_non_skill_activity": {
                        "datetime_set_to_inactive": "1s",
                        "inherited_from_entity": {
                          "parent_type": "CALL_CENTER_NODE",
                          "parent_sid": 0
                        },
                        "name": "string",
                        "description": "string",
                        "red": 0,
                        "green": 0,
                        "blue": 0,
                        "transparency": 0,
                        "non_skill_activity_sid": 0
                      },
                      "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                      "is_skill_activity": true,
                      "reason_codes": [
                        {
                          "datetime_set_to_inactive": "1s",
                          "name": "string",
                          "is_planned": true,
                          "is_paid": true,
                          "is_default": true,
                          "reason_code_id": 0,
                          "scheduling_activity_sid": 0
                        }
                      ],
                      "scheduling_activity_sid": 0,
                      "pause_codes": [
                        "string"
                      ]
                    }
                  }
                ],
                "member_skill_proficiencies": [
                  {
                    "preferred_skill_profile_sid": "string",
                    "parent_entity": {
                      "parent_type": "CALL_CENTER_NODE",
                      "parent_sid": 0
                    },
                    "manual_proficiency_value": 0,
                    "skill_name": "string",
                    "skill_profile_name": "string",
                    "skill_profile_proficiency_value": 0,
                    "skill_proficiency_sid": 0,
                    "skill_sid": 0
                  }
                ],
                "member_agent_availability_patterns": [
                  {
                    "parent_entity": {
                      "parent_type": "CALL_CENTER_NODE",
                      "parent_sid": 0
                    },
                    "datetime_pattern": {
                      "week_maps": [
                        {
                          "datetime_range": {
                            "start_datetime": "1s",
                            "end_datetime": "1s"
                          },
                          "day_maps": [
                            {}
                          ]
                        }
                      ],
                      "calendar_items": [
                        {
                          "datetime_range": {
                            "start_datetime": "1s",
                            "end_datetime": "1s"
                          },
                          "value": {
                            "availability_option": "AVAILABLE"
                          }
                        }
                      ]
                    },
                    "scheduling_activity_sid": "string",
                    "agent_availability_pattern_sid": 0,
                    "schedule_scenario_sid": 0
                  }
                ],
                "tcn_agent_is_enabled": true,
                "wfm_agent_sid": 0
              }
            ],
            "member_skill_proficiencies": [
              {
                "preferred_skill_profile_sid": "string",
                "parent_entity": {
                  "parent_type": "CALL_CENTER_NODE",
                  "parent_sid": 0
                },
                "manual_proficiency_value": 0,
                "skill_name": "string",
                "skill_profile_name": "string",
                "skill_profile_proficiency_value": 0,
                "skill_proficiency_sid": 0,
                "skill_sid": 0
              }
            ],
            "member_agent_availability_patterns": [
              {
                "parent_entity": {
                  "parent_type": "CALL_CENTER_NODE",
                  "parent_sid": 0
                },
                "datetime_pattern": {
                  "week_maps": [
                    {
                      "datetime_range": {
                        "start_datetime": "1s",
                        "end_datetime": "1s"
                      },
                      "day_maps": [
                        {
                          "day_of_week": "MON",
                          "value": {
                            "availability_option": "AVAILABLE"
                          },
                          "start_minute_in_day": 0,
                          "end_minute_in_day": 0
                        }
                      ]
                    }
                  ],
                  "calendar_items": [
                    {
                      "datetime_range": {
                        "start_datetime": "1s",
                        "end_datetime": "1s"
                      },
                      "value": {
                        "availability_option": "AVAILABLE"
                      }
                    }
                  ]
                },
                "scheduling_activity_sid": "string",
                "agent_availability_pattern_sid": 0,
                "schedule_scenario_sid": 0
              }
            ],
            "agent_group_sid": 0,
            "schedule_scenario_sid": 0
          }
        ],
        "shift_template_sid": 0,
        "program_node_sid": 0,
        "schedule_scenario_sid": 0
      },
      "is_locked": true,
      "width_in_minutes": 0,
      "shift_segments": [
        {
          "scheduling_activity": {
            "activity_sid": "string",
            "member_non_skill_activity": {
              "datetime_set_to_inactive": "1s",
              "inherited_from_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
              },
              "name": "string",
              "description": "string",
              "red": 0,
              "green": 0,
              "blue": 0,
              "transparency": 0,
              "non_skill_activity_sid": 0
            },
            "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
            "is_skill_activity": true,
            "reason_codes": [
              {
                "datetime_set_to_inactive": "1s",
                "name": "string",
                "is_planned": true,
                "is_paid": true,
                "is_default": true,
                "reason_code_id": 0,
                "scheduling_activity_sid": 0
              }
            ],
            "scheduling_activity_sid": 0,
            "pause_codes": [
              "string"
            ]
          },
          "order_in_shift_instance": 0,
          "width_in_minutes": 0,
          "start_minute_in_shift": 0,
          "call_stats_by_skill_collection": [
            {
              "skill_collection": {
                "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
                "skill_profile_category_sid": 0
              },
              "num_calls": 0,
              "percent_fit": 0
            }
          ],
          "shift_segment_sid": 0,
          "shift_instance_sid": 0,
          "scheduling_activity_sid": 0,
          "reason_code_id": 0
        }
      ],
      "planned_shrinkage_percent": 0,
      "shift_instance_sid": 0,
      "shift_template_sid": 0,
      "originating_program_node_sid": 0,
      "schedule_sid": 0,
      "wfm_agent_sid": 0
    }
  ]
}

🔴500Server Error