Viviot.Api

<back to all web services

InsertShift

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TeamAdmin
The following routes are available for this service:
POST/shiftInsert a new shift.
InsertShift Parameters:
NameParameterData TypeRequiredDescription
NamebodystringYesThe shift name.
TeamIdbodystringNoID of a team that this shift is optionally linked to.
StartTimeOffsetbodyintYesStart time of the shift as offset from 00:00 AM in minutes.
EndTimeOffsetbodystringYesDuration of shift in minutes.
StartDatebodystringNoDate when the shift becomes valid. If not set, there is no starting date.
EndDatebodystringNoDate when the shift becomes invalid. If not set, the shift remains valid indefinitely.
ShiftMembersbodyarrayNoIDs of shift members.
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /shift HTTP/1.1 
Host: api.4spaces.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"name":"String","teamId":"00000000000000000000000000000000","startTimeOffset":0,"endTimeOffset":0,"startDate":-62135596800000,"endDate":-62135596800000,"shiftMembers":[0],"version":0}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}