Lists Test
Reporting/Lists/Search
Search for List. Response returns custom HTTP headers: X-Page, X-Page-Size, and X-Total-Count. Default page is 1 and default page size is 50.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Reporting/Lists/Search

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : ListSearchRequest

Request object type ListSearchRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
CategoryId integer N Limit search to Lists belonging to the List Category with this id; if no id, then search all List Categories
MyListsOnly boolean Y Limit search results to Lists created by the current user.
Page integer Y Results at a specific page. Dependent on PageSize value.
PageSize integer Y The number of rows to return per page.
SearchText string 30 Y Returns search results for Lists that contain search text in their description.
ShowEmpty boolean Y If set to true, search will include Lists containing zero constituents. 
{
  "MyListsOnly": true,
  "ShowEmpty": true,
  "CategoryId": 1,
  "Page": 3,
  "PageSize": 4,
  "SearchText": "sample string 5"
}
<ListSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CategoryId>1</CategoryId>
  <MyListsOnly>true</MyListsOnly>
  <Page>3</Page>
  <PageSize>4</PageSize>
  <SearchText>sample string 5</SearchText>
  <ShowEmpty>true</ShowEmpty>
</ListSearchRequest>

Response object type : Collection of ListSummary

Response object type Collection of ListSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
Category ListCategorySummary
ConstituentCount integer
CreatedBy string
Description string
EditMode string Y
Id integer
Inactive boolean
IsDynamic boolean Y
LastUsedDateTime date 
[
  {
    "Description": "sample string 1",
    "Id": 1,
    "Category": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "ConstituentCount": 1,
    "Inactive": true,
    "CreatedBy": "sample string 2",
    "LastUsedDateTime": "2025-04-24T04:39:31.0419944-07:00",
    "IsDynamic": true,
    "EditMode": "sample string 3"
  },
  {
    "Description": "sample string 1",
    "Id": 1,
    "Category": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "ConstituentCount": 1,
    "Inactive": true,
    "CreatedBy": "sample string 2",
    "LastUsedDateTime": "2025-04-24T04:39:31.0419944-07:00",
    "IsDynamic": true,
    "EditMode": "sample string 3"
  }
]
<ListSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <List>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Category>
    <ConstituentCount>1</ConstituentCount>
    <CreatedBy>sample string 2</CreatedBy>
    <Description>sample string 1</Description>
    <EditMode>sample string 3</EditMode>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <IsDynamic>true</IsDynamic>
    <LastUsedDateTime>2025-04-24T04:39:31.0419944-07:00</LastUsedDateTime>
  </List>
  <List>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Category>
    <ConstituentCount>1</ConstituentCount>
    <CreatedBy>sample string 2</CreatedBy>
    <Description>sample string 1</Description>
    <EditMode>sample string 3</EditMode>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <IsDynamic>true</IsDynamic>
    <LastUsedDateTime>2025-04-24T04:39:31.0419944-07:00</LastUsedDateTime>
  </List>
</ListSummaries>

No entries in change log for this operation.