POST web/admin/workforce/settings/save

No documentation available.

Request Information

Parameters

Name	Description	Additional information
inVO	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "entityType": "sample string 1",
  "entityId": "sample string 2",
  "forEmbed": true,
  "pageSuffix": "sample string 4",
  "curUserId": "sample string 5",
  "isSSO": true,
  "requestHost": "sample string 7",
  "applicationPath": "sample string 8",
  "secureApplicationPath": "sample string 9",
  "absoluteApplicationPath": "sample string 10",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 15",
  "clientOS": "sample string 16",
  "clientBuild": "sample string 17",
  "premiumAppId": "sample string 18",
  "clientWidth": 19,
  "clientHeight": 20,
  "timezone": 21,
  "payload": {
    "payPeriod": {
      "type": "sample string 1",
      "startDate": "sample string 2",
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "overtimeRules": {
      "dailyThresholdMin": 1,
      "weeklyThresholdMin": 1,
      "doubleTimeDailyMin": 1,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "breakRules": {
      "autoDeductMinutes": 1,
      "requiredAfterMin": 1,
      "lengthMin": 1,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "clockIn": {
      "earlyGraceMinutes": 1,
      "lateGraceMinutes": 1,
      "kioskEnabled": true,
      "mobileEnabled": true,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "studentHourCap": {
      "perWeekHours": 1,
      "enforceDuringTerm": true,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "interShiftRules": {
      "minGapHours": 1,
      "maxConsecutiveHours": 1,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "notifications": {
      "notifyOnNoShowMinutes": 1,
      "notifyOnOpenShifts": true,
      "notifyOnSwapRequests": true,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "publishing": {
      "autoPublish": true,
      "defaultLeadTimeDays": 1,
      "sample string 1": null,
      "sample string 2": null,
      "sample string 3": null
    },
    "sample string 1": null,
    "sample string 2": null,
    "sample string 3": null
  },
  "pageType": 0
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.payPeriod.type"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.payPeriod.startDate"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.payPeriod.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.payPeriod.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.payPeriod.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.overtimeRules.dailyThresholdMin"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.overtimeRules.weeklyThresholdMin"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.overtimeRules.doubleTimeDailyMin"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.overtimeRules.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.overtimeRules.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.overtimeRules.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.breakRules.autoDeductMinutes"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.breakRules.requiredAfterMin"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.breakRules.lengthMin"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.breakRules.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.breakRules.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.breakRules.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.earlyGraceMinutes"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.lateGraceMinutes"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.kioskEnabled"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.mobileEnabled"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.clockIn.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.studentHourCap.perWeekHours"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.studentHourCap.enforceDuringTerm"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.studentHourCap.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.studentHourCap.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.studentHourCap.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.interShiftRules.minGapHours"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.interShiftRules.maxConsecutiveHours"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.interShiftRules.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.interShiftRules.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.interShiftRules.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.notifications.notifyOnNoShowMinutes"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.notifications.notifyOnOpenShifts"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.notifications.notifyOnSwapRequests"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.notifications.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.notifications.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.notifications.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.publishing.autoPublish"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.publishing.defaultLeadTimeDays"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.publishing.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.publishing.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.publishing.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.extras[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.extras[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.extras[2].Key"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="pageType"

FrontPage
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "isDone": true,
  "code": 0,
  "message": "sample string 2",
  "data": {},
  "cachedKey": "sample string 4",
  "correlationId": "6f79fdfd-b081-4dc1-befe-a65ea931f502",
  "jwtTokenForSPA": "sample string 6",
  "jwtTokenIndexForSPA": 1
}

application/xml, text/xml

Sample:

<ResultOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Common">
  <CachedKey>sample string 4</CachedKey>
  <Code>None</Code>
  <CorrelationId>6f79fdfd-b081-4dc1-befe-a65ea931f502</CorrelationId>
  <Data />
  <IsDone>true</IsDone>
  <JwtTokenForSPA>sample string 6</JwtTokenForSPA>
  <JwtTokenIndexForSPA>1</JwtTokenIndexForSPA>
  <Message>sample string 2</Message>
</ResultOutVO>

multipart/form-data

Sample:

Sample not available.