CopyShiftInstancesToSchedule

Copies the given @shift_instance_sids to @destination_schedule for the org sending the request.
If there are any overlap conflicts on @destination_schedule and @overlap_as_warning is set to false,
then @shift_instance_sids will not be copied, and a list of diagnostics detailing the overlaps will be returned.
If @overlap_as_warning is set to true, overlap conflicts will not prevent the shifts from being copied, and the overlap diagnostics will be returned after as warning messages instead.
This endpoint can only copy shifts to a draft schedule. To copy shifts to the published schedule use the CopyShiftsToPublishedSchedule endpoint.
Errors:

grpc.Invalid: one or more fields in the request have invalid values.

grpc.NotFound: the @shift_instance_sids or @destination_schedule does not exist for the org sending the request.

grpc.Internal: error occurs when copying the shift instances.

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 CopyShiftInstancesToSchedule RPC

destination_schedule

object (ScheduleSelector)

destination_schedule

optional

Schedule that the @shift_instance_sids will be copied into.

schedule_type

enum<string>

schedule_type

optional

Type of the schedule to select.

Allowed values:

DRAFTPUBLISHED

schedule_sid

integer <int64> | string

schedule_sid

optional

ID of the schedule to select, not needed for Published schedules.

source_schedule_type

enum<string>

source_schedule_type

optional

The type of schedule that the @shift_instance_sids are associated with.

Allowed values:

DRAFTPUBLISHED

overlap_as_warning

boolean

overlap_as_warning

optional

If set to true, overlapping shifts will be permitted, and return a warning diagnostic after persisting.
Otherwise, any overlapping shifts for agents in the @destination_schedule will return an error diagnostic and no shifts will be copied.

shift_instance_sids

array[integer <int64> | string]

shift_instance_sids

optional

IDs of the shift instances to copy into @destination_schedule.

Example

