ConstituentDocuments Test
CRM/Documents/{documentId}
Update an existing document for a constituent.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Documents/{documentId}

URI Parameters

Parameter Name Data Type Required Notes
documentId integer Y

Request Body

Request object type : Document

Request object type Document has the following properties.
Property Name Data Type Length Required Readonly Notes
Category DocumentCategorySummary Y
ConstituentId integer N
Contents Collection of byte N
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 N
FileName string 255 Y
Id integer Y Non-updatable
Notes string 8000 N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "Id": 1,
  "Contents": "QEA=",
  "FileName": "sample string 1",
  "Description": "sample string 2",
  "Notes": "sample string 3",
  "Category": {
    "Id": 1,
    "Description": "sample string 1",
    "ParentTableName": "sample string 2",
    "Inactive": true
  },
  "ConstituentId": 1,
  "CreatedDateTime": "2025-04-24T05:03:22.8549479-07:00",
  "CreateLocation": "sample string 4",
  "CreatedBy": "sample string 5",
  "UpdatedDateTime": "2025-04-24T05:03:22.8549479-07:00",
  "UpdatedBy": "sample string 6"
}
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ParentTableName>sample string 2</ParentTableName>
  </Category>
  <ConstituentId>1</ConstituentId>
  <Contents>QEA=</Contents>
  <CreateLocation>sample string 4</CreateLocation>
  <CreatedBy>sample string 5</CreatedBy>
  <CreatedDateTime>2025-04-24T05:03:22.8549479-07:00</CreatedDateTime>
  <Description>sample string 2</Description>
  <FileName>sample string 1</FileName>
  <Id>1</Id>
  <Notes>sample string 3</Notes>
  <UpdatedBy>sample string 6</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:03:22.8549479-07:00</UpdatedDateTime>
</Document>

Response object type : Document

Response object type Document has the following properties.
Property Name Data Type Length Required Readonly Notes
Category DocumentCategorySummary Y
ConstituentId integer N
Contents Collection of byte N
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 N
FileName string 255 Y
Id integer Y Non-updatable
Notes string 8000 N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "Id": 1,
  "Contents": "QEA=",
  "FileName": "sample string 1",
  "Description": "sample string 2",
  "Notes": "sample string 3",
  "Category": {
    "Id": 1,
    "Description": "sample string 1",
    "ParentTableName": "sample string 2",
    "Inactive": true
  },
  "ConstituentId": 1,
  "CreatedDateTime": "2025-04-24T05:03:22.8549479-07:00",
  "CreateLocation": "sample string 4",
  "CreatedBy": "sample string 5",
  "UpdatedDateTime": "2025-04-24T05:03:22.8549479-07:00",
  "UpdatedBy": "sample string 6"
}
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ParentTableName>sample string 2</ParentTableName>
  </Category>
  <ConstituentId>1</ConstituentId>
  <Contents>QEA=</Contents>
  <CreateLocation>sample string 4</CreateLocation>
  <CreatedBy>sample string 5</CreatedBy>
  <CreatedDateTime>2025-04-24T05:03:22.8549479-07:00</CreatedDateTime>
  <Description>sample string 2</Description>
  <FileName>sample string 1</FileName>
  <Id>1</Id>
  <Notes>sample string 3</Notes>
  <UpdatedBy>sample string 6</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:03:22.8549479-07:00</UpdatedDateTime>
</Document>
Change Version Description Contract Old New
Resource Added 15.1.3 New resource added. ConstituentDocuments