Endpoint
/api/v2/tenants/{tenantId}/rosters/{id}
Path Parameters
tenantIdstring
idstring
Responses
OK
Endpoint
/api/v2/tenants/{tenantId}/rosters/{id}
Path Parameters
tenantIdstring
idstring
Responses
OK
allClientsboolean
createdTimestring
descriptionstring
idstring
namestring
shiftDetailsarray
Child Parameters
- shiftDetails.id
- shiftDetails.name
- shiftDetails.schedule
- shiftDetails.userGroups
- shiftDetails.users
updatedTimestring
{
"allClients": true,
"createdTime": "2017-12-27T06:26:41+0000",
"description": "Team working on Linux issues",
"id": "ES-f64e08e8-9d78-40fa-8bba-19d36d42653f",
"name": "Linix Admins",
"shiftDetails": [
{
"id": "ESD-ab20240d-7d02-489e-8cbd-6592e2980aec",
"name": "Second shift",
"schedule": {
"endPattern": {
"type": "NEVER"
},
"endTime": "15:20:00",
"pattern": {
"repeatFrequency": 5,
"type": "weekly",
"weekDays": "Wednesday,Thursday,Friday"
},
"startDate": "2017-12-27T04:45:00+0000",
"startTime": "10:15:00",
"type": "recurring"
},
"users": [
{
"email": "james.h@myorganization.com",
"firstName": "James",
"id": "USR0000000021",
"lastName": "Hudson",
"loginName": "James.Hudson",
"phoneNumber": "802-1231-234"
}
]
},
{
"id": "ESD-f05a111c-a596-4ad5-9eba-67444020434b",
"name": "First shift",
"schedule": {
"endDate": "2017-12-29T09:46:20+0000",
"startDate": "2017-12-28T04:41:12+0000",
"type": "one-time"
},
"userGroups": [
{
"createdTime": "2017-12-17T16:26:55+0000",
"description": "Team working on network issues.",
"name": "Network Admins Group",
"uniqueId": "USRGRP-b5f0e4d4-76ad-4497-8fc7-2790e3eaa343",
"updatedTime": "2017-12-18T10:48:51+0000"
}
],
"users": [
{
"email": "john.smith@myorganization.com",
"firstName": "John",
"id": "USR0000000043",
"lastName": "Smith",
"loginName": "John.Smith",
"phoneNumber": "803-4567-890"
}
]
}
],
"timeZone": {
"code": "IST",
"id": "19",
"label": "GMT +05:30 India",
"name": "Asia/Calcutta"
},
"updatedTime": "2017-12-27T06:57:00+0000"
}
Endpoint
/api/v2/tenants/{tenantId}/rosters/{id}
Path Parameters
tenantIdstring
idstring
descriptionstring
namestring
Unique name for roster used for roster identification.
shiftDetailsobject
Child Parameters
- shiftDetails.id
- shiftDetails.name
- Unique name for shift. The shift would be identified with the name.Example: Morning Shift
- shiftDetails.schedule
- shiftDetails.userGroups
- Add user groups to a roster.
- shiftDetails.users
- Add users to a roster.
timeZoneobject
Time zone in which the roster should operate (see table). An example time zone is: `"timeZone": {"name": "Asia/Calcutta"},`
Child Parameters
- timeZone.name
{
"description": "Team working on all network and Windows devices issues.",
"name": "Network and Windows Support",
"shiftDetails": [
{
"id": "ESD-5296f16f-d254-4d67-bfe8-574d3519d172",
"name": "Morning shift",
"schedule": {
"endDate": "2017-12-29T09:46:20+0000",
"startDate": "2017-12-28T04:41:12+0000",
"type": "one-time"
},
"userGroups": [
{
"uniqueId": "USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4"
}
],
"users": [
{
"id": "USR0000000018"
}
]
}
],
"timeZone": {
"name": "Asia/Calcutta"
}
}
Responses
OK
createdTimestring
descriptionstring
idstring
namestring
shiftDetailsarray
Child Parameters
- shiftDetails.id
- shiftDetails.name
- shiftDetails.schedule
- shiftDetails.userGroups
- shiftDetails.users
updatedTimestring
{
"client": {
"activated": true,
"id": 7,
"name": "Logix Inc",
"uniqueId": "client_7"
},
"createdTime": "2017-12-27T06:32:11+0000",
"description": "Team working on network and Windows devices issues.",
"id": "ES-26ecfba7-6896-47a8-aa8d-825b610513e6",
"name": "Network and Windows Support",
"shiftDetails": [
{
"id": "ESD-5296f16f-d254-4d67-bfe8-574d3519d172",
"name": "Morning shift",
"schedule": {
"endDate": "2017-12-29T09:46:20+0000",
"startDate": "2017-12-28T04:41:12+0000",
"type": "one-time"
},
"userGroups": [
{
"createdTime": "2017-03-14T11:40:35+0000",
"description": "",
"name": "Network Architects",
"uniqueId": "USRGRP-37644ff5-7ea5-a3aa-e288-9c2666dc02e4"
}
],
"users": [
{
"email": "john.smith@myorganization.com",
"firstName": "John",
"id": "USR0000000018",
"lastName": "Smith",
"loginName": "John.Smith",
"mobileNumber": "802-123-4433",
"phoneNumber": ""
}
]
}
],
"timeZone": {
"code": "IST",
"id": "19",
"label": "GMT +05:30 India",
"name": "Asia/Calcutta"
},
"updatedTime": ""
}