PUT api/Timetables

Update a Timetable

Request Information

URI Parameters

None.

Body Parameters

The Timetable to be updated

Name	Description	Type	Additional information
ID	The Timetable ID	integer	None.
Name	The name of the Timetable	string	None.
Description	Description of the Timetable	string	None.
Enable	Whether or not this is enabled	boolean	None.
Time	The Time for the Timetable Entry to take effect	time interval	None.
DaySelection	A selection of Days that this Timetable Entry will occur on	byte	None.
UserName	The UserName of the User this Entry is for	string	None.
ApprovalPeriod	The time period prior to starting for approving the timetable	time interval	None.
TargetID	The Integer ID of the object that is acted upon in this Entry	integer	None.
TargetType	The Type of target this is for, i.e. Program or Schedule. Schedule will be removed from this list once Programs are officially introduced.	TimetableTargetType	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Enable": true,
  "Time": "00:00:00.1234567",
  "DaySelection": 64,
  "UserName": "sample string 4",
  "ApprovalPeriod": "00:00:00.1234567",
  "TargetID": 1,
  "TargetType": 0
}

application/xml, text/xml

Sample:

<APIStructs.Update_Timetable xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <ApprovalPeriod>PT0.1234567S</ApprovalPeriod>
  <DaySelection>64</DaySelection>
  <Description>sample string 3</Description>
  <Enable>true</Enable>
  <ID>1</ID>
  <Name>sample string 2</Name>
  <TargetID>1</TargetID>
  <TargetType>Program</TargetType>
  <Time>PT0.1234567S</Time>
  <UserName>sample string 4</UserName>
</APIStructs.Update_Timetable>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the updated timetable and messages

GetTimetablesResponse

Name	Description	Type	Additional information
Timetables	Array of Timetables	Collection of Timetable	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:

{
  "Timetables": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Enable": true,
      "Time": "00:00:00.1234567",
      "DaySelection": 64,
      "UserName": "sample string 7",
      "LastApprovedRun": "2025-11-09T21:42:35.3506306+10:00",
      "NextRun": "2025-11-09T21:42:35.3506306+10:00",
      "ApprovalPeriod": "00:00:00.1234567",
      "TargetID": 9,
      "TargetType": 0
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Enable": true,
      "Time": "00:00:00.1234567",
      "DaySelection": 64,
      "UserName": "sample string 7",
      "LastApprovedRun": "2025-11-09T21:42:35.3506306+10:00",
      "NextRun": "2025-11-09T21:42:35.3506306+10:00",
      "ApprovalPeriod": "00:00:00.1234567",
      "TargetID": 9,
      "TargetType": 0
    }
  ],
  "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": "2025-11-09T21:42:35.3506306+10:00",
    "BuildDateUTC": "2025-11-09T21:42:35.3506306+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:

<GetTimetablesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:42:35.3506306+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:42:35.3506306+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <Timetables xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.Timetable>
      <d2p1:ApprovalPeriod>PT0.1234567S</d2p1:ApprovalPeriod>
      <d2p1:DaySelection>64</d2p1:DaySelection>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Enable>true</d2p1:Enable>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:LastApprovedRun>2025-11-09T21:42:35.3506306+10:00</d2p1:LastApprovedRun>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:NextRun>2025-11-09T21:42:35.3506306+10:00</d2p1:NextRun>
      <d2p1:TargetID>9</d2p1:TargetID>
      <d2p1:TargetType>Program</d2p1:TargetType>
      <d2p1:Time>PT0.1234567S</d2p1:Time>
      <d2p1:UserName>sample string 7</d2p1:UserName>
    </d2p1:APIStructs.Timetable>
    <d2p1:APIStructs.Timetable>
      <d2p1:ApprovalPeriod>PT0.1234567S</d2p1:ApprovalPeriod>
      <d2p1:DaySelection>64</d2p1:DaySelection>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Enable>true</d2p1:Enable>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:LastApprovedRun>2025-11-09T21:42:35.3506306+10:00</d2p1:LastApprovedRun>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:NextRun>2025-11-09T21:42:35.3506306+10:00</d2p1:NextRun>
      <d2p1:TargetID>9</d2p1:TargetID>
      <d2p1:TargetType>Program</d2p1:TargetType>
      <d2p1:Time>PT0.1234567S</d2p1:Time>
      <d2p1:UserName>sample string 7</d2p1:UserName>
    </d2p1:APIStructs.Timetable>
  </Timetables>
</GetTimetablesResponse>