Documents Test
Finance/Documents/Summary?stepId={stepId}
Get summary of all the documents for the step. Only a summary of file information is returned.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Documents/Summary?stepId={stepId}

URI Parameters

Parameter Name Data Type Required Notes
stepId integer N

Request Body

None.
No request body.

Response object type : Collection of DocumentSummary

Response object type Collection of DocumentSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
Category DocumentCategorySummary
ConstituentId integer
Description string N
FileName string N
FileSize integer
Id integer N
NotesSummary string
UpdatedDateTime date N 
[
  {
    "Id": 1,
    "FileName": "sample string 1",
    "UpdatedDateTime": "2025-04-24T05:00:53.8310807-07:00",
    "FileSize": 2,
    "NotesSummary": "sample string 3",
    "Category": {
      "Id": 1,
      "Description": "sample string 1",
      "ParentTableName": "sample string 2",
      "Inactive": true
    },
    "ConstituentId": 1,
    "Description": "sample string 4"
  },
  {
    "Id": 1,
    "FileName": "sample string 1",
    "UpdatedDateTime": "2025-04-24T05:00:53.8310807-07:00",
    "FileSize": 2,
    "NotesSummary": "sample string 3",
    "Category": {
      "Id": 1,
      "Description": "sample string 1",
      "ParentTableName": "sample string 2",
      "Inactive": true
    },
    "ConstituentId": 1,
    "Description": "sample string 4"
  }
]
<DocumentSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Document>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <ParentTableName>sample string 2</ParentTableName>
    </Category>
    <ConstituentId>1</ConstituentId>
    <Description>sample string 4</Description>
    <FileName>sample string 1</FileName>
    <FileSize>2</FileSize>
    <Id>1</Id>
    <NotesSummary>sample string 3</NotesSummary>
    <UpdatedDateTime>2025-04-24T05:00:53.8310807-07:00</UpdatedDateTime>
  </Document>
  <Document>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <ParentTableName>sample string 2</ParentTableName>
    </Category>
    <ConstituentId>1</ConstituentId>
    <Description>sample string 4</Description>
    <FileName>sample string 1</FileName>
    <FileSize>2</FileSize>
    <Id>1</Id>
    <NotesSummary>sample string 3</NotesSummary>
    <UpdatedDateTime>2025-04-24T05:00:53.8310807-07:00</UpdatedDateTime>
  </Document>
</DocumentSummaries>
Change Version Description Contract Old New
Property Added 15.1.3 Category has been added to DocumentSummary DocumentSummary DocumentSummary.Category
Property Added 15.1.3 ConstituentId has been added to DocumentSummary DocumentSummary DocumentSummary.ConstituentId
Property Added 15.1.3 Description has been added to DocumentSummary DocumentSummary DocumentSummary.Description
Property Added 15.1.3 NotesSummary has been added to DocumentSummary DocumentSummary DocumentSummary.NotesSummary
Property Added 15.0.0 FileSize has been added to DocumentSummary DocumentSummary DocumentSummary.FileSize