Resource Details

Steps Test

Finance/Steps?planId={planId}&constituentId={constituentId}&includeAffiliations={includeAffiliations}&associateId={associateId}&includeAssociates={includeAssociates}

Get details of all the steps for the specified plan, constituent or associate.

Http Verb	GET
Resource URL	https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Steps?planId={planId}&constituentId={constituentId}&includeAffiliations={includeAffiliations}&associateId={associateId}&includeAssociates={includeAssociates}

URI Parameters

Parameter Name	Data Type	Required	Notes
planId	integer	N
constituentId	integer	N	Limit results by constituent.
includeAffiliations	boolean	N	Include all of the constituent's affiliates in the results (default: true).
associateId	integer	N
includeAssociates	boolean	N

Request Body

None.

No request body.

Response object type : Collection of Step

Response object type Collection of Step has the following properties.

Property Name	Data Type	Required
Associate	ConstituentDisplaySummary	N
Associate	FK: T_CUSTOMER.customer_no Resource: Constituents
CompletedOnDateTime	date	N
CreatedBy	string	N
CreatedDateTime	date	N
CreateLocation	string	N
Description	string	N
DueDateTime	date	N
EditIndicator	boolean
Id	integer	N
NewValue	string	N
Notes	string	N
OldValue	string	N
Plan	PlanSummary	N
Plan	FK: T_PLAN.plan_no Resource: Plans
Priority	integer	N
StepDateTime	date	N
Type	StepTypeSummary	N
Type	FK: TR_STEP_TYPE.id Resource: StepTypes
UpdatedBy	string	N
UpdatedDateTime	date	N
WarningDays	integer	N
Worker	ConstituentShortDisplayNameSummary	N
Worker	FK: T_CUSTOMER.customer_no Resource: Constituents

application/json, text/json
application/xml, text/xml

[
  {
    "Associate": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Id": 1,
    "CompletedOnDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "CreatedDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "DueDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "UpdatedDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "UpdatedBy": "sample string 3",
    "NewValue": "sample string 4",
    "Description": "sample string 5",
    "Notes": "sample string 6",
    "OldValue": "sample string 7",
    "Plan": {
      "Campaign": {
        "Id": 1,
        "Description": "sample string 1",
        "FYear": 1,
        "Inactive": true,
        "MembershipOrganization": {
          "Description": "sample string 1",
          "Id": 1,
          "EditIndicator": true
        }
      },
      "ContributionDesignation": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      },
      "Constituent": {
        "Id": 1,
        "SortName": "sample string 1",
        "DisplayName": "sample string 2"
      },
      "Fund": {
        "Description": "sample string 1",
        "Id": 1,
        "BusinessUnitId": 1,
        "Inactive": true,
        "TicketingIndicator": true,
        "EditIndicator": true,
        "ConstituencyId": 3
      },
      "Id": 1
    },
    "Type": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "AllowAttachments": "sample string 2",
      "UseCompletedOnDateTime": "sample string 3",
      "UseDueDateTime": "sample string 4"
    },
    "Priority": 1,
    "StepDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "WarningDays": 1,
    "Worker": {
      "Id": 1,
      "SortName": "sample string 1",
      "ShortDisplayName": "sample string 2"
    },
    "EditIndicator": true
  },
  {
    "Associate": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Id": 1,
    "CompletedOnDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "CreatedDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "DueDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "UpdatedDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "UpdatedBy": "sample string 3",
    "NewValue": "sample string 4",
    "Description": "sample string 5",
    "Notes": "sample string 6",
    "OldValue": "sample string 7",
    "Plan": {
      "Campaign": {
        "Id": 1,
        "Description": "sample string 1",
        "FYear": 1,
        "Inactive": true,
        "MembershipOrganization": {
          "Description": "sample string 1",
          "Id": 1,
          "EditIndicator": true
        }
      },
      "ContributionDesignation": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      },
      "Constituent": {
        "Id": 1,
        "SortName": "sample string 1",
        "DisplayName": "sample string 2"
      },
      "Fund": {
        "Description": "sample string 1",
        "Id": 1,
        "BusinessUnitId": 1,
        "Inactive": true,
        "TicketingIndicator": true,
        "EditIndicator": true,
        "ConstituencyId": 3
      },
      "Id": 1
    },
    "Type": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "AllowAttachments": "sample string 2",
      "UseCompletedOnDateTime": "sample string 3",
      "UseDueDateTime": "sample string 4"
    },
    "Priority": 1,
    "StepDateTime": "2025-04-24T05:03:17.3798198-07:00",
    "WarningDays": 1,
    "Worker": {
      "Id": 1,
      "SortName": "sample string 1",
      "ShortDisplayName": "sample string 2"
    },
    "EditIndicator": true
  }
]

