Update Pay Condition Rule Set

Updates the pay condition rule set with the specified ID. Cannot modify locked award-based rule sets.

Request

PUT http:///api/v2/business/{businessId}/payconditionruleset/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

The request body takes a complete CreateUpdatePayConditionRuleSetRequest resource, containing the following writable properties:

{
    "dayOfMonthEnding": "int32",
    "dayOfWeekEnding": "string",
    "description": "string",
    "name": "string",
    "periodEnding": "date-time",
    "periodType": "string",
    "shiftConsolidationMinutes": "int32",
    "shiftConsolidationOption": "string"
}

Properties

Name Type Description
dayOfMonthEnding int32 Nullable
dayOfWeekEnding string Nullable

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
description string String
name string String
periodEnding date-time Nullable
periodType string RuleSetPeriodType

Possible values are:

  • Weekly
  • Fortnightly
  • Monthly
  • CalendarMonth
  • FourWeekly
  • SixWeekly
  • ThreeWeekly
  • EightWeekly
shiftConsolidationMinutes int32 Nullable
shiftConsolidationOption string ShiftConsolidationOption

Possible values are:

  • None
  • Duration
  • SameDay

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 SgPayConditionRuleSetApiModel
400 Bad Request

Bad Request

 ProblemDetails
404 Not Found

Not Found

 ProblemDetails