ContactPermissions Test
CRM/ContactPermissions/ForTransaction
Request a set of contact permissions relevant to an order or contribution context. Send request with ReturnRequiredOnly to true to only send back permissions that require constituent ask.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/ContactPermissions/ForTransaction

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : ContactPermissionsTransactionRequest

Request object type ContactPermissionsTransactionRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
InitiatorId integer N
OwnerId integer Y
ProductionSeasonIds string N
ReturnRequiredOnly boolean Y 
{
  "OwnerId": 1,
  "InitiatorId": 1,
  "ProductionSeasonIds": "sample string 2",
  "ReturnRequiredOnly": true
}
<ContactPermissionsTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <InitiatorId>1</InitiatorId>
  <OwnerId>1</OwnerId>
  <ProductionSeasonIds>sample string 2</ProductionSeasonIds>
  <ReturnRequiredOnly>true</ReturnRequiredOnly>
</ContactPermissionsTransactionRequest>

Response object type : Collection of ContactPermission

Response object type Collection of ContactPermission has the following properties.
Property Name Data Type Length Required Readonly Notes
Answer string N
Constituent Entity Y
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
EditIndicator boolean N Auto-assigned
Id integer N Auto-assigned
LastAskedDateTime date N
ShouldAsk boolean N readonly Whether constituent should be asked for this permission type. This is generated by the service and should not be included in a PUT or POST.
Type ContactPermissionTypeSummary Y
FK: TR_CONTACT_PERM_TYPE.id   Resource: ContactPermissionTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned 
[
  {
    "Answer": "sample string 1",
    "CreatedDateTime": "2025-04-24T05:01:01.9875899-07:00",
    "CreateLocation": "sample string 2",
    "CreatedBy": "sample string 3",
    "Constituent": {
      "Id": 1
    },
    "Id": 1,
    "LastAskedDateTime": "2025-04-24T05:01:01.9875899-07:00",
    "ShouldAsk": true,
    "UpdatedDateTime": "2025-04-24T05:01:01.9875899-07:00",
    "UpdatedBy": "sample string 5",
    "Type": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "Category": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "AskFrequencyMonths": 1
      },
      "Presenter": true,
      "Rank": 4,
      "DefaultValueForAdd": "sample string 5",
      "EditIndicator": true
    },
    "EditIndicator": true
  },
  {
    "Answer": "sample string 1",
    "CreatedDateTime": "2025-04-24T05:01:01.9875899-07:00",
    "CreateLocation": "sample string 2",
    "CreatedBy": "sample string 3",
    "Constituent": {
      "Id": 1
    },
    "Id": 1,
    "LastAskedDateTime": "2025-04-24T05:01:01.9875899-07:00",
    "ShouldAsk": true,
    "UpdatedDateTime": "2025-04-24T05:01:01.9875899-07:00",
    "UpdatedBy": "sample string 5",
    "Type": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "Category": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "AskFrequencyMonths": 1
      },
      "Presenter": true,
      "Rank": 4,
      "DefaultValueForAdd": "sample string 5",
      "EditIndicator": true
    },
    "EditIndicator": true
  }
]
<ContactPermissions xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ContactPermission>
    <Answer>sample string 1</Answer>
    <Constituent>
      <Id>1</Id>
    </Constituent>
    <CreateLocation>sample string 2</CreateLocation>
    <CreatedBy>sample string 3</CreatedBy>
    <CreatedDateTime>2025-04-24T05:01:01.9875899-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <LastAskedDateTime>2025-04-24T05:01:01.9875899-07:00</LastAskedDateTime>
    <ShouldAsk>true</ShouldAsk>
    <Type>
      <Category>
        <AskFrequencyMonths>1</AskFrequencyMonths>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </Category>
      <DefaultValueForAdd>sample string 5</DefaultValueForAdd>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <Presenter>true</Presenter>
      <Rank>4</Rank>
    </Type>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:01:01.9875899-07:00</UpdatedDateTime>
  </ContactPermission>
  <ContactPermission>
    <Answer>sample string 1</Answer>
    <Constituent>
      <Id>1</Id>
    </Constituent>
    <CreateLocation>sample string 2</CreateLocation>
    <CreatedBy>sample string 3</CreatedBy>
    <CreatedDateTime>2025-04-24T05:01:01.9875899-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <LastAskedDateTime>2025-04-24T05:01:01.9875899-07:00</LastAskedDateTime>
    <ShouldAsk>true</ShouldAsk>
    <Type>
      <Category>
        <AskFrequencyMonths>1</AskFrequencyMonths>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </Category>
      <DefaultValueForAdd>sample string 5</DefaultValueForAdd>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <Presenter>true</Presenter>
      <Rank>4</Rank>
    </Type>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:01:01.9875899-07:00</UpdatedDateTime>
  </ContactPermission>
</ContactPermissions>

No entries in change log for this operation.