<Steps xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Step>
    <Associate>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Associate>
    <CompletedOnDateTime>2025-04-24T05:03:17.3798198-07:00</CompletedOnDateTime>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:03:17.3798198-07:00</CreatedDateTime>
    <Description>sample string 5</Description>
    <DueDateTime>2025-04-24T05:03:17.3798198-07:00</DueDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <NewValue>sample string 4</NewValue>
    <Notes>sample string 6</Notes>
    <OldValue>sample string 7</OldValue>
    <Plan>
      <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>
      <Constituent>
        <DisplayName>sample string 2</DisplayName>
        <Id>1</Id>
        <SortName>sample string 1</SortName>
      </Constituent>
      <ContributionDesignation>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </ContributionDesignation>
      <Fund>
        <BusinessUnitId>1</BusinessUnitId>
        <ConstituencyId>3</ConstituencyId>
        <Description>sample string 1</Description>
        <EditIndicator>true</EditIndicator>
        <Id>1</Id>
        <Inactive>true</Inactive>
        <TicketingIndicator>true</TicketingIndicator>
      </Fund>
      <Id>1</Id>
    </Plan>
    <Priority>1</Priority>
    <StepDateTime>2025-04-24T05:03:17.3798198-07:00</StepDateTime>
    <Type>
      <AllowAttachments>sample string 2</AllowAttachments>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
      <UseDueDateTime>sample string 4</UseDueDateTime>
    </Type>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:03:17.3798198-07:00</UpdatedDateTime>
    <WarningDays>1</WarningDays>
    <Worker>
      <Id>1</Id>
      <ShortDisplayName>sample string 2</ShortDisplayName>
      <SortName>sample string 1</SortName>
    </Worker>
  </Step>
  <Step>
    <Associate>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Associate>
    <CompletedOnDateTime>2025-04-24T05:03:17.3798198-07:00</CompletedOnDateTime>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:03:17.3798198-07:00</CreatedDateTime>
    <Description>sample string 5</Description>
    <DueDateTime>2025-04-24T05:03:17.3798198-07:00</DueDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <NewValue>sample string 4</NewValue>
    <Notes>sample string 6</Notes>
    <OldValue>sample string 7</OldValue>
    <Plan>
      <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>
      <Constituent>
        <DisplayName>sample string 2</DisplayName>
        <Id>1</Id>
        <SortName>sample string 1</SortName>
      </Constituent>
      <ContributionDesignation>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </ContributionDesignation>
      <Fund>
        <BusinessUnitId>1</BusinessUnitId>
        <ConstituencyId>3</ConstituencyId>
        <Description>sample string 1</Description>
        <EditIndicator>true</EditIndicator>
        <Id>1</Id>
        <Inactive>true</Inactive>
        <TicketingIndicator>true</TicketingIndicator>
      </Fund>
      <Id>1</Id>
    </Plan>
    <Priority>1</Priority>
    <StepDateTime>2025-04-24T05:03:17.3798198-07:00</StepDateTime>
    <Type>
      <AllowAttachments>sample string 2</AllowAttachments>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
      <UseDueDateTime>sample string 4</UseDueDateTime>
    </Type>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:03:17.3798198-07:00</UpdatedDateTime>
    <WarningDays>1</WarningDays>
    <Worker>
      <Id>1</Id>
      <ShortDisplayName>sample string 2</ShortDisplayName>
      <SortName>sample string 1</SortName>
    </Worker>
  </Step>
</Steps>

No entries in change log for this operation.