PUT api/Admin/ForceSchedulingStatus

Forces Scheduling Statuses as per the input details

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ParentChanges	Array of changes to make to Schedule Parents	Collection of SchedulingStatusChange_ScheduleParent	None.
GroupChanges	Array of changes to make to Schedule Groups	Collection of SchedulingStatusChange_ScheduleGroup	None.
StepChanges	Array of changes to make to Schedule Steps	Collection of SchedulingStatusChange_ScheduleStep	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "ParentChanges": [
    {
      "ScheduleID": 1,
      "StatusToSet": 1,
      "ErrorStatusToSet": 0
    },
    {
      "ScheduleID": 1,
      "StatusToSet": 1,
      "ErrorStatusToSet": 0
    }
  ],
  "GroupChanges": [
    {
      "GroupID": 1,
      "StatusToSet": 0,
      "ErrorStatusToSet": 0
    },
    {
      "GroupID": 1,
      "StatusToSet": 0,
      "ErrorStatusToSet": 0
    }
  ],
  "StepChanges": [
    {
      "StepID": 1,
      "StatusToSet": 1,
      "ErrorStatusToSet": 0,
      "ErrorDescriptionToSet": 0,
      "ClearStartTimeFlag": true
    },
    {
      "StepID": 1,
      "StatusToSet": 1,
      "ErrorStatusToSet": 0,
      "ErrorDescriptionToSet": 0,
      "ClearStartTimeFlag": true
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SchedulingStatusChange'.

Response Information

Resource Description

Response indicating if it was successful

GetBooleanResponse

Name	Description	Type	Additional information
Bool	The boolean result	boolean	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2026-01-09T23:46:51.1431153+10:00",
    "BuildDateUTC": "2026-01-09T23:46:51.1431153+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Bool": true
}