DEdeputy
Roster

Predict-match a Roster record

Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.

post/resource/Roster/PREDICT

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api/v1
  • URL
    https://your-subdomain.deputy.deputy.com/api/v1/resource/Roster/PREDICT
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://once.deputy.com/my/oauth/login
      Token URL: https://once.deputy.com/my/oauth/access_token

Request body

Idinteger required
Datestring date-time
StartTimeinteger required
EndTimeinteger required
Mealbreakstring date-time
Slotsstring
TotalTimenumber double
Costnumber double
OperationalUnitinteger
Employeeinteger
Commentstring
Warningstring
WarningOverrideCommentstring
Publishedboolean
MatchedByTimesheetinteger
CustomFieldDatainteger
Openboolean
ApprovalRequiredboolean
ConfirmStatusinteger
ConfirmCommentstring
ConfirmByinteger
ConfirmTimeinteger
SwapStatusinteger
SwapManageByinteger
ShiftTemplateinteger
ConnectStatusinteger
ParentIdinteger
Creatorinteger
Createdstring date-time
Modifiedstring required
OperationalUnitObjectobject
EmployeeObjectobject
MatchedByTimesheetObjectobject
CustomFieldDataObjectobject
ConfirmByObjectobject
SwapManageByObjectobject
ShiftTemplateObjectobject
Parentobject
DirtyDeputecRosterLiveStateAsRosterboolean

Response

Success

Idinteger required
Datestring date-time
StartTimeinteger required
EndTimeinteger required
Mealbreakstring date-time
Slotsstring
TotalTimenumber double
Costnumber double
OperationalUnitinteger
Employeeinteger
Commentstring
Warningstring
WarningOverrideCommentstring
Publishedboolean
MatchedByTimesheetinteger
CustomFieldDatainteger
Openboolean
ApprovalRequiredboolean
ConfirmStatusinteger
ConfirmCommentstring
ConfirmByinteger
ConfirmTimeinteger
SwapStatusinteger
SwapManageByinteger
ShiftTemplateinteger
ConnectStatusinteger
ParentIdinteger
Creatorinteger
Createdstring date-time
Modifiedstring required
OperationalUnitObjectobject
EmployeeObjectobject
MatchedByTimesheetObjectobject
CustomFieldDataObjectobject
ConfirmByObjectobject
SwapManageByObjectobject
ShiftTemplateObjectobject
Parentobject
DirtyDeputecRosterLiveStateAsRosterboolean

Changes

No recorded changes to this operation across all 1 revision of this API.