{
  "destination_schedule": {
    "schedule_type": "DRAFT",
    "schedule_sid": 0
  },
  "source_schedule_type": "DRAFT",
  "overlap_as_warning": 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 CopyShiftInstancesToSchedule RPC

diagnostics

array[object (Diagnostic) {4}]

diagnostics

optional

A list of diagnostics for any errors encountered, which prevented the copy.
If @overlap_as_warning is set to true, warning diagnostics for overlaps may be returned after a sucessful copy.

level

enum<string>

level

optional

The diagnostic level describes the class of the diagnostic message.

Allowed values:

INFORMATIONSUGGESTIONWARNINGDIAGNOSTIC_ERRORINTERNAL_ERROR

code

enum<string>

code

optional

A code to describe the diagnostic when possible. Default value of General when a more specific code is not available.

Allowed values:

GENERALOKNO_SKILLS_IN_DICTIONARYAGENT_HAS_NO_SKILL_PROFICIENCIESAGENT_HAS_NO_SKILLSNO_SCHEDULING_ACTIVITIES_FOR_CONSTRAINT_RULESSCHEDULING_ACTIVITY_FOR_CONSTRAINT_RULE_NOT_FOUNDSHIFT_TEMPLATE_CANNOT_BE_NONESHIFT_TEMPLATE_HAS_NO_PLACEMENT_RULESNO_ONCALL_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_DURATION_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_AGENTS_IN_SHIFT_TEMPLATENO_PLACEMENT_RULES_FOR_SHIFT_TEMPLATEACTIVITIES_SHORTER_THAN_SHIFTNOT_ENOUGH_AGENTS_FOR_SHIFTPROGRAM_HAS_NO_AGENT_GROUPSPROGRAM_HAS_NO_SHIFT_TEMPLATESLOCATION_HAS_NO_PROGRAMSCLIENT_HAS_NO_LOCATIONSCALL_CENTER_HAS_NO_CLIENTSPROGRAM_HAS_INVALID_PARENT_LOCATIONLOCATION_HAS_INVALID_PARENT_CLIENTCLIENT_HAS_INVALID_PARENT_CALL_CENTERAGENT_GROUP_HAS_INVALID_PARENT_NODESHIFT_TEMPLATE_HAS_INVALID_PARENT_PROGRAMNO_SKILL_PROFICIENCY_FOR_MIN_SKILL_PROFICIENCY_CONSTRAINT_RULETOO_MANY_AGENTS_WITH_LOCKED_SHIFTS_FOR_MIN_AGENTSAGENT_DOES_NOT_BELONG_TO_AN_AGENT_GROUPINVALID_CONSTRAINT_VAL_UNITSCONSTRAINT_GENERAL_FAILURECANDIDATE_SHIFT_COLLISION_DETECTEDCANDIDATE_SHIFT_AGENT_NOT_AVAILABLECANDIDATE_CLOSEDCONSTRAINT_ACTIVITY_NOT_FOUNDCONSTRAINT_AGENT_DOES_NOT_HAVE_PROFICIENCYCONSTRAINT_AGENT_PROFICIENCY_TOO_LOWCONSTRAINT_MAX_TOTAL_ON_FAILURECONSTRAINT_MIN_TOTAL_ON_FAILURECONSTRAINT_MAX_TOTAL_OFF_FAILURECONSTRAINT_MIN_TOTAL_OFF_FAILURECONSTRAINT_MAX_CONSEC_ON_FAILURECONSTRAINT_MIN_CONSEC_ON_FAILURECONSTRAINT_MAX_CONSEC_OFF_FAILURECONSTRAINT_MIN_CONSEC_OFF_FAILURECONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR_SHIFT__PER_SHIFTCONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR__PER_MINUTES_HOURSCONSTRAINT_CONSECUTIVE_SHIFTS_RULE_NOT_ALLOWEDCONSTRAINT_WITH_LARGER_PERIOD_PER_SMALL_PERIOD_NOT_ALLOWEDCONSTRAINT_MIN_MAX_OFF_TIME_FOR_SHIFTS_NOT_ALLOWEDCONSTRAINT_CANNOT_HAVE_CONSECUTIVE_TIME_PER_MULTIPLE_SHIFTSCANNOT_GENERATE_TOUR_PATTERNS_FOR_NON_TOUR_SHIFT_TEMPLATETOUR_PATTERNS_NEEDED_TO_SCHEDULE_TOURSHIFT_TEMPLATE_ACTIVITY_PLACEMENT_MIN_MAX_MUST_BE_MULTIPLE_OF_5_MINUTESNO_SHIFT_TEMPLATE_ACTIVITY_PLACEMENT_SEQUENCES_MATCH_SHIFT_MIN_MAX_WIDTHINVALID_TOUR_PATTERNINVALID_TOUR_AGENT_COLLECTIONINVALID_TOUR_SHIFT_INSTANCE_CONFIGINVALID_TOUR_SHIFT_SEGMENT_CONFIGTOUR_SHIFT_SEGMENT_CONFIG_OVERLAPTOUR_SHIFT_SEGMENT_CONFIG_DOES_NOT_FITTOUR_SHIFT_INSTANCE_CONFIG_OVERLAPWEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_WEEK_PATTERNSWFM_AGENT_SIDS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIST_WEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIRST_WEEK_PATTERN_NUMBERS_NOT_FOUND_IN_TOUR_WEEK_PATTERNSSHIFT_TEMPLATE_HAS_NO_ASSOCIATED_SCHEDULING_AGENT_GROUPSATTEMPT_TO_BUILD_SCHEDULES_FOR_INVALID_PARENT_NODESCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MINIMUMSCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MAXIMUMNO_OPEN_TIMES_SET_OR_INHERITED_BY_PROGRAMTOUR_AGENT_COLLECTIONS_NEEDED_TO_SCHEDULE_TOURNO_PREDICTED_CALLS_IN_SCHEDULING_RANGESHIFT_TEMPLATE_MIN_WIDTH_DOW_MISMATCH

source_entity

object (ParentEntity)

source_entity

optional

The entity that the diagnostic was built in reference to.

message

string

message

optional

The message detailing the diagnostic.

Example

{
  "diagnostics": [
    {
      "level": "INFORMATION",
      "code": "GENERAL",
      "source_entity": {
        "parent_type": "CALL_CENTER_NODE",
        "parent_sid": 0
      },
      "message": "string"
    }
  ]
}

🔴500Server Error