Agent Schedule Detail

Cookie: JSESSIONID={jsessionId}

Content-Type: application/json

startDate - String, format:  YYYY-MM-YY

Required: true.

Notes: cannot be after the endDate.

endDate - String, format:  YYYY-MM-YY

Required: true.

Notes: cannot be before the startDate.

outputFormat - String, supported formats: PIPE, JSON

Required: true.

Notes: is not case sensitive.

dateFormat - String, possible values: mmddyy, ddmmyy, mmddyyyy, ddmmyyyy, yyyymmdd, yyyyddmm, yyddmm, yymmdd.

If dateformat is not provided and outputFormatis set to JSON, all date fields will be converted into ISO date format.

Required: Only for PIPE outputFormat.

Notes: is not case sensitive. Determines format of output dates.

timeFormat - String, possible values: 12, 24. 

Determines format of output times.

Required: true.

Notes: is not case sensitive.

lastModifiedTime -  String, represents date inISOformat yyyy-MM-dd'T'HH:mm:ss'Z'.

If specified, filters out Time Off Rules whose date range does not overlap with the command line start/end dates. 

Required: false.

disableMidnightCutOff - Boolean field.

Required: false.

Notes:

If you set this attribute to on and any part of a schedule falls within the specified date range, the entire schedule is included in the export.

If you set this attribute to off, or omit the attribute, the agentScheduleDetail export only includes activity codes that fall within the specified date range. If a schedule crosses midnight into or out of the date range, only the part of the schedule that falls within the date range is included.

If you omit this attribute, the value defaults to off.

muIds - Array of Integers.

Should be one or more IDs user has permission to use.

Required: true.

Notes: is not case sensitive.

keepEmptyJsonFields - Boolean field.

Required: false.

Notes: This field can be set only if outputFormat is set to JSON. By default it is false. If it i set to true, the JSON output will contain empty values ({},[],"") for fields.

excludePipeHeader - Boolean field.

Required: false.

Notes: This field can be set only if outputFormat is PIPE. By default it is false. If set to true then headers will be excluded from PIPE output.

attribute - String.

Represents activity code attribute.

Required: false.

Notes: 

• If attribute is defined, the attribute value must be present in the database.
• If attribute is not defined, "EXC_EXPORT" will be considered as the default value for the attribute and if this attribute value is not present in DB, validation error "Missing default attribute value: 'EXC_EXPORT'" will be returned in the response. Otherwise, the results will be based on the default attribute.

fields - Array of objects.

Represents the list of the supported field names, fields with attribute values, and fields with specified value. All field names, attributes, and values are not case sensitive.

Required: false.

Possible values:

Simple fields when outputFormat is PIPE: 

{"name":"excDate"}, {"name":"schedDate"}, {"name":"TZ"}, {"name":"custID"}, {"name":"muID"}, {"name":"tvID"}, {"name":"acdID"}, {"name":"logonID"}, {"name":"ssn"}, {"name":"agentName"}, {"name":"modify"}, {"name":"exception"}, {"name":"start"}, {"name":"stop"}, {"name":"externalID"}

Simple fields when outputFormat is JSON: 

{"name":"excDate"}, {"name":"schedDate"}, {"name":"TZ"}, {"name":"custID"}, {"name":"muID"}, {"name":"tvID"}, {"name":"acdID"}, {"name":"logonID"}, {"name":"personalID"}, {"name":"agentName"}, {"name":"modify"}, {"name":"exception"}, {"name":"start"}, {"name":"stop"}, {"name":"externalID"}

Note: 

• In the fields array parameter, the output field ssn may be used for PIPE output.
• For JSON output, ssn must be replaced with personalID.
• Only one field with the same name can be present in the fields array.

Field with multi value:

{"name":"agentData","value":"value1"}, {"name":"agentData","value":"value2"}

Note: agentData value should exist in DB.

sortOrder - array of Objects.

Represents the list of the supported field names, fields with attribute values, and fields with specified value. All field names, attributes, and values are not case sensitive. 

Required: false.

Possible values: the same values as for fields.

Response has a unique JobId:

jobId is a 32 length string 

Example

Code: 401 Unauthorized

Error message:

https://localhost/SMARTSync/services/rs/exporters/v1/agent-schedule-detail

request body(request for all fields):

request body(request for specific fields):

https://localhost/SMARTSync/services/rs/exporters/v1/agent-schedule-detail

request body(request for all fields):

The activity code date, based on the MU’s time zone. The activity code date may be different from the schedule date, if the schedule crosses midnight.

The format of the date is specified in the dateFormat attribute. If no dateFormat attribute exists, dates are formatted as mmddyyyy.

If disableMidnightCutoff is on, this date may be 1 day before or 1 day after the command line date range due to cross-midnight schedules. If midnightCutoff is “off” or omitted, this date is within the command line date range.

The schedule date based on the MU’s time zone.

The format of the date is specified in the dateFormat parameter.

If no dateFormat is provided, then the format defaults to mmddyyyy if the outputFormat is PIPE. If the outputFormat is JSON, then dates default to ISO 8601 format. If the outputFormat is XML, the format is always a fixed XML structure.

If disableMidnightCutoff is off or omitted, this date may be 1 day before the command line date range due to cross-midnight schedules.

The MU’s time zone.

The customer ID.

The ID of the MU.

The agent’s WFM ID.

The ID of the agent’s highest-priority ACD for the associated schedule date. The highest-priority ACD is the one with the lowest priority number.

The agent’s highest-priority ACD or multimedia server logon ID for the associated schedule date. The highest-priority ACD is the one with the lowest priority number.

It is possible for this field to be blank.

The agent’s personal ID number.

For JSON output, personalId is used instead

This field is blank if no personal ID number is assigned to the agent.

This multi-value field exports the value(s) assigned to the agent for each agent data group specified in the "value" attribute of the agentData field.

You can include as many agentData elements as you want; one agent data group is printed in the output file for each agentData value defined.

You can specify the same agent data group more than once.

If you do not include an agentDataelement, this field is omitted.

This field may be blank if the agent is not assigned a value for the specified agent data group for the date being processed

Note: The Agent Schedule Detail output does not support simplified Chinese characters in this field. When defining agent data values, do not use simplified Chinese characters.

The agent’s name, formatted as <last>, <first><suffix>.

The schedule record’s modify timestamp.

The activity code attribute value assigned to the activity code, as specified in the attribute parameter .

If no value is assigned to the activity code for the activity code attribute, the activity code is not included in the export.

If multiple activity codes with the same activity code attribute value exist contiguously, they are exported as a single exception, with the appropriate start and stop times subject to the cross-midnight note below.

If an activity code crosses midnight, it is divided into two records at midnight if you do not use the disableMidnightCutoff attribute or set it to off. If you set the disableMidnightCutoff attribute to on, the cross-midnight schedule is kept intact as stored in NICE WFM.

The start time of the activity code, based on the MU’s time zone.

The format of the start time is specified in the timeFormat attribute. If no timeFormat attribute exists, 24-hour format (HH:MM) is used.

The end time of the activity code, based on the MU’s time zone.

The stop is the clock stop time, and therefore excludes the stop minute. For example, if a Lunch activity exists at noon for one hour, the stop time is 1:00pm, not 12:59pm. There are two records: [first record] |LUNCH|1200|1300, [second record]: OPEN|1300|1500. The actual 1300 clock minute is included in the second record.

The format of the stop time is specified in the timeFormat parameter. If no timeFormat parameter exists, 24-hour format (HH:MM) is used.

The ID the agent uses to log in to the Agent WebStation if the WebStation is configured to use external IDs.

If the agent's externalID field is blank, this field is blank.