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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'ShiftResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)