Alvaria™ Cloud Workforce Updates REST API v3.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The Alvaria™ Cloud Workforce Updates REST APIs enable developers to create applications that retrieves, creates, and updates to some of the Alvaria™ Cloud Workforce entities. The read-only endpoints give access to Alvaria™ Cloud Workforce admin current time, staff groups, and IDPs. The create endpoints give access to Alvaria™ Cloud Workforce request segments and segments. The update endpoint give access to Alvaria™ Cloud Workforce segments.
Base URLs:
License: License: Creative Commons Attribution 4.0 International Public License
Authentication
-
oAuth2 authentication.
- Flow: client crendentials
- Authorization URL = https://myaspect.{region}.id.aspect-cloud.net/tokenservice/oauth2/access_token
| Scope | Scope Description |
|---|---|
| workforceapi.updates | access Via® Workforce resources |
AdminCurrentTime
Retrieves WFM current system time
Code samples
# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/adminCurrentTime \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/adminCurrentTime',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/adminCurrentTime HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: Bearer
x-api-key: string
GET /via/v3/organizations/{orgId}/workforce/adminCurrentTime
Retrieves Alvaria™ Cloud Workforce system times. A timestamp of the current system time reported by database. The request server local system time. The current time expressed as UTC. The timezone for the Alvaria™ Cloud Workforce database. The timezone for the Alvaria™ Cloud Workforce request server. Also, current time expressed in timezone(s) specified in the request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
Example responses
200 Response
{
"kind": "via#workforceAdminCurrentTimeResponse",
"currentTimeResponse": {
"kind": "via#workforceCurrentTimeResponse",
"timeStamp": {
"kind": "via#workforceCurrentTimeResponseTimeStamp",
"dateTime": "2010-12-31T13:18:35Z",
"moment": 12345678
},
"localSystem": {
"kind": "via#workforceCurrentTimeResponseLocalSystem",
"dateTime": "2006-09-06T15:24:37.294"
},
"utc": {
"kind": "via#workforceCurrentTimeResponseUTC",
"dateTime": "2006-09-06T20:24:37.000Z"
},
"databaseTimeZone": {
"kind": "via#workforceCurrentTimeResponseDatabaseTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
},
"systemTimeZone": {
"kind": "via#workforceCurrentTimeResponseSystemTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AdminCurrentTimeResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
CheckerRequests
Retrieves a list of segment requests
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"employeeSelector": {
"employeeIds": [
"-992147482601",
"-992147482602"
],
"employeeIdentifiers": [
"string"
],
"employeeNames": [
"string"
],
"employeeFilter": {
"employeeGroupFilter": {
"employeeGroupIds": [
"-992147482601",
"-992147482602"
]
},
"hireDateFilter": {},
"termDateFilter": {},
"extraFieldFilter": {
"operator": "EqualTo",
"value": "EMP001",
"extraFieldId": "2387932847"
},
"skillFilter": {
"priorityRange": {
"minimum": 1,
"maximum": 1
},
"priorityFrom": 1,
"priorityTo": 1,
"skillId": "1489356"
},
"segmentFilter": {
"start": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"stop": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"duration": {
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
},
"segmentDefinitionId": "66898"
}
},
"respectFilterProfile": true,
"hideInactiveEmployees": true
},
"requestStatus": "OPEN",
"scorecardStatus": "PASS",
"checkerRuleId": "-992147482601",
"dateRange": {},
"createdOnDateRange": {}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/search',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/search HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/checkerRequests/search
Retrieves a list of basic segment requests that matches the specified selector. The selection criteria are logically ANDed together. The selector can, but not require, an employee selector, request status, scorecard status, date range of the request, the creation date range of the request, the flag of ready to process, and/or checker rule SK. Filtering segment requests by CheckerRule SK is possible only if one or more ScorecardStatus elements are present. This is because every request has all CheckerRule SKs listed in its scorecard. Because of this, filtering only makes sense if a CheckerRule and ScorecardStatus are specified. If successful, a 202 response, with a searchId, will be received. Use the searchId with the GET /via/v3/organizations/{orgId}/workforce/checkerRequests/search, to retrieve cached results.
Body parameter
{
"employeeSelector": {
"employeeIds": [
"-992147482601",
"-992147482602"
],
"employeeIdentifiers": [
"string"
],
"employeeNames": [
"string"
],
"employeeFilter": {
"employeeGroupFilter": {
"employeeGroupIds": [
"-992147482601",
"-992147482602"
]
},
"hireDateFilter": {},
"termDateFilter": {},
"extraFieldFilter": {
"operator": "EqualTo",
"value": "EMP001",
"extraFieldId": "2387932847"
},
"skillFilter": {
"priorityRange": {
"minimum": 1,
"maximum": 1
},
"priorityFrom": 1,
"priorityTo": 1,
"skillId": "1489356"
},
"segmentFilter": {
"start": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"stop": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"duration": {
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
},
"segmentDefinitionId": "66898"
}
},
"respectFilterProfile": true,
"hideInactiveEmployees": true
},
"requestStatus": "OPEN",
"scorecardStatus": "PASS",
"checkerRuleId": "-992147482601",
"dateRange": {},
"createdOnDateRange": {}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | RequestLookupSelector | true | Describes the segment requests to retrieve |
Example responses
200 Response
{
"kind": "via#workforceSegmentRequestsCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"segmentRequests": [
{
"kind": "via#workforceSegmentRequest",
"id": "-1924365234643",
"employee": {
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
},
"user": {
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
},
"status": "OPEN",
"creationTime": "2010-12-31T13:18:35Z",
"sequence": 1,
"source": "source",
"requiresChecking": false,
"readyToProcess": false,
"evaluationCount": 1,
"isValidSegment": false,
"priority": 1,
"rank": 1,
"effectiveCreationTime": "2010-12-31T13:18:35Z",
"effectiveSequence": 1,
"processingStartedTime": "010-12-31T13:18:35.0000000+00:00",
"memo": "memo",
"summaryMemo": "summaryMemo",
"scorecards": [
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
],
"segments": {
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
},
"datesAffected": [
"2019-08-24T14:15:22Z"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SegmentRequestsCollection |
| 202 | Accepted | Success | SegmentRequestListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieve the requested list of segment requests
Code samples
# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/search?searchId=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/search?searchId=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/search?searchId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: Bearer
x-api-key: string
GET /via/v3/organizations/{orgId}/workforce/checkerRequests/search
Retrieves the cached list of basic segment requests that matches the searchId from the original POST /via/v3/organizations/{orgId}/workforce/checkerRequests/search. The start index (default: 0) and max results (default: 500) are optional and used for pagination of the cached data. If the max results is larger than the system max results, the system max results (500) will override the supplied max results.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| searchId | query | string | true | The searchId provided from the original request's response |
| startIndex | query | integer(int32) | false | Index of the starting record. This is used to set the beginning record for the result set when multiple GET Collection requests are required due to the pagination of a large result set. (default: 0) |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
Example responses
200 Response
{
"kind": "via#workforceSegmentRequestsCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"segmentRequests": [
{
"kind": "via#workforceSegmentRequest",
"id": "-1924365234643",
"employee": {
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
},
"user": {
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
},
"status": "OPEN",
"creationTime": "2010-12-31T13:18:35Z",
"sequence": 1,
"source": "source",
"requiresChecking": false,
"readyToProcess": false,
"evaluationCount": 1,
"isValidSegment": false,
"priority": 1,
"rank": 1,
"effectiveCreationTime": "2010-12-31T13:18:35Z",
"effectiveSequence": 1,
"processingStartedTime": "010-12-31T13:18:35.0000000+00:00",
"memo": "memo",
"summaryMemo": "summaryMemo",
"scorecards": [
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
],
"segments": {
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
},
"datesAffected": [
"2019-08-24T14:15:22Z"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SegmentRequestsCollection |
| 202 | Accepted | Success | SegmentRequestListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieves a list of detail segment requests
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/details/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"segmentRequestIds": [
"string"
],
"includeMemo": false,
"includeSegments": false,
"includeScorecard": false,
"includeSummaryMemo": false,
"includeQueuePosition": false,
"includeAffectedDates": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/details/search',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/details/search HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/checkerRequests/details/search
Retrieves a list of segment request's details that matches the specified selector. The selector can, but not require, be a list of segment request's id. There are flags to include segment request's memo, segments, scorecard, summary memo, queue position, and affected dates as part of the segment details response. If successful, a 202 response, with a searchId, will be received. Use the searchId with the GET /via/v3/organizations/{orgId}/workforce/checkerRequests/details/search, to retrieve cached results.
Body parameter
{
"segmentRequestIds": [
"string"
],
"includeMemo": false,
"includeSegments": false,
"includeScorecard": false,
"includeSummaryMemo": false,
"includeQueuePosition": false,
"includeAffectedDates": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | SegmentRequestDetailsSelector | true | Describes the segment request's details to retrieve |
Example responses
200 Response
{
"kind": "via#workforceSegmentRequestsCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"segmentRequests": [
{
"kind": "via#workforceSegmentRequest",
"id": "-1924365234643",
"employee": {
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
},
"user": {
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
},
"status": "OPEN",
"creationTime": "2010-12-31T13:18:35Z",
"sequence": 1,
"source": "source",
"requiresChecking": false,
"readyToProcess": false,
"evaluationCount": 1,
"isValidSegment": false,
"priority": 1,
"rank": 1,
"effectiveCreationTime": "2010-12-31T13:18:35Z",
"effectiveSequence": 1,
"processingStartedTime": "010-12-31T13:18:35.0000000+00:00",
"memo": "memo",
"summaryMemo": "summaryMemo",
"scorecards": [
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
],
"segments": {
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
},
"datesAffected": [
"2019-08-24T14:15:22Z"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SegmentRequestsCollection |
| 202 | Accepted | Success | SegmentRequestListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieve the requested list of detail segment requests
Code samples
# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/details/search?searchId=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/details/search?searchId=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/checkerRequests/details/search?searchId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: Bearer
x-api-key: string
GET /via/v3/organizations/{orgId}/workforce/checkerRequests/details/search
Retrieves the cached list of segment request's details that matches the searchId from the original POST /via/v3/organizations/{orgId}/workforce/checkerRequests/details/search. The start index (default: 0) and max results (default: 500) are optional and used for pagination of the cached data. If the max results is larger than the system max results, the system max results (500) will override the supplied max results.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| searchId | query | string | true | The searchId provided from the original request's response |
| startIndex | query | integer(int32) | false | Index of the starting record. This is used to set the beginning record for the result set when multiple GET Collection requests are required due to the pagination of a large result set. (default: 0) |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
Example responses
200 Response
{
"kind": "via#workforceSegmentRequestsCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"segmentRequests": [
{
"kind": "via#workforceSegmentRequest",
"id": "-1924365234643",
"employee": {
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
},
"user": {
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
},
"status": "OPEN",
"creationTime": "2010-12-31T13:18:35Z",
"sequence": 1,
"source": "source",
"requiresChecking": false,
"readyToProcess": false,
"evaluationCount": 1,
"isValidSegment": false,
"priority": 1,
"rank": 1,
"effectiveCreationTime": "2010-12-31T13:18:35Z",
"effectiveSequence": 1,
"processingStartedTime": "010-12-31T13:18:35.0000000+00:00",
"memo": "memo",
"summaryMemo": "summaryMemo",
"scorecards": [
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
],
"segments": {
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
},
"datesAffected": [
"2019-08-24T14:15:22Z"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SegmentRequestsCollection |
| 202 | Accepted | Success | SegmentRequestListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
IDPs
Retrieves a list of staff groups
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/staffGroup/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"code": "SALES",
"partialCode": "SAL",
"staffGroupId": "-992147482601"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/staffGroup/search',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/staffGroup/search HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/idp/staffGroup/search
Retrieves a list of detailed information about staff groups that matches the specified selector. The selection criteria are logically ORed together. The selector can, but not require, have the staff group code, partial staff group code name, and/or staff group's id. If successful, a 202 response, with a searchId, will be received. Use the searchId with the GET /via/v3/organizations/{orgId}/workforce/idp/staffGroup/search, to retrieve cached results.
Body parameter
{
"code": "SALES",
"partialCode": "SAL",
"staffGroupId": "-992147482601"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | StaffGroupLookupSelector | true | Describes the staff groups to retrieve |
Example responses
200 Response
{
"kind": "via#workforceStaffGroupCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"staffGroup": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | StaffGroupCollection |
| 202 | Accepted | Success | StaffGroupListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieve the requested list of staff groups
Code samples
# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/staffGroup/search?searchId=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/staffGroup/search?searchId=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/staffGroup/search?searchId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: Bearer
x-api-key: string
GET /via/v3/organizations/{orgId}/workforce/idp/staffGroup/search
Retrieves the list of cached detailed information about staff groups that matches the searchId from the original POST /via/v3/organizations/{orgId}/workforce/idp/staffGroup/search. The start index (default: 0) and max results (default: 500) are optional and used for pagination of the cached data. If the max results is larger than the system max results, the system max results (500) will override the supplied max results.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| searchId | query | string | true | The searchId provided from the original request's response |
| startIndex | query | integer(int32) | false | Index of the starting record. This is used to set the beginning record for the result set when multiple GET Collection requests are required due to the pagination of a large result set. (default: 0) |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
Example responses
200 Response
{
"kind": "via#workforceStaffGroupCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"staffGroup": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | StaffGroupCollection |
| 202 | Accepted | Success | StaffGroupListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieves a list of IDPs
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"dateTimeRange": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"forecastGroupId": "-992147482601",
"routingSetId": "-992147482601",
"staffGroupId": "-992147482601"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/search',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/search HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/idp/search
Retrieves a list of IDP forecasts that matches the specified selector. The selection criteria are logically ORed together. The selector can, but not require, have a staff group's id, forecast group's id, routing set's id, and/or date range of the idps. If successful, a 202 response, with a searchId, will be received. Use the searchId with the GET /via/v3/organizations/{orgId}/workforce/idp/search, to retrieve cached results.
Body parameter
{
"dateTimeRange": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"forecastGroupId": "-992147482601",
"routingSetId": "-992147482601",
"staffGroupId": "-992147482601"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | IDPLookupSelector | true | Describes the IDPs to retrieve |
Example responses
200 Response
{
"kind": "via#workforceIDPCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"idps": [
{
"kind": "via#workforceIDP",
"id": "-1924365234643",
"creationTime": "2010-12-31T13:18:35Z",
"createdBy": "SCHLACTER",
"startTime": "2003-01-05T00:00:00",
"stopTime": "2003-01-05T00:00:00",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastGroups": [
{
"kind": "via#workforceIDPFGTreeType",
"code": "CSV",
"idpFgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{}
],
"staffGroups": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IDPCollection |
| 202 | Accepted | Success | IDPListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieve the requested list of IDPs
Code samples
# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/search?searchId=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/search?searchId=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/search?searchId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: Bearer
x-api-key: string
GET /via/v3/organizations/{orgId}/workforce/idp/search
Retrieves the cached list of IDP forecasts that matches the searchId from the original POST /via/v3/organizations/{orgId}/workforce/idp/search. The start index (default: 0) and max results (default: 500) are optional and used for pagination of the cached data. If the max results is larger than the system max results, the system max results (500) will override the supplied max results.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| searchId | query | string | true | The searchId provided from the original request's response |
| startIndex | query | integer(int32) | false | Index of the starting record. This is used to set the beginning record for the result set when multiple GET Collection requests are required due to the pagination of a large result set. (default: 0) |
| maxResults | query | integer(int32) | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. (default: 500) |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
Example responses
200 Response
{
"kind": "via#workforceIDPCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"idps": [
{
"kind": "via#workforceIDP",
"id": "-1924365234643",
"creationTime": "2010-12-31T13:18:35Z",
"createdBy": "SCHLACTER",
"startTime": "2003-01-05T00:00:00",
"stopTime": "2003-01-05T00:00:00",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastGroups": [
{
"kind": "via#workforceIDPFGTreeType",
"code": "CSV",
"idpFgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{}
],
"staffGroups": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
]
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IDPCollection |
| 202 | Accepted | Success | IDPListBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Request for IDP Details
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/details/search \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"idpId": "-9921474826",
"forecastGroup": {
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
},
"staffGroup": {
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
},
"consolidation": {
"staffGroups": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
},
"multiSkill": {
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"basis": "Original",
"adjustments": false
},
"includeProperties": false,
"includeOpenHours": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/details/search',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/details/search HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/idp/details/search
Retrieves detailed information about IDP forecasts that matches the specified selector. The selection criteria requires IDP's id. Selector can also have, but not require, a forecast group with elements, a staff group with elements, and/or consolidation of forecast group and staff group with their elements that would be returned back in the response. If successful, a 202 response, with a searchId, will be received. Use the searchId with the GET /via/v3/organizations/{orgId}/workforce/idp/search, to retrieve cached results.
Body parameter
{
"idpId": "-9921474826",
"forecastGroup": {
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
},
"staffGroup": {
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
},
"consolidation": {
"staffGroups": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
},
"multiSkill": {
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"basis": "Original",
"adjustments": false
},
"includeProperties": false,
"includeOpenHours": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | IDPDetailsSelector | true | Describes the IDP details to retrieve |
Example responses
200 Response
{
"kind": "via#workforceIDPDetailsResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"idpDetails": {
"kind": "via#workforceIDPType",
"idpDescription": "CSV 1/10/2003",
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastUnit": 30,
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"staffGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"consolidation": {
"kind": "via#workforceIDPTypeConsolidation",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
},
"id": "-1924365234643",
"action": "Delete",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IDPDetailsResponse |
| 202 | Accepted | Success | IDPTypeBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Retrieve the requested IDP Details
Code samples
# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/details/search?searchId=string \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/details/search?searchId=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/idp/details/search?searchId=string HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: Bearer
x-api-key: string
GET /via/v3/organizations/{orgId}/workforce/idp/details/search
Retrieves cached detailed information about IDP forecasts that matches the searchId from the original POST /via/v3/organizations/{orgId}/workforce/idp/details/search. The start index (default: 0) and max results (default: 500) are optional and used for pagination of the cached data. If the max results is larger than the system max results, the system max results (500) will override the supplied max results.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| searchId | query | string | true | The searchId provided from the original request's response |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
Example responses
200 Response
{
"kind": "via#workforceIDPDetailsResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"idpDetails": {
"kind": "via#workforceIDPType",
"idpDescription": "CSV 1/10/2003",
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastUnit": 30,
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"staffGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"consolidation": {
"kind": "via#workforceIDPTypeConsolidation",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
},
"id": "-1924365234643",
"action": "Delete",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | IDPDetailsResponse |
| 202 | Accepted | Success | IDPTypeBaseResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Segments
Create segments
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"saveAsRequest": false,
"segments": [
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/segments
Create segments directly to the schedule or as requests. The segment has the following required elements: employee's id, segment's nominal date, segment's code, segment's start time (only for detail segment), segment's stop time (only for detail segment), segment's type, and segment's memo. The saveAsRequest flag tells the service to make it an official segment on the employee's schedule or to make a segment request to be approved.
Body parameter
{
"saveAsRequest": false,
"segments": [
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | CreateSegmentsSelector | true | Describes the schedule segment/segment request to create |
Example responses
200 Response
{
"kind": "via#workforceSavedResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady",
"saved": {
"kind": "via#workforceSaved"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SavedResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Update segments
Code samples
# You can also use wget
curl -X PUT https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"saveAsRequest": false,
"updateSegments": [
{
"currentSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
},
"updateSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
PUT https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
PUT /via/v3/organizations/{orgId}/workforce/segments
Updates existing official schedule segments. Each of the updates will require the current segment and the update segment. The current segment is the existing official schedule segment that will be updated. To get the current official schedule segment use POST /via/v2/organizations/{orgId}/workforce/search/segments. If the current segment provided doesn't match the current version on the database, the service will provide an error explaining it. The updating segment is the updated version you want the existing one to be. Every property needs to be supplied, even if that value isn't changing. The saveAsRequest flag tells the service to make the update directly to the official segment or to make a segment request to update the current official segment for approval of the update.
Body parameter
{
"saveAsRequest": false,
"updateSegments": [
{
"currentSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
},
"updateSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | UpdateSegmentSelector | true | Describes the existing official schedule segment to update. The CurrentSegment is the one that currently exist that you would like to update and the UpdateSegment is the updated version you want the existing one to be. Every property needs to be supplied, even if that value isn't changing. |
Example responses
200 Response
{
"kind": "via#workforceSavedResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady",
"saved": {
"kind": "via#workforceSaved"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SavedResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Delete segments
Code samples
# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments/delete \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const inputBody = {
"saveAsRequest": false,
"segments": [
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer ',
'x-api-key':'string'
};
fetch('https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments/delete',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST https://orgId.via.aspect-cloud.net/via/v3/organizations/{orgId}/workforce/segments/delete HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: Bearer
x-api-key: string
POST /via/v3/organizations/{orgId}/workforce/segments/delete
Delete segments directly from the schedule or as requests. The segment has the following required elements: employee's id, segment's nominal date, segment's code, segment's start time (only for detail segment), segment's stop time (only for detail segment), segment's type, and segment's memo. The saveAsRequest flag tells the service to make it an official segment on the employee's schedule or to make a segment request to be approved.
Body parameter
{
"saveAsRequest": false,
"segments": [
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | Name of a customer organization |
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint. |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| body | body | DeleteSegmentsSelector | true | Describes the schedule segment/segment request to delete |
Example responses
200 Response
{
"kind": "via#workforceSavedResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady",
"saved": {
"kind": "via#workforceSaved"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SavedResponse |
| 400 | Bad Request | Bad Request | ErrorResponse |
| 405 | Method Not Allowed | Method Not Allowed | ErrorResponse |
| 408 | Request Timeout | Request Timeout | ErrorResponse |
| 415 | Unsupported Media Type | Client Error | ErrorResponse |
| 416 | Range Not Satisfiable | Client Error | ErrorResponse |
| 500 | Internal Server Error | Server Error | ErrorResponse |
Schemas
AcdLogin
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
Definition of an Employee ACD Login record
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| login | string | false | none | Code or other identifier that the Employee uses to log in to the ACD |
| acdInstanceId | string | false | none | Alvaria-generated unique identifier for the acd instance |
| group | string | false | none | Code or other identifier of the ACD group that this employee logs in to on the ACD. This is used by the Agent Productivity feature. |
AdminCurrentTimeResponse
{
"kind": "via#workforceAdminCurrentTimeResponse",
"currentTimeResponse": {
"kind": "via#workforceCurrentTimeResponse",
"timeStamp": {
"kind": "via#workforceCurrentTimeResponseTimeStamp",
"dateTime": "2010-12-31T13:18:35Z",
"moment": 12345678
},
"localSystem": {
"kind": "via#workforceCurrentTimeResponseLocalSystem",
"dateTime": "2006-09-06T15:24:37.294"
},
"utc": {
"kind": "via#workforceCurrentTimeResponseUTC",
"dateTime": "2006-09-06T20:24:37.000Z"
},
"databaseTimeZone": {
"kind": "via#workforceCurrentTimeResponseDatabaseTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
},
"systemTimeZone": {
"kind": "via#workforceCurrentTimeResponseSystemTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| currentTimeResponse | CurrentTimeResponse | false | none | none |
CreateSegmentsSelector
{
"saveAsRequest": false,
"segments": [
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
]
}
Definition for creating/updating a schedule segment or request segment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| saveAsRequest | boolean | false | none | Save as request segment. |
| segments | [Segment] | false | none | Segments to be created |
CurrentTimeResponse
{
"kind": "via#workforceCurrentTimeResponse",
"timeStamp": {
"kind": "via#workforceCurrentTimeResponseTimeStamp",
"dateTime": "2010-12-31T13:18:35Z",
"moment": 12345678
},
"localSystem": {
"kind": "via#workforceCurrentTimeResponseLocalSystem",
"dateTime": "2006-09-06T15:24:37.294"
},
"utc": {
"kind": "via#workforceCurrentTimeResponseUTC",
"dateTime": "2006-09-06T20:24:37.000Z"
},
"databaseTimeZone": {
"kind": "via#workforceCurrentTimeResponseDatabaseTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
},
"systemTimeZone": {
"kind": "via#workforceCurrentTimeResponseSystemTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| timeStamp | CurrentTimeResponseTimeStamp | false | none | none |
| localSystem | CurrentTimeResponseLocalSystem | false | none | none |
| utc | CurrentTimeResponseUTC | false | none | none |
| databaseTimeZone | CurrentTimeResponseDatabaseTimeZone | false | none | none |
| systemTimeZone | CurrentTimeResponseSystemTimeZone | false | none | none |
CurrentTimeResponseDatabaseTimeZone
{
"kind": "via#workforceCurrentTimeResponseDatabaseTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| dateTime | string(date-time) | false | none | Current time expressed in the timezone specified as the database timezone. |
| id | string | false | none | Alvaria-generated unique identifier for the time zone. |
CurrentTimeResponseLocalSystem
{
"kind": "via#workforceCurrentTimeResponseLocalSystem",
"dateTime": "2006-09-06T15:24:37.294"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| dateTime | string(date-time) | false | none | Local system time of the server handling the request. |
CurrentTimeResponseSystemTimeZone
{
"kind": "via#workforceCurrentTimeResponseSystemTimeZone",
"dateTime": "2006-09-06T15:24:37.000-05:00",
"id": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| dateTime | string(date-time) | false | none | none |
| id | string | false | none | Alvaria-generated unique identifier for the current time response system time zone. |
CurrentTimeResponseTimeStamp
{
"kind": "via#workforceCurrentTimeResponseTimeStamp",
"dateTime": "2010-12-31T13:18:35Z",
"moment": 12345678
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| dateTime | string(date-time) | false | none | Current system time as reported by the database, expressed as a timestamp. |
| moment | integer(int64) | false | none | Timestamp value converted to a moment. |
CurrentTimeResponseUTC
{
"kind": "via#workforceCurrentTimeResponseUTC",
"dateTime": "2006-09-06T20:24:37.000Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| dateTime | string(date-time) | false | none | Current time expressed in UTC. |
DateRange
{}
Range of dates. Dates greater than or equal to the StartDate and less than or equal to the StopDate are considered within the range.
Properties
None
DateTimeRange
{
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
}
Range of dates and times. A time greater than or equal to StartDateTime and less than (but not equal to) StopDateTime are considered within the range.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startDateTime | string(date-time) | false | none | Start time of the range |
| stopDateTime | string(date-time) | false | none | Start date of the range |
DeleteSegmentsSelector
{
"saveAsRequest": false,
"segments": [
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
]
}
Definition for deleting a schedule segment or request segment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| saveAsRequest | boolean | false | none | Save as request segment. |
| segments | [Segment] | false | none | Segments to be deleted |
DurationRange
{
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
}
Range of durations. Durations greater than or equal to MinimumDuration and less than or equal to MaximumDuration are considered within the range.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| minimumDuration | string | false | none | Minimum duration in the range |
| maximumDuration | string | false | none | Maximum duration in the range |
ElementType
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| value | [ElementTypeValue] | false | none | The values for the element. |
| elementSummary | number(double) | false | none | The summary for the element. |
| elementId | string | false | none | Alvaria-generated unique identifier for the elementId. |
| dataType | string | false | none | The data type for the element. |
| min | number(double) | false | none | The minimum for the element. |
| max | number(double) | false | none | The maximum for the element. |
| maxDecimals | integer(int32) | false | none | The maximum number of decimal places for the element. |
| readOnly | boolean | false | none | Is the element read only. |
Enumerated Values
| Property | Value |
|---|---|
| dataType | Float |
| dataType | String |
| dataType | Boolean |
ElementTypeValue
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| index | integer(int32) | false | none | The index of the element value |
| threshold | string | false | none | The threshold of the element value |
| color | integer(int32) | false | none | The color of the element value |
| fontColor | integer(int32) | false | none | The font color of the element value |
| value | string | false | none | The value of the element value |
Employee
{
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
}
Workforce Management Employee definition
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| id | string | false | none | Alvaria-generated unique identifier for the employee |
| employeeIdentifier | string | false | none | Unique, human-readable identification code for this Employee. The maximum length is 10. |
| lastName | string | false | none | Employee last name |
| firstName | string | false | none | Employee first name |
| shortName | string | false | none | Shorter version of the employee Name |
| sortName | string | false | none | Alternative representation of the Employee name that can be used for sorting purposes |
| lastModifiedTime | string(date-time) | false | none | Timestamp that indicates when this entity was last modified |
| lastModifiedBy | string | false | none | Alvaria-generated unique identifier for the user who last modified this entity |
| active | boolean | false | none | Indicates whether an Employee is Active |
| timeZoneId | string | false | none | Alvaria-generated unique identifier for the time zone associated with this employee.The definition for this time zone can be retrieved with the via/v2/organizations/{orgId}/workforce/timeZones endpoint. |
| seniority | string | false | none | Employee ranking, up to 12 characters, to use for operations in which Employees are processed sequentially, such as automatic assignment and preference-based scheduling. These values default to the employee record creation date in the format yyyymmdd000, where yyyymmdd is the numeric hire date (year, month, and day). A part, or all, of this value can be modified when creating a user. |
| emailAddress | string | false | none | Employee email address |
| instantMessageAddress | string | false | none | Employee Instant Message address |
| memo | string | false | none | Additional text associated with the Employee |
| extraFields | [ExtraFieldValue] | false | none | List of Extra Field values associated with the Employee |
| skills | [EmployeeSkillAssociation] | false | none | List of Skills associated with the Employee |
| employeeGroups | [EmployeeGroupAssignment] | false | none | List of Employee Groups to which the Employee is assigned |
| acdLogins | [AcdLogin] | false | none | List of the Employee ACD Logins |
EmployeeFilter
{
"employeeGroupFilter": {
"employeeGroupIds": [
"-992147482601",
"-992147482602"
]
},
"hireDateFilter": {},
"termDateFilter": {},
"extraFieldFilter": {
"operator": "EqualTo",
"value": "EMP001",
"extraFieldId": "2387932847"
},
"skillFilter": {
"priorityRange": {
"minimum": 1,
"maximum": 1
},
"priorityFrom": 1,
"priorityTo": 1,
"skillId": "1489356"
},
"segmentFilter": {
"start": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"stop": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"duration": {
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
},
"segmentDefinitionId": "66898"
}
}
Standard used for filtering employees. The Employee Filter allows filtering of employees by Employee Groups, hire date, termination date, extra field, skill, and segment. Employee filter criteria is combined together by using the AND operator to determine which employees match all filter criteria.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| employeeGroupFilter | EmployeeFilterEmployeeGroupFilter | false | none | Employee Filter criteria of Employee Group IDs and Date to determine which employees match the work an employee can perform |
| hireDateFilter | DateRange | false | none | Range of dates. Dates greater than or equal to the StartDate and less than or equal to the StopDate are considered within the range. |
| termDateFilter | DateRange | false | none | Range of dates. Dates greater than or equal to the StartDate and less than or equal to the StopDate are considered within the range. |
| extraFieldFilter | ExtraFieldComparison | false | none | Extra field comparison which can be used to filter data associated with extra fields. The comparison uses the following three properties together: ExtraFieldId - the specific extra field Value - the value to compare Operator - the definition of how to compare the specific extra field value NOTE: If ALL three are not supplied the resulting behavior is undefined. The following table shows each of the extra field data types and the comparison operators supported for that type - if it is not supported, the resulting behavior is undefined. For operators "EqualTo" and "NotEqualTo": DataType Valid Values -------- ------------ String Any string Boolean "true", "false", 1, or 0 For all operators ("LessThan", "LessThanEqualTo", "EqualTo", "NotEqualTo", "GreaterThanEqualTo", "GreaterThan"): DataType Valid Values -------- ------------ Integer Any number with no decimals Float Any number, with or without decimals Date A string in the format yyyy-mm-dd Time A string in the format hh:mm[:ss] DateTime A string in the format yyyy-mm-dd[Thh:mm[:ss][Z |
| skillFilter | EmployeeFilterSkillFilter | false | none | Employee Filter criteria based on a specific Employee Skill ID, date, and priority range |
| segmentFilter | EmployeeFilterSegmentFilter | false | none | Employee Filter criteria based on a specific Segment ID, Segment start date range, Segment stop date range, and Segment duration |
EmployeeFilterEmployeeGroupFilter
{
"employeeGroupIds": [
"-992147482601",
"-992147482602"
]
}
Employee Filter criteria of Employee Group IDs and Date to determine which employees match the work an employee can perform
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| employeeGroupIds | [string] | false | none | Alvaria-generated unique identifier for the employee groups |
EmployeeFilterSegmentFilter
{
"start": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"stop": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"duration": {
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
},
"segmentDefinitionId": "66898"
}
Employee Filter criteria based on a specific Segment ID, Segment start date range, Segment stop date range, and Segment duration
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| start | DateTimeRange | false | none | Range of dates and times. A time greater than or equal to StartDateTime and less than (but not equal to) StopDateTime are considered within the range. |
| stop | DateTimeRange | false | none | Range of dates and times. A time greater than or equal to StartDateTime and less than (but not equal to) StopDateTime are considered within the range. |
| duration | DurationRange | false | none | Range of durations. Durations greater than or equal to MinimumDuration and less than or equal to MaximumDuration are considered within the range. |
| segmentDefinitionId | string | false | none | Alvaria-generated unique identifier for the SegmentDefinition |
EmployeeFilterSkillFilter
{
"priorityRange": {
"minimum": 1,
"maximum": 1
},
"priorityFrom": 1,
"priorityTo": 1,
"skillId": "1489356"
}
Employee Filter criteria based on a specific Employee Skill ID, date, and priority range
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| priorityRange | IntegerRange | false | none | Range of integer values. Integers greater than or equal to Minimum and less than or equal to Maximum are considered within the range. |
| priorityFrom | integer(int32) | false | none | If specified only skill assignments with a priority between PriorityFrom and PriorityTo will be selected. |
| priorityTo | integer(int32) | false | none | If specified only skill assignments with a priority between PriorityFrom and PriorityTo will be selected. |
| skillId | string | false | none | Alvaria-generated unique identifier for the SkillId |
EmployeeGroupAssignment
{
"employeeGroupId": "975444541",
"leader": false
}
Employee assignment to an Employee Group
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| employeeGroupId | string | false | none | Alvaria-generated unique identifier for the EmployeeGroupId |
| leader | boolean | false | none | Whether an employee is a Leader in the Employee Group |
EmployeeSelector
{
"employeeIds": [
"-992147482601",
"-992147482602"
],
"employeeIdentifiers": [
"string"
],
"employeeNames": [
"string"
],
"employeeFilter": {
"employeeGroupFilter": {
"employeeGroupIds": [
"-992147482601",
"-992147482602"
]
},
"hireDateFilter": {},
"termDateFilter": {},
"extraFieldFilter": {
"operator": "EqualTo",
"value": "EMP001",
"extraFieldId": "2387932847"
},
"skillFilter": {
"priorityRange": {
"minimum": 1,
"maximum": 1
},
"priorityFrom": 1,
"priorityTo": 1,
"skillId": "1489356"
},
"segmentFilter": {
"start": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"stop": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"duration": {
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
},
"segmentDefinitionId": "66898"
}
},
"respectFilterProfile": true,
"hideInactiveEmployees": true
}
Selects employees by name, ID, employee identifier, or by a complex filter. Employees are selected by IDs (a unique identifier that is not usually exposed to end users), employee IDs (a unique human-readable identifier specified by an end user), name (partial names in the format "last_name, first_name"), and an employee filter. These four parameters are combined together using the OR operator when selecting matching employee records. If none of the four parameters are supplied, then all employees are selected.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| employeeIds | [string] | false | none | A list of employee ids for explicit employee selection. This is a system identifier for a resource, not the identifier exposed to end users in the software. |
| employeeIdentifiers | [string] | false | none | List of employee identifiers for explicit employee selection. This is the employee identifier that is exposed to the end user in the software. Employees with a name in the format "last_name, first_name" that start with a value specified in this list are selected. |
| employeeNames | [string] | false | none | List of names used to select employees. Any employee with a name that begins with a supplied value will be selected. Employees match if the employee name in the format "last name, first name" starts with a value in this list. |
| employeeFilter | EmployeeFilter | false | none | Standard used for filtering employees. The Employee Filter allows filtering of employees by Employee Groups, hire date, termination date, extra field, skill, and segment. Employee filter criteria is combined together by using the AND operator to determine which employees match all filter criteria. |
| respectFilterProfile | boolean | false | none | Whether to use employee filter profiles. If true (the default), then only employees in the employee filter profile of the current user will be selected. If false, the employee filter profile is not considered. |
| hideInactiveEmployees | boolean | false | none | Whether to hide Inactive employees. If false (the default), only active employees are selected. If true, then all matching employees are returned. |
EmployeeSkillAssociation
{
"skillId": "975444541",
"priority": 2
}
Employee Skill record
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| skillId | string | false | none | Alvaria-generated unique identifier for the SkillId |
| priority | integer(int32) | false | none | Number indicating relative proficiency (relative to the other Employee skills, or the proficiency of other Employees in this same area) |
Error
{
"scope": "null",
"reason": "Invalid JSON",
"message": "Invalid JSON"
}
Details of an error response
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scope | string | false | none | Scope of the error |
| reason | string | false | none | Reason for the error |
| message | string | false | none | Message associated with the error |
ErrorResponse
{
"code": "EInvalidInput",
"message": "Invalid JSON",
"errors": [
{
"scope": "null",
"reason": "Invalid JSON",
"message": "Invalid JSON"
}
]
}
Information about an error that occurred while processing a request
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | Unique error code for the error condition |
| message | string | false | none | Message that describes the error condition |
| errors | [Error] | false | none | Detailed information about each error that occurred |
ExtraFieldComparison
{
"operator": "EqualTo",
"value": "EMP001",
"extraFieldId": "2387932847"
}
Extra field comparison which can be used to filter data associated with extra fields. The comparison uses the following three properties together: ExtraFieldId - the specific extra field Value - the value to compare Operator - the definition of how to compare the specific extra field value NOTE: If ALL three are not supplied the resulting behavior is undefined.
The following table shows each of the extra field data types and the comparison operators
supported for that type - if it is not supported, the resulting behavior is undefined.
For operators "EqualTo" and "NotEqualTo":
DataType Valid Values
-------- ------------
String Any string
Boolean "true", "false", 1, or 0
For all operators ("LessThan", "LessThanEqualTo", "EqualTo", "NotEqualTo",
"GreaterThanEqualTo", "GreaterThan"):
DataType Valid Values
-------- ------------
Integer Any number with no decimals
Float Any number, with or without decimals
Date A string in the format yyyy-mm-dd
Time A string in the format hh:mm[:ss]
DateTime A string in the format yyyy-mm-dd[Thh:mm[:ss][Z|(+/-)hh:mm]]
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operator | string | false | none | How to compare the given value against the extra field value |
| value | string | false | none | Value to compared against the extra field value |
| extraFieldId | string | false | none | Alvaria-generated unique identifier for the ExtraField |
Enumerated Values
| Property | Value |
|---|---|
| operator | LessThan |
| operator | LessThanEqualTo |
| operator | EqualTo |
| operator | NotEqualTo |
| operator | GreaterThanEqualTo |
| operator | GreaterThan |
ExtraFieldValue
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
Value of an Employee Extra Field
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| extraFieldId | string | false | none | Alvaria-generated unique identifier for the ExtraFieldId |
| value | string | false | none | Extra Field value, expressed as a string |
IDP
{
"kind": "via#workforceIDP",
"id": "-1924365234643",
"creationTime": "2010-12-31T13:18:35Z",
"createdBy": "SCHLACTER",
"startTime": "2003-01-05T00:00:00",
"stopTime": "2003-01-05T00:00:00",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastGroups": [
{
"kind": "via#workforceIDPFGTreeType",
"code": "CSV",
"idpFgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{}
],
"staffGroups": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| creationTime | string(date-time) | false | none | The date which the idp was created. |
| createdBy | string | false | none | The person that created the idp. |
| startTime | string(date-time) | false | none | The start time of the idp. |
| stopTime | string(date-time) | false | none | The stop time of the idp. |
| timeZone | TimeZoneType | false | none | none |
| routingSet | RoutingSetType | false | none | none |
| forecastGroups | [IDPFGTreeType] | false | none | The forecast groups of the idp |
IDPCollection
{
"kind": "via#workforceIDPCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"idps": [
{
"kind": "via#workforceIDP",
"id": "-1924365234643",
"creationTime": "2010-12-31T13:18:35Z",
"createdBy": "SCHLACTER",
"startTime": "2003-01-05T00:00:00",
"stopTime": "2003-01-05T00:00:00",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastGroups": [
{
"kind": "via#workforceIDPFGTreeType",
"code": "CSV",
"idpFgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{}
],
"staffGroups": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
| totalItems | integer(int32) | false | none | Indicates the total number of items within the result set, which may be less than the number of results actually returned |
| links | Links | false | none | none |
| idps | [IDP] | false | none | Result of a query for IDP. The result contains a list of IDPs that matched the selection criteria. |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
IDPDetailsConsolidation
{
"staffGroups": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| staffGroups | [StaffGroup] | false | none | none |
IDPDetailsMultiSkill
{
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"basis": "Original",
"adjustments": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| start | string(date-time) | false | none | none |
| stop | string(date-time) | false | none | none |
| basis | string | false | none | none |
| adjustments | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| basis | Original |
| basis | Revised |
| basis | Actual |
IDPDetailsResponse
{
"kind": "via#workforceIDPDetailsResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"idpDetails": {
"kind": "via#workforceIDPType",
"idpDescription": "CSV 1/10/2003",
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastUnit": 30,
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"staffGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"consolidation": {
"kind": "via#workforceIDPTypeConsolidation",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
},
"id": "-1924365234643",
"action": "Delete",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
| idpDetails | IDPType | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
IDPDetailsSelector
{
"idpId": "-9921474826",
"forecastGroup": {
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
},
"staffGroup": {
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
},
"consolidation": {
"staffGroups": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
},
"multiSkill": {
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"basis": "Original",
"adjustments": false
},
"includeProperties": false,
"includeOpenHours": false
}
Selects a idp and details to be returned.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| idpId | string | false | none | Alvaria-generated unique identifier for the idp |
| forecastGroup | IDPGroupType | false | none | none |
| staffGroup | IDPGroupType | false | none | none |
| consolidation | IDPDetailsConsolidation | false | none | none |
| multiSkill | IDPDetailsMultiSkill | false | none | none |
| includeProperties | boolean | false | none | Should include idp's properties. |
| includeOpenHours | boolean | false | none | Should include idp's open hours. |
IDPFGTreeType
{
"kind": "via#workforceIDPFGTreeType",
"code": "CSV",
"idpFgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{
"kind": "via#workforceIDPFGTreeType",
"code": "CSV",
"idpFgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [],
"staffGroups": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"staffGroups": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{}
],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| code | string | false | none | The code for the idp forecast group tree. |
| idpFgTreeDescription | string | false | none | The description for the idp forecast group tree. |
| timeZone | TimeZoneType | false | none | none |
| startTime | string(date-time) | false | none | The start time for the idp forecast group tree. |
| stopTime | string(date-time) | false | none | The stop time for the idp forecast group tree. |
| forecastGroups | [IDPFGTreeType] | false | none | The forecast groups for the idp forecast group tree. |
| staffGroups | [IDPSGTreeType] | false | none | The staff groups for the idp forecast group tree. |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| multiSkill | boolean | false | none | Is idp forecast group tree a multi-skill. |
IDPGroupResponseType
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| code | string | false | none | The code for the idp group |
| idpGroupDescription | string | false | none | The description for the idp group |
| timeZone | TimeZoneType | false | none | none |
| parentId | string | false | none | Alvaria-generated unique identifier for the parent |
| openHours | [OpenHoursTypePeriod] | false | none | The open hour periods for the idp group |
| properties | IDPGroupResponseTypeProperties | false | none | none |
| elements | [ElementType] | false | none | The elements for the idp group |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| hasChildren | boolean | false | none | Does idp group have children. |
| multiSkill | boolean | false | none | Is idp group a multi-skill. |
| allocation | boolean | false | none | Is idp group allocated. |
IDPGroupResponseTypeProperties
{
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| assumptions | [IDPGroupResponseTypePropertiesAssumptions] | false | none | The assumptions for idp group property |
| histories | [IDPGroupResponseTypePropertiesHistory] | false | none | The histories for idp group property |
IDPGroupResponseTypePropertiesAssumptions
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| scenario | string | false | none | The scenario for idp group property assumption |
| volumeOverride | string | false | none | The volume override for idp group property assumption |
| ahtOverride | string | false | none | The average handle time override for idp group property assumption |
| staffBasis | string | false | none | The staff basis for idp group property assumption |
| allocationSet | string | false | none | The allocation set for idp group property assumption |
IDPGroupResponseTypePropertiesHistory
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| timeStamp | string(date-time) | false | none | The time stamp for the idp group property history |
| user | string | false | none | The user for the idp group property history |
| action | string | false | none | The action for the idp group property history |
IDPGroupType
{
"elements": [
{
"id": "-1924365234643",
"value": "-1924365234643"
}
],
"id": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| elements | [IDStringValueType] | false | none | none |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
IDPListBaseResponse
{
"kind": "via#workforceBaseResponse`1",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
IDPLookupSelector
{
"dateTimeRange": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"forecastGroupId": "-992147482601",
"routingSetId": "-992147482601",
"staffGroupId": "-992147482601"
}
Selects a set of segment requests.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dateTimeRange | DateTimeRange | false | none | Range of dates and times. A time greater than or equal to StartDateTime and less than (but not equal to) StopDateTime are considered within the range. |
| forecastGroupId | string | false | none | Alvaria-generated unique identifier for the forecast group |
| routingSetId | string | false | none | Alvaria-generated unique identifier for the routing set |
| staffGroupId | string | false | none | Alvaria-generated unique identifier for the staff group |
IDPSGTreeType
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [
{
"code": "CSV",
"idpSgTreeDescription": "Customer Service",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"start": "2003-01-07T00:00:00-06:00",
"stop": "2003-01-07T00:00:00-06:00",
"staffGroup": [],
"id": "-1924365234643",
"multiSkill": false
}
],
"id": "-1924365234643",
"multiSkill": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | none |
| idpSgTreeDescription | string | false | none | none |
| timeZone | TimeZoneType | false | none | none |
| start | string(date-time) | false | none | none |
| stop | string(date-time) | false | none | none |
| staffGroup | [IDPSGTreeType] | false | none | none |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| multiSkill | boolean | false | none | none |
IDPType
{
"kind": "via#workforceIDPType",
"idpDescription": "CSV 1/10/2003",
"routingSet": {
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
},
"forecastUnit": 30,
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"startTime": "2003-01-07T00:00:00-06:00",
"stopTime": "2003-01-07T00:00:00-06:00",
"forecastGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"staffGroups": [
{
"kind": "via#workforceIDPGroupResponseType",
"code": "CSV",
"idpGroupDescription": "CSV Routing Set",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"parentId": "-1924365234643",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"properties": {
"kind": "via#workforceIDPGroupResponseTypeProperties",
"assumptions": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesAssumptions",
"scenario": "CSV",
"volumeOverride": "Volume Override",
"ahtOverride": "AHT Override",
"staffBasis": "SRVCLEV",
"allocationSet": "allocation set"
}
],
"histories": [
{
"kind": "via#workforceIDPGroupResponseTypePropertiesHistory",
"timeStamp": "2003-01-07T00:00:00-06:00",
"user": "user",
"action": "action"
}
]
},
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
],
"id": "-1924365234643",
"hasChildren": false,
"multiSkill": false,
"allocation": false
}
],
"consolidation": {
"kind": "via#workforceIDPTypeConsolidation",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
},
"id": "-1924365234643",
"action": "Delete",
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| idpDescription | string | false | none | The description of the idp |
| routingSet | RoutingSetType | false | none | none |
| forecastUnit | integer(int32) | false | none | The routing set of the idp |
| timeZone | TimeZoneType | false | none | none |
| startTime | string(date-time) | false | none | The start time of the idp |
| stopTime | string(date-time) | false | none | The stop time of the idp |
| forecastGroups | [IDPGroupResponseType] | false | none | The forecast groups of the idp |
| staffGroups | [IDPGroupResponseType] | false | none | The staff groups of the idp |
| consolidation | IDPTypeConsolidation | false | none | none |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| action | string | false | none | The action for the ipd. |
| openHours | [OpenHoursTypePeriod] | false | none | The open hours for the ipd. |
| elements | [ElementType] | false | none | The elements for the ipd. |
Enumerated Values
| Property | Value |
|---|---|
| action | Delete |
| action | ChangeFrom |
| action | ChangeTo |
IDPTypeBaseResponse
{
"kind": "via#workforceBaseResponse`1",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
IDPTypeConsolidation
{
"kind": "via#workforceIDPTypeConsolidation",
"timeZone": {
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
},
"openHours": [
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
],
"elements": [
{
"kind": "via#workforceElementType",
"value": [
{
"kind": "via#workforceElementTypeValue",
"index": 123,
"threshold": "12",
"color": 12,
"fontColor": 12,
"value": "12"
}
],
"elementSummary": 1234,
"elementId": "-1924365234643",
"dataType": "Float",
"min": 1,
"max": 8888,
"maxDecimals": 8888,
"readOnly": false
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| timeZone | TimeZoneType | false | none | none |
| openHours | [OpenHoursTypePeriod] | false | none | The open hour periods of the idp consolidation |
| elements | [ElementType] | false | none | The elements of the idp consolidation |
IDStringValueType
{
"id": "-1924365234643",
"value": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| value | string | false | none | none |
IntegerRange
{
"minimum": 1,
"maximum": 1
}
Range of integer values. Integers greater than or equal to Minimum and less than or equal to Maximum are considered within the range.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| minimum | integer(int32) | false | none | Numbers less that this value are within the range |
| maximum | integer(int32) | false | none | Numbers greater than this value are not within the range |
Link
{
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | false | none | Link for a set of page results |
Links
{
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| first | Link | false | none | none |
| last | Link | false | none | none |
| next | Link | false | none | none |
| prev | Link | false | none | none |
OpenHoursTypePeriod
{
"kind": "via#workforceOpenHoursTypePeriod",
"index": 1232,
"open": false,
"timeValue": "2003-01-07T00:00:00-06:00"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| index | integer(int32) | false | none | The index of the open hour period |
| open | boolean | false | none | Is open hour period open |
| timeValue | string(date-time) | false | none | The time of the open hour period |
RequestLookupSelector
{
"employeeSelector": {
"employeeIds": [
"-992147482601",
"-992147482602"
],
"employeeIdentifiers": [
"string"
],
"employeeNames": [
"string"
],
"employeeFilter": {
"employeeGroupFilter": {
"employeeGroupIds": [
"-992147482601",
"-992147482602"
]
},
"hireDateFilter": {},
"termDateFilter": {},
"extraFieldFilter": {
"operator": "EqualTo",
"value": "EMP001",
"extraFieldId": "2387932847"
},
"skillFilter": {
"priorityRange": {
"minimum": 1,
"maximum": 1
},
"priorityFrom": 1,
"priorityTo": 1,
"skillId": "1489356"
},
"segmentFilter": {
"start": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"stop": {
"startDateTime": "2010-12-31T13:18:35Z",
"stopDateTime": "2010-12-31T13:18:35Z"
},
"duration": {
"minimumDuration": "15:01:00",
"maximumDuration": "15:02:00"
},
"segmentDefinitionId": "66898"
}
},
"respectFilterProfile": true,
"hideInactiveEmployees": true
},
"requestStatus": "OPEN",
"scorecardStatus": "PASS",
"checkerRuleId": "-992147482601",
"dateRange": {},
"createdOnDateRange": {}
}
Selects a set of segment requests.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| employeeSelector | EmployeeSelector | false | none | Selects employees by name, ID, employee identifier, or by a complex filter. Employees are selected by IDs (a unique identifier that is not usually exposed to end users), employee IDs (a unique human-readable identifier specified by an end user), name (partial names in the format "last_name, first_name"), and an employee filter. These four parameters are combined together using the OR operator when selecting matching employee records. If none of the four parameters are supplied, then all employees are selected. |
| requestStatus | string | false | none | segment requests with a matching status are selected. |
| scorecardStatus | string | false | none | segment requests with a matching scorecard status are selected. |
| checkerRuleId | string | false | none | Alvaria-generated unique identifier for the checker rule |
| dateRange | DateRange | false | none | Range of dates. Dates greater than or equal to the StartDate and less than or equal to the StopDate are considered within the range. |
| createdOnDateRange | DateRange | false | none | Range of dates. Dates greater than or equal to the StartDate and less than or equal to the StopDate are considered within the range. |
Enumerated Values
| Property | Value |
|---|---|
| requestStatus | OPEN |
| requestStatus | FAIL |
| requestStatus | OFFC |
| requestStatus | CANC |
| requestStatus | DEFR |
| scorecardStatus | PASS |
| scorecardStatus | FAIL |
| scorecardStatus | WAIT |
| scorecardStatus | DEFR |
| scorecardStatus | NA |
RoutingSetType
{
"kind": "via#workforceRoutingSetType",
"code": "CSV",
"routingSetDescription": "CSV Routing Set",
"multiSkill": false,
"serviceLevelGoalSeconds": 12,
"lastModifiedBy": "-1924365234643",
"lastModifiedTime": "2003-01-06T00:00:00-06:00",
"routings": [
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
],
"staffGroupProperties": [
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
],
"id": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| code | string | false | none | The code for the routing set. |
| routingSetDescription | string | false | none | The description for the routing set. |
| multiSkill | boolean | false | none | Is the routing set a multi-skill. |
| serviceLevelGoalSeconds | number(double) | false | none | The number of seconds for the service level goal for the routing set. |
| lastModifiedBy | string | false | none | The user that last modify the routing set. |
| lastModifiedTime | string(date-time) | false | none | The last time the routing set was modified. |
| routings | [RoutingSetTypeRouting] | false | none | The list of routes associated with the routing set. |
| staffGroupProperties | [RoutingSetTypeStaffGroupProperty] | false | none | The list of staff groups associated with the routing set. |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
RoutingSetTypeRouting
{
"kind": "via#workforceRoutingSetTypeRouting",
"forecastGroupId": "-992147482601",
"staffGroupId": "-992147482601",
"priority": 1,
"ahtFactor": 1.1
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| forecastGroupId | string | false | none | Alvaria-generated unique identifier for the forecast group. |
| staffGroupId | string | false | none | Alvaria-generated unique identifier for the staff group. |
| priority | integer(int32) | false | none | The priority of the routing. |
| ahtFactor | number(double) | false | none | The average handle time factor of the routing. |
RoutingSetTypeStaffGroupProperty
{
"kind": "via#workforceRoutingSetTypeStaffGroupProperty",
"staffGroupId": "-992147482601",
"value": "VOLADJUST"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| staffGroupId | string | false | none | Alvaria-generated unique identifier for the staff group. |
| value | string | false | none | The staff group type associated with the staff group property. |
Enumerated Values
| Property | Value |
|---|---|
| value | VOLADJUST |
| value | STAFFADJUST |
Saved
{
"kind": "via#workforceSaved"
}
Successfully saved request to WFM
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
SavedResponse
{
"kind": "via#workforceSavedResponse",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady",
"saved": {
"kind": "via#workforceSaved"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
| saved | Saved | false | none | Successfully saved request to WFM |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
ScorecardTypeCell
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
Will be 1 cell element for every combination of Checker rule and nominal date in the segment request.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| ruleId | string | false | none | Alvaria-generated unique identifier for the checker rule |
| status | string | false | none | The status for the scorecard cell |
| memo | string | false | none | The memo for the scorecard cell |
| waitList | ScorecardTypeCellWaitList | false | none | Will only exist if Scorecard Status = WAIT |
Enumerated Values
| Property | Value |
|---|---|
| status | PASS |
| status | FAIL |
| status | WAIT |
| status | DEFR |
| status | NA |
ScorecardTypeCellWaitList
{
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
Will only exist if Scorecard Status = WAIT
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| position | integer(int32) | false | none | Position of this segment request on the wait list. |
| count | integer(int32) | false | none | Total number of segment requests on this wait list. |
Segment
{
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
Definition for creating/updating a schedule segment or request segment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| employeeId | string | false | none | Alvaria-generated unique identifier for the employee. |
| nominalDate | string(date-time) | false | none | The nominal date related to the segment. |
| segmentDefinitionId | string | false | none | Alvaria-generated unique identifier for the segment definition. |
| startTime | string(date-time) | false | none | The start time for the segment. |
| stopTime | string(date-time) | false | none | The stop time for the segment. |
| memo | string | false | none | The memo for the segment. |
| segmentType | string | false | none | The segment type for the segment. |
Enumerated Values
| Property | Value |
|---|---|
| segmentType | Detail |
| segmentType | General |
SegmentRequest
{
"kind": "via#workforceSegmentRequest",
"id": "-1924365234643",
"employee": {
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
},
"user": {
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
},
"status": "OPEN",
"creationTime": "2010-12-31T13:18:35Z",
"sequence": 1,
"source": "source",
"requiresChecking": false,
"readyToProcess": false,
"evaluationCount": 1,
"isValidSegment": false,
"priority": 1,
"rank": 1,
"effectiveCreationTime": "2010-12-31T13:18:35Z",
"effectiveSequence": 1,
"processingStartedTime": "010-12-31T13:18:35.0000000+00:00",
"memo": "memo",
"summaryMemo": "summaryMemo",
"scorecards": [
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
],
"segments": {
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
},
"datesAffected": [
"2019-08-24T14:15:22Z"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| employee | Employee | false | none | Workforce Management Employee definition |
| user | UserType | false | none | none |
| status | string | false | none | The status of the segment request. |
| creationTime | string(date-time) | false | none | The date which the segment request was created. |
| sequence | integer(int32) | false | none | Provides a finer resolution of creation time. |
| source | string | false | none | Indicates from what system the segment request was added. |
| requiresChecking | boolean | false | none | Controls whether the segment request is evaluated against the Checker and personal balance rules or sent directly to Updater. |
| readyToProcess | boolean | false | none | Indicates whether this segment request is ready to be processed by Checker. |
| evaluationCount | integer(int32) | false | none | Indicates how many time Checker has evaluated this segment request. |
| isValidSegment | boolean | false | none | Indicates whether this segment request is compatible with the current state of the employee's schedule. |
| priority | integer(int32) | false | none | Controls the order in which Checker evaluates the segment request. |
| rank | integer(int32) | false | none | rank of the segment request. |
| effectiveCreationTime | string(date-time) | false | none | The effective date which the segment request was created. |
| effectiveSequence | integer(int32) | false | none | Provides a finer effective resolution of creation time. |
| processingStartedTime | string(date-time) | false | none | Indicates when Checker started processing the segment request. |
| memo | string | false | none | Detailed memo for the segment request. |
| summaryMemo | string | false | none | Summary memo for the segment request. |
| scorecards | [ScorecardTypeCell] | false | none | The scorecards for the segment request. |
| segments | SegmentsType | false | none | The lists of segments, general segments and detail segments. |
| datesAffected | [string] | false | none | Dates affected by request |
Enumerated Values
| Property | Value |
|---|---|
| status | OPEN |
| status | FAIL |
| status | OFFC |
| status | CANC |
| status | DEFR |
SegmentRequestDetailsSelector
{
"segmentRequestIds": [
"string"
],
"includeMemo": false,
"includeSegments": false,
"includeScorecard": false,
"includeSummaryMemo": false,
"includeQueuePosition": false,
"includeAffectedDates": false
}
Selects a set of segment requests with details.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| segmentRequestIds | [string] | false | none | The segment requests wanting details for. |
| includeMemo | boolean | false | none | Should include memo in the segment request's details. |
| includeSegments | boolean | false | none | Should include segments in the segment request's details. |
| includeScorecard | boolean | false | none | Should include scorecard in the segment request's details. |
| includeSummaryMemo | boolean | false | none | Should include summary memo in the segment request's details. |
| includeQueuePosition | boolean | false | none | Should include queue position in the segment request's details. |
| includeAffectedDates | boolean | false | none | Should include affected dates in the segment request's details. |
SegmentRequestListBaseResponse
{
"kind": "via#workforceBaseResponse`1",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
SegmentRequestsCollection
{
"kind": "via#workforceSegmentRequestsCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"segmentRequests": [
{
"kind": "via#workforceSegmentRequest",
"id": "-1924365234643",
"employee": {
"kind": "via#workforceEmployee",
"id": "-1924365234643",
"employeeIdentifier": "TIG32",
"lastName": "Abernathy",
"firstName": "Jackie K.",
"shortName": "JKAbernathy",
"sortName": "ABERNATHY, JACKIE K.",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"lastModifiedBy": "-1924365234643",
"active": true,
"timeZoneId": "-1924365234643",
"seniority": "20050101002",
"emailAddress": "employeeemail@sample.com",
"instantMessageAddress": "sip:employeeURI@sample.com",
"memo": "Additional info relating to Employee",
"extraFields": [
{
"extraFieldId": "975444541",
"value": "ExtraData"
}
],
"skills": [
{
"skillId": "975444541",
"priority": 2
}
],
"employeeGroups": [
{
"employeeGroupId": "975444541",
"leader": false
}
],
"acdLogins": [
{
"login": "1920",
"acdInstanceId": "-992147482601",
"group": "ACD1"
}
]
},
"user": {
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
},
"status": "OPEN",
"creationTime": "2010-12-31T13:18:35Z",
"sequence": 1,
"source": "source",
"requiresChecking": false,
"readyToProcess": false,
"evaluationCount": 1,
"isValidSegment": false,
"priority": 1,
"rank": 1,
"effectiveCreationTime": "2010-12-31T13:18:35Z",
"effectiveSequence": 1,
"processingStartedTime": "010-12-31T13:18:35.0000000+00:00",
"memo": "memo",
"summaryMemo": "summaryMemo",
"scorecards": [
{
"kind": "via#workforceScorecardTypeCell",
"ruleId": "-992147482601",
"status": "PASS",
"memo": "memo",
"waitList": {
"kind": "via#workforceScorecardTypeCellWaitList",
"position": 1,
"count": 1
}
}
],
"segments": {
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
},
"datesAffected": [
"2019-08-24T14:15:22Z"
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
| totalItems | integer(int32) | false | none | Indicates the total number of items within the result set, which may be less than the number of results actually returned |
| links | Links | false | none | none |
| segmentRequests | [SegmentRequest] | false | none | Result of a query for segment request. The result contains a list of segment request that matched the selection criteria. |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
SegmentsType
{
"kind": "via#workforceSegmentsType",
"detailSegments": [
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
],
"generalSegments": [
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
],
"saveAsRequest": false
}
The lists of segments, general segments and detail segments.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| detailSegments | [SegmentsTypeDetailSegment] | false | none | List of detail segments |
| generalSegments | [SegmentsTypeGeneralSegment] | false | none | List of general segments |
| saveAsRequest | boolean | false | none | Save as a request |
SegmentsTypeDetailSegment
{
"kind": "via#workforceSegmentsTypeDetailSegment",
"employeeId": "-992147482601",
"segmentCodeId": "-992147482601",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"id": "-1924365234643"
}
The detail segment definition.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| employeeId | string | false | none | Alvaria-generated unique identifier for the employee. |
| segmentCodeId | string | false | none | Alvaria-generated unique identifier for the segment code |
| startTime | string(date-time) | false | none | The start time of detail segment |
| stopTime | string(date-time) | false | none | The stop time of detail segment |
| memo | string | false | none | The memo of detail segment |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
SegmentsTypeGeneralSegment
{
"kind": "via#workforceSegmentsTypeGeneralSegment",
"employeeId": "-1924365234643",
"segmentCodeId": "-1924365234643",
"memo": "memo",
"id": "-1924365234643"
}
The general segment definition.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| employeeId | string | false | none | Alvaria-generated unique identifier for the employee. |
| segmentCodeId | string | false | none | Alvaria-generated unique identifier for the segment code. |
| memo | string | false | none | The memo of general segment |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
StaffGroup
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
| treeId | string | false | none | Alvaria-generated unique identifier for the tree |
| code | string | false | none | The code for this staff group. |
| staffGroupDescription | string | false | none | The description for this staff group. |
| lastModifiedBy | string | false | none | Who last modified this staff group. |
| lastModifiedTime | string(date-time) | false | none | The last time this staff group was modified. |
| timeZoneId | string | false | none | Alvaria-generated unique identifier for the time zone |
| scheduledRequiredStaffThresholdId | string | false | none | Alvaria-generated unique identifier for the scheduled required staff threshold |
| requiredActualStaffThresholdId | string | false | none | Alvaria-generated unique identifier for the required actual staff threshold |
| scheduledActualStaffThresholdId | string | false | none | Alvaria-generated unique identifier for the scheduled actual staff threshold |
| openHoursId | string | false | none | Alvaria-generated unique identifier for the open hours |
| superStateId | string | false | none | Alvaria-generated unique identifier for the super state |
| employeeGroupId | string | false | none | Alvaria-generated unique identifier for the employee group |
| parentId | string | false | none | Alvaria-generated unique identifier for the parent |
| agentDataGroupsIds | [string] | false | none | Alvaria-generated unique identifier for the staff group |
StaffGroupCollection
{
"kind": "via#workforceStaffGroupCollection",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "Ready",
"totalItems": 500,
"links": {
"kind": "via#workforceLinks",
"first": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"last": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"next": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
},
"prev": {
"href": "https://api.us.via.aspect-cloud.net/via/v2/organizations/orgName/workforce/checkerrequests/search?searchId=0f8fad5b-d9cb-469f-a165-70867728950e&startIndex=0&maxResults=5"
}
},
"staffGroup": [
{
"kind": "via#workforceStaffGroup",
"id": "-1924365234643",
"treeId": "-1924365234643",
"code": "1",
"staffGroupDescription": "staff group description",
"lastModifiedBy": "-992147482601",
"lastModifiedTime": "2010-12-31T13:18:35Z",
"timeZoneId": "-992147482601",
"scheduledRequiredStaffThresholdId": "-992147482601",
"requiredActualStaffThresholdId": "-992147482601",
"scheduledActualStaffThresholdId": "-992147482601",
"openHoursId": "-992147482601",
"superStateId": "-992147482601",
"employeeGroupId": "-992147482601",
"parentId": "-992147482601",
"agentDataGroupsIds": [
"-992147482601",
"-992147482602"
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
| totalItems | integer(int32) | false | none | Indicates the total number of items within the result set, which may be less than the number of results actually returned |
| links | Links | false | none | none |
| staffGroup | [StaffGroup] | false | none | Result of a query for segment request. The result contains a list of segment request that matched the selection criteria. |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
StaffGroupListBaseResponse
{
"kind": "via#workforceBaseResponse`1",
"searchId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"responseStatus": "NotReady"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| searchId | string | false | none | Alvaria-generated unique identifier for the SearchId |
| responseStatus | string | false | none | Cache Status of Response in cache |
Enumerated Values
| Property | Value |
|---|---|
| responseStatus | NotReady |
| responseStatus | Ready |
| responseStatus | Error |
| responseStatus | UnknownResponseType |
StaffGroupLookupSelector
{
"code": "SALES",
"partialCode": "SAL",
"staffGroupId": "-992147482601"
}
Selects a set of staff groups.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | Staff group with a matching code are selected |
| partialCode | string | false | none | Staff group with a matching partial code are selected |
| staffGroupId | string | false | none | Alvaria-generated unique identifier for the staff group |
TimeRange
{
"startTime": "23:00:00",
"stopTime": "23:00:00"
}
Range of times. Times greater than or equal to StartTime and less than (but not equal to) StopTime are considered within the range.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startTime | string | false | none | Start time of the range |
| stopTime | string | false | none | Stop time of the range |
TimeZoneType
{
"kind": "via#workforceTimeZoneType",
"displayName": "(UTC-06:00) Central Time (US and Canada)",
"id": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| displayName | string | false | none | none |
| id | string | false | none | Alvaria-generated unique identifier for the Id |
UpdateSegmentPair
{
"currentSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
},
"updateSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currentSegment | Segment | true | none | Definition for creating/updating a schedule segment or request segment |
| updateSegment | Segment | true | none | Definition for creating/updating a schedule segment or request segment |
UpdateSegmentSelector
{
"saveAsRequest": false,
"updateSegments": [
{
"currentSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
},
"updateSegment": {
"id": "-1924365234643",
"employeeId": "-1924365234643",
"nominalDate": "2010-12-31",
"segmentDefinitionId": "-1924365234643",
"startTime": "2010-12-31T13:18:35Z",
"stopTime": "2010-12-31T13:18:35Z",
"memo": "memo",
"segmentType": "General"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| saveAsRequest | boolean | false | none | Save as request segment. |
| updateSegments | [UpdateSegmentPair] | true | none | List of segments to update |
UserType
{
"kind": "via#workforceUserType",
"active": true,
"userName": "Abernathy, Jackie K.",
"altUserName": "Abernathy, Jackie K.",
"systemAdministrator": false,
"filterProfileId": "-1924365234643",
"securityProfileId": "-1924365234643",
"seatFilterProfileId": "-1924365234643",
"employeeId": "-1924365234643",
"firstName": "Jackie K.",
"lastName": "Abernathy",
"firstDayOfWeek": 1,
"timeZoneId": "-1924365234643",
"fullName": "Abernathy, Jackie K.",
"secondaryLoginId": "employeeemail@sample.com",
"id": "-1924365234643"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria Cloud components to serialize the payload of the results |
| active | boolean | false | none | Is the user active. |
| userName | string | false | none | The username for the user. |
| altUserName | string | false | none | The alternative username for the user. |
| systemAdministrator | boolean | false | none | Is the user a system administrator. |
| filterProfileId | string | false | none | Alvaria-generated unique identifier for the filter profile |
| securityProfileId | string | false | none | Alvaria-generated unique identifier for the security profile |
| seatFilterProfileId | string | false | none | Alvaria-generated unique identifier for the seat filter profile |
| employeeId | string | false | none | Alvaria-generated unique identifier for the employee |
| firstName | string | false | none | The first name of the user. |
| lastName | string | false | none | The last name of the user. |
| firstDayOfWeek | integer(int32) | false | none | The first day of the work week for the user. |
| timeZoneId | string | false | none | Alvaria-generated unique identifier for the time zone |
| fullName | string | false | none | The full name for the user. |
| secondaryLoginId | string | false | none | Alvaria-generated unique identifier for the SecondaryLoginId |
| id | string | false | none | Alvaria-generated unique identifier for the Id |