Campaigns Test
Finance/Campaigns/Summary?activeOnly={activeOnly}
Return a collection of all campaigns in summary, optionally excluding inactive campaigns.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Campaigns/Summary?activeOnly={activeOnly}

URI Parameters

Parameter Name Data Type Required Notes
activeOnly boolean N Return only active campaigns. Default is to return all campaigns.

Request Body

None.
No request body.

Response object type : Collection of CampaignSummary

Response object type Collection of CampaignSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
Description string N
FYear integer N
Id integer N
Inactive boolean N
MembershipOrganization MembershipOrganizationSummary N
FK: T_MEMB_ORG.memb_org_no   Resource: MembershipOrganizations 
[
  {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true,
    "MembershipOrganization": {
      "Description": "sample string 1",
      "Id": 1,
      "EditIndicator": true
    }
  },
  {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true,
    "MembershipOrganization": {
      "Description": "sample string 1",
      "Id": 1,
      "EditIndicator": true
    }
  }
]
<CampaignSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Campaign>
    <Description>sample string 1</Description>
    <FYear>1</FYear>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <MembershipOrganization>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
    </MembershipOrganization>
  </Campaign>
  <Campaign>
    <Description>sample string 1</Description>
    <FYear>1</FYear>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <MembershipOrganization>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
    </MembershipOrganization>
  </Campaign>
</CampaignSummaries>
Change Version Description Contract Old New
Parameter Added 15.0.0 New parameter added activeOnly activeOnly