Viviot.Api

<back to all web services

GetShifts

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TeamAdmin
The following routes are available for this service:
GET/shiftsGets existing shifts.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ShiftResponse Parameters:
NameParameterData TypeRequiredDescription
ShiftsformList<ShiftDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ShiftDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
OrganizationIdformGuidNo
NameformstringNo
TeamIdformGuid?No
StartTimeOffsetformintNo
EndTimeOffsetformintNo
StartDateformDateTime?No
EndDateformDateTime?No
ShiftMembersformList<ShiftMemberDto>No
ShiftMemberDto Parameters:
NameParameterData TypeRequiredDescription
BusinessUserIdformintNo
FirstNameformstringNo
LastNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /shifts HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	shifts: 
	[
		{
			id: 00000000000000000000000000000000,
			organizationId: 00000000000000000000000000000000,
			name: String,
			teamId: 00000000000000000000000000000000,
			startTimeOffset: 0,
			endTimeOffset: 0,
			startDate: -62135596800000,
			endDate: -62135596800000,
			shiftMembers: 
			[
				{
					businessUserId: 0,
					firstName: String,
					lastName: String
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}