ReportSchedules Test
Reporting/ReportSchedules?activeOnly={activeOnly}
Get all report schedules, optionally filtered by active only.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Reporting/ReportSchedules?activeOnly={activeOnly}

URI Parameters

Parameter Name Data Type Required Notes
activeOnly boolean N

Request Body

None.
No request body.

Response object type : Collection of ReportSchedule

Response object type Collection of ReportSchedule has the following properties.
Property Name Data Type Length Required Readonly Notes
AsOfDateTime date N
ControlGroup ControlGroupSummary N
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
DayOfWeek integer N
DayWeekNumber integer N
EndDate date N
EndTime date N
HeaderRequest ReportRequest N
Id integer N
Inactive boolean N
Interval integer N
Name string N
StartDate date N
StartTime date N
Type string N
UpdatedBy string N
UpdatedDateTime date N 
[
  {
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "DayOfWeek": 1,
    "DayWeekNumber": 2,
    "EndDate": "2025-04-24T05:01:00.9773303-07:00",
    "EndTime": "2025-04-24T05:01:00.9773303-07:00",
    "Id": 3,
    "Inactive": true,
    "Interval": 5,
    "Name": "sample string 6",
    "HeaderRequest": {
      "Id": 1,
      "DeletedIndicator": true,
      "EmailBody": "sample string 3",
      "EmailRecipients": "sample string 4",
      "EmailSubject": "sample string 5",
      "EndDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "OutputOption": "sample string 6",
      "PublicIndicator": true,
      "ReportId": "sample string 8",
      "ReportType": 9,
      "RequestDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "ResultCode": "sample string 11",
      "ResultText": "sample string 12",
      "Type": "sample string 13",
      "QueueStatus": "sample string 14",
      "ScheduleId": 1,
      "UserGroupId": "sample string 15",
      "UserId": "sample string 16",
      "CreatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "CreateLocation": "sample string 17",
      "CreatedBy": "sample string 18",
      "UpdatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "UpdatedBy": "sample string 19",
      "Parameters": [
        {
          "RequestId": 1,
          "ReportId": "sample string 1",
          "ParameterId": 2,
          "Value": "sample string 3"
        },
        {
          "RequestId": 1,
          "ReportId": "sample string 1",
          "ParameterId": 2,
          "Value": "sample string 3"
        }
      ]
    },
    "StartDate": "2025-04-24T05:01:00.9773303-07:00",
    "StartTime": "2025-04-24T05:01:00.9773303-07:00",
    "AsOfDateTime": "2025-04-24T05:01:00.9773303-07:00",
    "Type": "sample string 7",
    "CreatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
    "CreateLocation": "sample string 8",
    "CreatedBy": "sample string 9",
    "UpdatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
    "UpdatedBy": "sample string 10"
  },
  {
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "DayOfWeek": 1,
    "DayWeekNumber": 2,
    "EndDate": "2025-04-24T05:01:00.9773303-07:00",
    "EndTime": "2025-04-24T05:01:00.9773303-07:00",
    "Id": 3,
    "Inactive": true,
    "Interval": 5,
    "Name": "sample string 6",
    "HeaderRequest": {
      "Id": 1,
      "DeletedIndicator": true,
      "EmailBody": "sample string 3",
      "EmailRecipients": "sample string 4",
      "EmailSubject": "sample string 5",
      "EndDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "OutputOption": "sample string 6",
      "PublicIndicator": true,
      "ReportId": "sample string 8",
      "ReportType": 9,
      "RequestDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "ResultCode": "sample string 11",
      "ResultText": "sample string 12",
      "Type": "sample string 13",
      "QueueStatus": "sample string 14",
      "ScheduleId": 1,
      "UserGroupId": "sample string 15",
      "UserId": "sample string 16",
      "CreatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "CreateLocation": "sample string 17",
      "CreatedBy": "sample string 18",
      "UpdatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
      "UpdatedBy": "sample string 19",
      "Parameters": [
        {
          "RequestId": 1,
          "ReportId": "sample string 1",
          "ParameterId": 2,
          "Value": "sample string 3"
        },
        {
          "RequestId": 1,
          "ReportId": "sample string 1",
          "ParameterId": 2,
          "Value": "sample string 3"
        }
      ]
    },
    "StartDate": "2025-04-24T05:01:00.9773303-07:00",
    "StartTime": "2025-04-24T05:01:00.9773303-07:00",
    "AsOfDateTime": "2025-04-24T05:01:00.9773303-07:00",
    "Type": "sample string 7",
    "CreatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
    "CreateLocation": "sample string 8",
    "CreatedBy": "sample string 9",
    "UpdatedDateTime": "2025-04-24T05:01:00.9773303-07:00",
    "UpdatedBy": "sample string 10"
  }
]
<ReportSchedules xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ReportSchedule>
    <AsOfDateTime>2025-04-24T05:01:00.9773303-07:00</AsOfDateTime>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <CreateLocation>sample string 8</CreateLocation>
    <CreatedBy>sample string 9</CreatedBy>
    <CreatedDateTime>2025-04-24T05:01:00.9773303-07:00</CreatedDateTime>
    <DayOfWeek>1</DayOfWeek>
    <DayWeekNumber>2</DayWeekNumber>
    <EndDate>2025-04-24T05:01:00.9773303-07:00</EndDate>
    <EndTime>2025-04-24T05:01:00.9773303-07:00</EndTime>
    <HeaderRequest>
      <CreateLocation>sample string 17</CreateLocation>
      <CreatedBy>sample string 18</CreatedBy>
      <CreatedDateTime>2025-04-24T05:01:00.9773303-07:00</CreatedDateTime>
      <DeletedIndicator>true</DeletedIndicator>
      <EmailBody>sample string 3</EmailBody>
      <EmailRecipients>sample string 4</EmailRecipients>
      <EmailSubject>sample string 5</EmailSubject>
      <EndDateTime>2025-04-24T05:01:00.9773303-07:00</EndDateTime>
      <Id>1</Id>
      <OutputOption>sample string 6</OutputOption>
      <Parameters>
        <ReportRequestParameter>
          <ParameterId>2</ParameterId>
          <ReportId>sample string 1</ReportId>
          <RequestId>1</RequestId>
          <Value>sample string 3</Value>
        </ReportRequestParameter>
        <ReportRequestParameter>
          <ParameterId>2</ParameterId>
          <ReportId>sample string 1</ReportId>
          <RequestId>1</RequestId>
          <Value>sample string 3</Value>
        </ReportRequestParameter>
      </Parameters>
      <PublicIndicator>true</PublicIndicator>
      <QueueStatus>sample string 14</QueueStatus>
      <ReportId>sample string 8</ReportId>
      <ReportType>9</ReportType>
      <RequestDateTime>2025-04-24T05:01:00.9773303-07:00</RequestDateTime>
      <ResultCode>sample string 11</ResultCode>
      <ResultText>sample string 12</ResultText>
      <ScheduleId>1</ScheduleId>
      <Type>sample string 13</Type>
      <UpdatedBy>sample string 19</UpdatedBy>
      <UpdatedDateTime>2025-04-24T05:01:00.9773303-07:00</UpdatedDateTime>
      <UserGroupId>sample string 15</UserGroupId>
      <UserId>sample string 16</UserId>
    </HeaderRequest>
    <Id>3</Id>
    <Inactive>true</Inactive>
    <Interval>5</Interval>
    <Name>sample string 6</Name>
    <StartDate>2025-04-24T05:01:00.9773303-07:00</StartDate>
    <StartTime>2025-04-24T05:01:00.9773303-07:00</StartTime>
    <Type>sample string 7</Type>
    <UpdatedBy>sample string 10</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:01:00.9773303-07:00</UpdatedDateTime>
  </ReportSchedule>
  <ReportSchedule>
    <AsOfDateTime>2025-04-24T05:01:00.9773303-07:00</AsOfDateTime>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <CreateLocation>sample string 8</CreateLocation>
    <CreatedBy>sample string 9</CreatedBy>
    <CreatedDateTime>2025-04-24T05:01:00.9773303-07:00</CreatedDateTime>
    <DayOfWeek>1</DayOfWeek>
    <DayWeekNumber>2</DayWeekNumber>
    <EndDate>2025-04-24T05:01:00.9773303-07:00</EndDate>
    <EndTime>2025-04-24T05:01:00.9773303-07:00</EndTime>
    <HeaderRequest>
      <CreateLocation>sample string 17</CreateLocation>
      <CreatedBy>sample string 18</CreatedBy>
      <CreatedDateTime>2025-04-24T05:01:00.9773303-07:00</CreatedDateTime>
      <DeletedIndicator>true</DeletedIndicator>
      <EmailBody>sample string 3</EmailBody>
      <EmailRecipients>sample string 4</EmailRecipients>
      <EmailSubject>sample string 5</EmailSubject>
      <EndDateTime>2025-04-24T05:01:00.9773303-07:00</EndDateTime>
      <Id>1</Id>
      <OutputOption>sample string 6</OutputOption>
      <Parameters>
        <ReportRequestParameter>
          <ParameterId>2</ParameterId>
          <ReportId>sample string 1</ReportId>
          <RequestId>1</RequestId>
          <Value>sample string 3</Value>
        </ReportRequestParameter>
        <ReportRequestParameter>
          <ParameterId>2</ParameterId>
          <ReportId>sample string 1</ReportId>
          <RequestId>1</RequestId>
          <Value>sample string 3</Value>
        </ReportRequestParameter>
      </Parameters>
      <PublicIndicator>true</PublicIndicator>
      <QueueStatus>sample string 14</QueueStatus>
      <ReportId>sample string 8</ReportId>
      <ReportType>9</ReportType>
      <RequestDateTime>2025-04-24T05:01:00.9773303-07:00</RequestDateTime>
      <ResultCode>sample string 11</ResultCode>
      <ResultText>sample string 12</ResultText>
      <ScheduleId>1</ScheduleId>
      <Type>sample string 13</Type>
      <UpdatedBy>sample string 19</UpdatedBy>
      <UpdatedDateTime>2025-04-24T05:01:00.9773303-07:00</UpdatedDateTime>
      <UserGroupId>sample string 15</UserGroupId>
      <UserId>sample string 16</UserId>
    </HeaderRequest>
    <Id>3</Id>
    <Inactive>true</Inactive>
    <Interval>5</Interval>
    <Name>sample string 6</Name>
    <StartDate>2025-04-24T05:01:00.9773303-07:00</StartDate>
    <StartTime>2025-04-24T05:01:00.9773303-07:00</StartTime>
    <Type>sample string 7</Type>
    <UpdatedBy>sample string 10</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:01:00.9773303-07:00</UpdatedDateTime>
  </ReportSchedule>
</ReportSchedules>
Change Version Description Contract Old New
Property Added 15.1.0 AsOfDateTime has been added to ReportSchedule ReportSchedule ReportSchedule.AsOfDateTime
Resource Added 15.0.0 New resource added. ReportSchedules