A

AccountTypes
get put

Create a new account type.

Usage:
tq post AccountTypes
Query:
{"CardLength":"string", "CardPrefix":"string", "CardtypeIndicator":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditMask":"string", "Id":123, "Inactive":true, "Mod10Indicator":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CardLength":"string","CardPrefix":"string","CardtypeIndicator":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditMask":"string","Id":123,"Inactive":true,"Mod10Indicator":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CardLength,CardPrefix,CardtypeIndicator,CreateLocation,CreatedBy,CreatedDateTime,Description,EditMask,Id,Inactive,Mod10Indicator,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

Accounts
get put

Create a credit card account, storing the card number. Will create and store a token if tokenization is enabled.

Usage:
tq post Accounts
Query:
{"AccountNumber":"string", "CardExpiryMonth":123, "CardExpiryYear":123, "ConstituentId":123, "ExclusiveToControlledBatchId":123, "Inactive":true, "Name":"string", "PaymentMethodGroupId":123, "ReturnAccountIfAccountExists":true, "TransactionOrigin":"string", "VantivEncryptedCard":{"Version":"string"}}

[{"AccountNumber":"string","CardExpiryMonth":123,"CardExpiryYear":123,"ConstituentId":123,"ExclusiveToControlledBatchId":123,"Inactive":true,"Name":"string","PaymentMethodGroupId":123,"ReturnAccountIfAccountExists":true,"TransactionOrigin":"string","VantivEncryptedCard.Version":"string"}]

AccountNumber,CardExpiryMonth,CardExpiryYear,ConstituentId,ExclusiveToControlledBatchId,Inactive,Name,PaymentMethodGroupId,ReturnAccountIfAccountExists,TransactionOrigin,VantivEncryptedCard.Version
"""string""",123,123,123,123,true,"""string""",123,true,"""string""","""string"""

Flags:

  • --DirectDebitAccount
    Store a direct debit account.
Query:
{"AccountNumber":"string", "CardExpiryMonth":123, "CardExpiryYear":123, "ConstituentId":123, "DirectDebitAccountType":{"Id":123}, "Inactive":true, "Name":"string"}

[{"AccountNumber":"string","CardExpiryMonth":123,"CardExpiryYear":123,"ConstituentId":123,"DirectDebitAccountType.Id":123,"Inactive":true,"Name":"string"}]

AccountNumber,CardExpiryMonth,CardExpiryYear,ConstituentId,DirectDebitAccountType.Id,Inactive,Name
"""string""",123,123,123,123,true,"""string"""
  • --SepaAccount
    Store a SEPA Direct Debit account.
Query:
{"AccountNumber":"string", "BankIdentifierCode":"string", "ConstituentId":123, "Inactive":true, "MandateNumber":"string", "MandateType":123, "Name":"string", "SignatureDate":"2000-01-01T00:00:00.000Z"}

[{"AccountNumber":"string","BankIdentifierCode":"string","ConstituentId":123,"Inactive":true,"MandateNumber":"string","MandateType":123,"Name":"string","SignatureDate":"2000-01-01T00:00:00.000Z"}]

AccountNumber,BankIdentifierCode,ConstituentId,Inactive,MandateNumber,MandateType,Name,SignatureDate
"""string""","""string""",123,true,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""
  • --VantivEncryptedCardAccount
    Create a credit card account from a Vantiv Encrypted Reader using tokenization.
Query:
{"ConstituentId":123, "ExclusiveToControlledBatchId":123, "Inactive":true, "Name":"string", "PaymentMethodGroupId":123, "VantivEncryptedCard":{"Version":"string"}}

[{"ConstituentId":123,"ExclusiveToControlledBatchId":123,"Inactive":true,"Name":"string","PaymentMethodGroupId":123,"VantivEncryptedCard.Version":"string"}]

ConstituentId,ExclusiveToControlledBatchId,Inactive,Name,PaymentMethodGroupId,VantivEncryptedCard.Version
123,123,true,"""string""",123,"""string"""

ActionTypes
get put

Create a new action type.

Usage:
tq post ActionTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "LetterIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"LetterIndicator":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,LetterIndicator,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,"""string""","""2000-01-01T00:00:00.000Z"""

Actions
get put

Create an issue action for a Constituent

Usage:
tq post Actions
Query:
{"ActionDate":"2000-01-01T00:00:00.000Z", "ActionType":{"Id":123}, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "Issue":{"Id":123}, "LetterPrintedDate":"2000-01-01T00:00:00.000Z", "Notes":"string", "Resolved":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ActionDate":"2000-01-01T00:00:00.000Z","ActionType.Id":123,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"Issue.Id":123,"LetterPrintedDate":"2000-01-01T00:00:00.000Z","Notes":"string","Resolved":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ActionDate,ActionType.Id,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,Issue.Id,LetterPrintedDate,Notes,Resolved,UpdatedBy,UpdatedDateTime
"""2000-01-01T00:00:00.000Z""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,"""2000-01-01T00:00:00.000Z""","""string""",true,"""string""","""2000-01-01T00:00:00.000Z"""

ActivityCategories
get put

Create a new activity category.

Usage:
tq post ActivityCategories
Query:
{"AutoClose":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AutoClose":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AutoClose,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
true,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ActivityTypes
get put

Create a new activity type.

Usage:
tq post ActivityTypes
Query:
{"Category":{"Id":123}, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "PerfIndicator":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Category.Id":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"PerfIndicator":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category.Id,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,PerfIndicator,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

AddressTypes
get put

Create a new address type.

Usage:
tq post AddressTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Addresses
get put

Create a new address for a Constituent by sending an XML or JSON representation of an Address object using HTTP POST.

Usage:
tq post Addresses
Query:
{"AddressType":{"Id":123}, "AffiliatedConstituent":{"Id":123}, "AltSalutationType":{"Id":123}, "City":"string", "Constituent":{"Id":123}, "Country":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DeliveryPoint":"string", "EditIndicator":true, "EndDate":"2000-01-01T00:00:00.000Z", "GeoArea":123, "Id":123, "Inactive":true, "IsFromAffiliation":true, "Label":true, "Months":"string", "NcoaAction":123, "NcoaSession":123, "PostalCode":"string", "PostalCodeFormatted":"string", "PrimaryIndicator":true, "StartDate":"2000-01-01T00:00:00.000Z", "State":{"Id":123}, "Street1":"string", "Street1Address":{"Number":"string", "Street":"string"}, "Street2":"string", "Street3":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AddressType.Id":123,"AffiliatedConstituent.Id":123,"AltSalutationType.Id":123,"City":"string","Constituent.Id":123,"Country.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DeliveryPoint":"string","EditIndicator":true,"EndDate":"2000-01-01T00:00:00.000Z","GeoArea":123,"Id":123,"Inactive":true,"IsFromAffiliation":true,"Label":true,"Months":"string","NcoaAction":123,"NcoaSession":123,"PostalCode":"string","PostalCodeFormatted":"string","PrimaryIndicator":true,"StartDate":"2000-01-01T00:00:00.000Z","State.Id":123,"Street1":"string","Street1Address.Number":"string","Street1Address.Street":"string","Street2":"string","Street3":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AddressType.Id,AffiliatedConstituent.Id,AltSalutationType.Id,City,Constituent.Id,Country.Id,CreateLocation,CreatedBy,CreatedDateTime,DeliveryPoint,EditIndicator,EndDate,GeoArea,Id,Inactive,IsFromAffiliation,Label,Months,NcoaAction,NcoaSession,PostalCode,PostalCodeFormatted,PrimaryIndicator,StartDate,State.Id,Street1,Street1Address.Number,Street1Address.Street,Street2,Street3,UpdatedBy,UpdatedDateTime
123,123,123,"""string""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,"""2000-01-01T00:00:00.000Z""",123,123,true,true,true,"""string""",123,123,"""string""","""string""",true,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

AffiliationInfo

Create affiliation between a group constituent and its related constituent. If the related constituent does not exist then create the related constituent as well before creating the affiliation.

Usage:
tq post AffiliationInfo
Query:
{"AffiliationType":{"Id":123}, "ConstituentId":123, "EditIndicator":true, "EndDate":"2000-01-01T00:00:00.000Z", "Id":123, "Inactive":true, "IsAllowedToTransact":true, "IsIncludedInSearchResults":true, "NameIndicator":123, "Note":"string", "PrimaryIndicator":true, "ProtectionType":{"Id":123}, "Rank":123, "RelatedConstituentFirstName":"string", "RelatedConstituentGender":{"Id":123}, "RelatedConstituentId":123, "RelatedConstituentInactive":true, "RelatedConstituentLastName":"string", "RelatedConstituentMiddleName":"string", "RelatedConstituentNameStatusDescription":"string", "RelatedConstituentNameStatusId":123, "RelatedConstituentPrefix":{"Id":123}, "RelatedConstituentShortDisplayName":"string", "RelatedConstituentSortName":"string", "RelatedConstituentSuffix":{"Id":123}, "RelatedConstituentType":{"Id":123}, "Salary":123.456, "StartDate":"2000-01-01T00:00:00.000Z", "Title":"string"}

[{"AffiliationType.Id":123,"ConstituentId":123,"EditIndicator":true,"EndDate":"2000-01-01T00:00:00.000Z","Id":123,"Inactive":true,"IsAllowedToTransact":true,"IsIncludedInSearchResults":true,"NameIndicator":123,"Note":"string","PrimaryIndicator":true,"ProtectionType.Id":123,"Rank":123,"RelatedConstituentFirstName":"string","RelatedConstituentGender.Id":123,"RelatedConstituentId":123,"RelatedConstituentInactive":true,"RelatedConstituentLastName":"string","RelatedConstituentMiddleName":"string","RelatedConstituentNameStatusDescription":"string","RelatedConstituentNameStatusId":123,"RelatedConstituentPrefix.Id":123,"RelatedConstituentShortDisplayName":"string","RelatedConstituentSortName":"string","RelatedConstituentSuffix.Id":123,"RelatedConstituentType.Id":123,"Salary":123.456,"StartDate":"2000-01-01T00:00:00.000Z","Title":"string"}]

AffiliationType.Id,ConstituentId,EditIndicator,EndDate,Id,Inactive,IsAllowedToTransact,IsIncludedInSearchResults,NameIndicator,Note,PrimaryIndicator,ProtectionType.Id,Rank,RelatedConstituentFirstName,RelatedConstituentGender.Id,RelatedConstituentId,RelatedConstituentInactive,RelatedConstituentLastName,RelatedConstituentMiddleName,RelatedConstituentNameStatusDescription,RelatedConstituentNameStatusId,RelatedConstituentPrefix.Id,RelatedConstituentShortDisplayName,RelatedConstituentSortName,RelatedConstituentSuffix.Id,RelatedConstituentType.Id,Salary,StartDate,Title
123,123,true,"""2000-01-01T00:00:00.000Z""",123,true,true,true,123,"""string""",true,123,123,"""string""",123,123,true,"""string""","""string""","""string""",123,123,"""string""","""string""",123,123,123.456,"""2000-01-01T00:00:00.000Z""","""string"""

AffiliationTypes
get put

Create a new affiliation type.

Usage:
tq post AffiliationTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "IsAllowedToTransactDefault":true, "IsIncludedInSearchResultsDefault":true, "RelationshipCategory":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseSalary":true, "UseTitle":true}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"IsAllowedToTransactDefault":true,"IsIncludedInSearchResultsDefault":true,"RelationshipCategory.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseSalary":true,"UseTitle":true}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,IsAllowedToTransactDefault,IsIncludedInSearchResultsDefault,RelationshipCategory.Id,UpdatedBy,UpdatedDateTime,UseSalary,UseTitle
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,true,123,"""string""","""2000-01-01T00:00:00.000Z""",true,true

Affiliations
get put

Create a new affiliation.

Usage:
tq post Affiliations
Query:
{"AddressId":123, "AffiliatedName":"string", "AffiliationType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "ElectronicAddressId":123, "EndDate":"2000-01-01T00:00:00.000Z", "GroupConstituent":{"Id":123}, "GroupConstituentName":"string", "GroupConstituentSortName":"string", "Id":123, "Inactive":true, "IndividualConstituent":{"Id":123}, "IndividualConstituentName":"string", "IndividualConstituentSortName":"string", "IsAllowedToTransact":true, "IsIncludedInSearchResults":true, "NameIndicator":123, "Note":"string", "PrimaryIndicator":true, "Salary":123.456, "SalutationId":123, "StartDate":"2000-01-01T00:00:00.000Z", "Title":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AddressId":123,"AffiliatedName":"string","AffiliationType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"ElectronicAddressId":123,"EndDate":"2000-01-01T00:00:00.000Z","GroupConstituent.Id":123,"GroupConstituentName":"string","GroupConstituentSortName":"string","Id":123,"Inactive":true,"IndividualConstituent.Id":123,"IndividualConstituentName":"string","IndividualConstituentSortName":"string","IsAllowedToTransact":true,"IsIncludedInSearchResults":true,"NameIndicator":123,"Note":"string","PrimaryIndicator":true,"Salary":123.456,"SalutationId":123,"StartDate":"2000-01-01T00:00:00.000Z","Title":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AddressId,AffiliatedName,AffiliationType.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,ElectronicAddressId,EndDate,GroupConstituent.Id,GroupConstituentName,GroupConstituentSortName,Id,Inactive,IndividualConstituent.Id,IndividualConstituentName,IndividualConstituentSortName,IsAllowedToTransact,IsIncludedInSearchResults,NameIndicator,Note,PrimaryIndicator,Salary,SalutationId,StartDate,Title,UpdatedBy,UpdatedDateTime
123,"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""",123,true,123,"""string""","""string""",true,true,123,"""string""",true,123.456,123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

AliasTypes
get put

Create a new alias type.

Usage:
tq post AliasTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Aliases
get put

Create a new alias.

Usage:
tq post Aliases
Query:
{"AliasFirstName":"string", "AliasLastName":"string", "AliasType":{"Id":123}, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AliasFirstName":"string","AliasLastName":"string","AliasType.Id":123,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AliasFirstName,AliasLastName,AliasType.Id,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,UpdatedBy,UpdatedDateTime
"""string""","""string""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,"""string""","""2000-01-01T00:00:00.000Z"""

AnalyticsReports
get put

Create SSRS Reports for display in Analytics.

Usage:
tq post AnalyticsReports
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Division":{"Id":"string"}, "Id":123, "Inactive":true, "ReportPath":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Division.Id":"string","Id":123,"Inactive":true,"ReportPath":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Division.Id,Id,Inactive,ReportPath,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

AppealCategories
get put

Create a new appeal category.

Usage:
tq post AppealCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Artists
get put

Create a new artist.

Usage:
tq post Artists
Query:
{"Bio":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "FirstName":"string", "Id":123, "LastName":"string", "MiddleName":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "VoiceId":123}

[{"Bio":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","FirstName":"string","Id":123,"LastName":"string","MiddleName":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","VoiceId":123}]

Bio,CreateLocation,CreatedBy,CreatedDateTime,FirstName,Id,LastName,MiddleName,UpdatedBy,UpdatedDateTime,VoiceId
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",123

AssetTypes
get put

Create a new asset type.

Usage:
tq post AssetTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Assets
get put

Create an asset for a constituent.

Usage:
tq post Assets
Query:
{"AcquisitionDateTime":"2000-01-01T00:00:00.000Z", "AssetType":{"Id":123}, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "EstimatedValue":123.456, "Id":123, "Notes":"string", "SaleDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AcquisitionDateTime":"2000-01-01T00:00:00.000Z","AssetType.Id":123,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditIndicator":true,"EstimatedValue":123.456,"Id":123,"Notes":"string","SaleDateTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AcquisitionDateTime,AssetType.Id,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EditIndicator,EstimatedValue,Id,Notes,SaleDateTime,UpdatedBy,UpdatedDateTime
"""2000-01-01T00:00:00.000Z""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123.456,123,"""string""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

AssociationTypes
get put

Create a new association type.

Usage:
tq post AssociationTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "IsIncludedInSearchResultsDefault":true, "ReciprocalType":{"Id":123}, "RelationshipCategory":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseBirthDate":true, "UseGender":true}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"IsIncludedInSearchResultsDefault":true,"ReciprocalType.Id":123,"RelationshipCategory.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseBirthDate":true,"UseGender":true}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,IsIncludedInSearchResultsDefault,ReciprocalType.Id,RelationshipCategory.Id,UpdatedBy,UpdatedDateTime,UseBirthDate,UseGender
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,123,123,"""string""","""2000-01-01T00:00:00.000Z""",true,true

Associations
get put

Create a new association.

Usage:
tq post Associations
Query:
{"AssociatedConstituent":{"Id":123}, "AssociatedName":"string", "AssociationType":{"Id":123}, "BirthDate":"2000-01-01T00:00:00.000Z", "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "EndDate":"2000-01-01T00:00:00.000Z", "Gender":{"Id":123}, "Id":123, "Inactive":true, "IsIncludedInSearchResults":true, "Note":"string", "ReciprocalAssociation":{"Id":123}, "StartDate":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AssociatedConstituent.Id":123,"AssociatedName":"string","AssociationType.Id":123,"BirthDate":"2000-01-01T00:00:00.000Z","Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"EndDate":"2000-01-01T00:00:00.000Z","Gender.Id":123,"Id":123,"Inactive":true,"IsIncludedInSearchResults":true,"Note":"string","ReciprocalAssociation.Id":123,"StartDate":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AssociatedConstituent.Id,AssociatedName,AssociationType.Id,BirthDate,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,EndDate,Gender.Id,Id,Inactive,IsIncludedInSearchResults,Note,ReciprocalAssociation.Id,StartDate,UpdatedBy,UpdatedDateTime
123,"""string""",123,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,"""2000-01-01T00:00:00.000Z""",123,123,true,true,"""string""",123,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

Attributes
get put

Create a new attribute.

Usage:
tq post Attributes
Query:
{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "Keyword":{"Id":123}, "KeywordConstituentType":{"Inactive":true, "Rank":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Value":"string"}

[{"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"Keyword.Id":123,"KeywordConstituentType.Inactive":true,"KeywordConstituentType.Rank":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Value":"string"}]

Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,Keyword.Id,KeywordConstituentType.Inactive,KeywordConstituentType.Rank,UpdatedBy,UpdatedDateTime,Value
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,true,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

Authenticate
get

Authenticate the provided credentials

Usage:
tq post Authenticate
Query:
{"Application":"string", "MachineLocation":"string", "Password":"string", "UserGroup":"string", "UserName":"string"}

[{"Application":"string","MachineLocation":"string","Password":"string","UserGroup":"string","UserName":"string"}]

Application,MachineLocation,Password,UserGroup,UserName
"""string""","""string""","""string""","""string""","""string"""

Flags:

  • --AuthenticateWindows
    Authenticate the provided credentials
Query:
{"Application":"string", "MachineLocation":"string", "UserGroup":"string"}

[{"Application":"string","MachineLocation":"string","UserGroup":"string"}]

Application,MachineLocation,UserGroup
"""string""","""string""","""string"""
  • --GenerateToken
    Authenticate the provided credentials and return a timed token that can be used to proxy this result.
Query:
{"Application":"string", "MachineLocation":"string", "Password":"string", "UserGroup":"string", "UserName":"string"}

[{"Application":"string","MachineLocation":"string","Password":"string","UserGroup":"string","UserName":"string"}]

Application,MachineLocation,Password,UserGroup,UserName
"""string""","""string""","""string""","""string""","""string"""
  • --GenerateTokenWindows
    Authenticate the provided credentials and return a timed token that can be used to proxy this result.
Query:
{"Application":"string", "MachineLocation":"string", "UserGroup":"string"}

[{"Application":"string","MachineLocation":"string","UserGroup":"string"}]

Application,MachineLocation,UserGroup
"""string""","""string""","""string"""
  • --ValidateToken
    Validates an authentication token and returns the standard AuthenticationResponse
Query:
{"Token":"string"}

[{"Token":"string"}]

Token
"""string"""

Authorization
put

Authorize a payment using a manually keyed, swiped or encrypted card data, including payments made using the Tessitura Merchant Services Payment Component.

Usage:
tq post Authorization
Query:
{"AllowPartialAuth":true, "Amount":123.456, "AuthorizationCode":"string", "BillingAddress":{"AddressId":123, "Country":"string", "PostalCode":"string", "Street1":"string"}, "Card":{"AccountId":123, "CardHolderName":"string", "CardNumber":"string", "Cvv2":"string", "ExpirationDate":"string", "TessituraMerchantServicesData":"string", "Track1":"string", "Track2":"string"}, "ConstituentId":123, "DeliveryDate":"2000-01-01T00:00:00.000Z", "IsECommerce":true, "IsRecurring":true, "PaymentId":123, "PaymentMethodId":123, "ReferenceNumber":"string", "ReturnUrl":"string", "ShopperIp":"string", "StoreAccount":true, "ThreeDSecureData":{"EciIndicatorType":"string", "MpiSessionId":"string", "SecureTransactionId":"string", "SecureTransactionSecurity":"string", "VerAuthValue":"string", "VerCertificateSerialCardAcceptor":"string", "VerCertificateSerialCardHolder":"string", "VerHashResult":"string"}, "TransactionOrigin":"string", "UserData":"string"}

[{"AllowPartialAuth":true,"Amount":123.456,"AuthorizationCode":"string","BillingAddress.AddressId":123,"BillingAddress.Country":"string","BillingAddress.PostalCode":"string","BillingAddress.Street1":"string","Card.AccountId":123,"Card.CardHolderName":"string","Card.CardNumber":"string","Card.Cvv2":"string","Card.ExpirationDate":"string","Card.TessituraMerchantServicesData":"string","Card.Track1":"string","Card.Track2":"string","ConstituentId":123,"DeliveryDate":"2000-01-01T00:00:00.000Z","IsECommerce":true,"IsRecurring":true,"PaymentId":123,"PaymentMethodId":123,"ReferenceNumber":"string","ReturnUrl":"string","ShopperIp":"string","StoreAccount":true,"ThreeDSecureData.EciIndicatorType":"string","ThreeDSecureData.MpiSessionId":"string","ThreeDSecureData.SecureTransactionId":"string","ThreeDSecureData.SecureTransactionSecurity":"string","ThreeDSecureData.VerAuthValue":"string","ThreeDSecureData.VerCertificateSerialCardAcceptor":"string","ThreeDSecureData.VerCertificateSerialCardHolder":"string","ThreeDSecureData.VerHashResult":"string","TransactionOrigin":"string","UserData":"string"}]

AllowPartialAuth,Amount,AuthorizationCode,BillingAddress.AddressId,BillingAddress.Country,BillingAddress.PostalCode,BillingAddress.Street1,Card.AccountId,Card.CardHolderName,Card.CardNumber,Card.Cvv2,Card.ExpirationDate,Card.TessituraMerchantServicesData,Card.Track1,Card.Track2,ConstituentId,DeliveryDate,IsECommerce,IsRecurring,PaymentId,PaymentMethodId,ReferenceNumber,ReturnUrl,ShopperIp,StoreAccount,ThreeDSecureData.EciIndicatorType,ThreeDSecureData.MpiSessionId,ThreeDSecureData.SecureTransactionId,ThreeDSecureData.SecureTransactionSecurity,ThreeDSecureData.VerAuthValue,ThreeDSecureData.VerCertificateSerialCardAcceptor,ThreeDSecureData.VerCertificateSerialCardHolder,ThreeDSecureData.VerHashResult,TransactionOrigin,UserData
true,123.456,"""string""",123,"""string""","""string""","""string""",123,"""string""","""string""","""string""","""string""","""string""","""string""","""string""",123,"""2000-01-01T00:00:00.000Z""",true,true,123,123,"""string""","""string""","""string""",true,"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string"""

Flags:

  • --Confirm
    Confirm an authorization using its reference number. For all gateways, this results in a confirm transaction being written to T_PAYMENT_GATEWAY_ACTIVITY. For EPay gateway, the confirm endpoint also sends a capture transaction.
Query:
{"Amount":123.456, "IsECommerce":true, "PaymentId":123, "PaymentMethodId":123, "TransactionOrigin":"string", "UserData":"string", "ReferenceNumber":"string"}

[{"Amount":123.456,"IsECommerce":true,"PaymentId":123,"PaymentMethodId":123,"ReferenceNumber":"string","TransactionOrigin":"string","UserData":"string"}]

Amount,IsECommerce,PaymentId,PaymentMethodId,ReferenceNumber,TransactionOrigin,UserData
123.456,true,123,123,"""string""","""string""","""string"""
  • --ConfirmPayByLink
    NOTE: THIS IS FOR TESSITURA USE ONLY. Custom implementations of this endpoint are not supported. Check to see if a Pay by Link has been authorized. For Tessitura Merchant Services only.
Query:
  • --Finalize
    Finalize an authorization. For use with Tessitura Merchant Services only. Finalizes a payment authorization derived from the Authorize request.
Query:
{"ActionData":"string", "PaymentId":123, "RedirectResult":"string", "StoreAccount":true}

[{"ActionData":"string","PaymentId":123,"RedirectResult":"string","StoreAccount":true}]

ActionData,PaymentId,RedirectResult,StoreAccount
"""string""",123,"""string""",true
  • --Link
    NOTE: THIS IS FOR TESSITURA USE ONLY. Custom implementations of this endpoint are not supported. Create a payment link to a hosted payment form where shoppers can pay. For Tessitura Merchant Services only.
Query:
  • --Reverse
    Reverse a payment authorization using its reference number.
Query:
{"ReferenceNumber":"string", "Amount":123.456, "Card":{"AccountId":123, "CardHolderName":"string", "CardNumber":"string", "Cvv2":"string", "ExpirationDate":"string", "TessituraMerchantServicesData":"string", "Track1":"string", "Track2":"string"}, "ConstituentId":123, "IsECommerce":true, "IsElementDebit":true, "IsSwiped":true, "PaymentId":123, "PaymentMethodId":123, "TransactionOrigin":"string", "UserData":"string"}

[{"Amount":123.456,"Card.AccountId":123,"Card.CardHolderName":"string","Card.CardNumber":"string","Card.Cvv2":"string","Card.ExpirationDate":"string","Card.TessituraMerchantServicesData":"string","Card.Track1":"string","Card.Track2":"string","ConstituentId":123,"IsECommerce":true,"IsElementDebit":true,"IsSwiped":true,"PaymentId":123,"PaymentMethodId":123,"ReferenceNumber":"string","TransactionOrigin":"string","UserData":"string"}]

Amount,Card.AccountId,Card.CardHolderName,Card.CardNumber,Card.Cvv2,Card.ExpirationDate,Card.TessituraMerchantServicesData,Card.Track1,Card.Track2,ConstituentId,IsECommerce,IsElementDebit,IsSwiped,PaymentId,PaymentMethodId,ReferenceNumber,TransactionOrigin,UserData
123.456,123,"""string""","""string""","""string""","""string""","""string""","""string""","""string""",123,true,true,true,123,123,"""string""","""string""","""string"""

B

Batch

Usage:
tq post Batch
Query:
{"Requests":[{"Id":123}, ...]}

BatchMaintenance
get

Create a new Batch

Usage:
tq post BatchMaintenance
Query:
{"AmtPosted":123.456, "BatchType":{"Id":123}, "CloseDateTime":"2000-01-01T00:00:00.000Z", "ClosedBy":"string", "CntlIndicator":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Notes":"string", "NumAccCc":123, "NumRejCc":123, "OpenLoc":"string", "Owner":"string", "PostId":123, "PostedBy":"string", "PostedDateTime":"2000-01-01T00:00:00.000Z", "Status":"string", "TallyPlAmount":123.456, "TallyReAmount":123.456, "UniqueTag":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AmtPosted":123.456,"BatchType.Id":123,"CloseDateTime":"2000-01-01T00:00:00.000Z","ClosedBy":"string","CntlIndicator":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Notes":"string","NumAccCc":123,"NumRejCc":123,"OpenLoc":"string","Owner":"string","PostId":123,"PostedBy":"string","PostedDateTime":"2000-01-01T00:00:00.000Z","Status":"string","TallyPlAmount":123.456,"TallyReAmount":123.456,"UniqueTag":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AmtPosted,BatchType.Id,CloseDateTime,ClosedBy,CntlIndicator,CreatedBy,CreatedDateTime,Id,Notes,NumAccCc,NumRejCc,OpenLoc,Owner,PostId,PostedBy,PostedDateTime,Status,TallyPlAmount,TallyReAmount,UniqueTag,UpdatedBy,UpdatedDateTime
123.456,123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",123,123,"""string""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z""","""string""",123.456,123.456,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

BatchTypeGroups
get put

Create a new batch type group.

Usage:
tq post BatchTypeGroups
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

BatchTypes
get put

Create a new batch type.

Usage:
tq post BatchTypes
Query:
{"BatchTypeGroup":{"Id":123}, "BusinessUnit":{"Id":123}, "Category":123, "CntlIndicator":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BatchTypeGroup.Id":123,"BusinessUnit.Id":123,"Category":123,"CntlIndicator":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BatchTypeGroup.Id,BusinessUnit.Id,Category,CntlIndicator,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,123,123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

BillingSchedules
get put

Create a new Billing Schedule.

Usage:
tq post BillingSchedules
Query:
{"BillAmounts":"string", "BillDates":"string", "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "LongDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BillAmounts":"string","BillDates":"string","ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"LongDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BillAmounts,BillDates,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,LongDescription,UpdatedBy,UpdatedDateTime
"""string""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

BillingTypes
get put

Create a new Billing Type.

Usage:
tq post BillingTypes
Query:
{"AutoBillingIndicator":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AutoBillingIndicator":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AutoBillingIndicator,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

BookingCategories
get put

Create a new Booking Category.

Usage:
tq post BookingCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditIndicator":true,"Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EditIndicator,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,true,"""string""","""2000-01-01T00:00:00.000Z"""

BookingTemplates
get put

Create a new Booking Template

Usage:
tq post BookingTemplates
Query:
{"Assignments":[{"Id":123}, ...], "Category":{"Id":123}, "ConfirmationText":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "Notes":"string", "OverrideTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Bookings
get put

Create a new Booking

Usage:
tq post Bookings
Query:
{"Assignments":[{"Id":123}, ...], "BookingSource":123, "Category":{"Id":123}, "ConfirmationText":"string", "Context":{}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultCount":123, "DefaultDateTime":"2000-01-01T00:00:00.000Z", "DefaultDuration":123, "Description":"string", "EditIndicator":true, "Id":123, "Notes":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Flags:

  • --AddDocument
    Add a document to the booking.
Query:
{"BookingID":"string", "Category":{"Id":123}, "ConstituentId":123, "Contents":"AA==", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "FileName":"string", "Id":123, "Notes":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BookingID":"string","Category.Id":123,"ConstituentId":123,"Contents":"AA==","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","FileName":"string","Id":123,"Notes":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BookingID,Category.Id,ConstituentId,Contents,CreateLocation,CreatedBy,CreatedDateTime,Description,FileName,Id,Notes,UpdatedBy,UpdatedDateTime
"""string""",123,123,"""AA==""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""
  • --FromTemplate
    Create a new Booking using the details and Resource Type assignments from a Booking Template.
Query:
{"BookingSource":123, "BookingTemplateId":123, "ConfirmationText":"string", "DefaultCount":123, "DefaultDateTime":"2000-01-01T00:00:00.000Z", "DefaultDuration":123, "Description":"string", "Notes":"string"}

[{"BookingSource":123,"BookingTemplateId":123,"ConfirmationText":"string","DefaultCount":123,"DefaultDateTime":"2000-01-01T00:00:00.000Z","DefaultDuration":123,"Description":"string","Notes":"string"}]

BookingSource,BookingTemplateId,ConfirmationText,DefaultCount,DefaultDateTime,DefaultDuration,Description,Notes
123,123,"""string""",123,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string"""

BulkCopySets
get put

Creates a new bulk copy set.

Usage:
tq post BulkCopySets
Query:
{"AvailableForSaleIndicator":true, "ControlGroup":{"Id":123}, "CopyCredits":true, "CopyNotes":true, "CopyOffers":true, "CopyPriceEvents":true, "CopyPrices":true, "CreateFriday":true, "CreateFromDateTime":"2000-01-01T00:00:00.000Z", "CreateLocation":"string", "CreateMode":"string", "CreateMonday":true, "CreateSaturday":true, "CreateSunday":true, "CreateThursday":true, "CreateToDateTime":"2000-01-01T00:00:00.000Z", "CreateTuesday":true, "CreateWednesday":true, "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultRelativeDates":"string", "Id":123, "Inactive":true, "OverrideOnSale":true, "PackageCode":"string", "PackageCodeSeed":123, "PackageModeOfSaleRelativeDates":"string", "PerformanceCode":"string", "PerformanceCodeSeed":123, "PerformanceDescription":"string", "PerformanceModeOfSaleRelativeDates":"string", "PerformanceStatus":{"Id":123}, "PerformanceTime":"string", "PerformanceType":{"Id":123}, "PriceEventRelativeDates":"string", "PriceTypeRelativeDates":"string", "ProductionSeason":{"Id":123}, "PublishRelativeDates":"string", "ReferenceDay":"2000-01-01T00:00:00.000Z", "ReferencePerformanceId":123, "ReferenceSeasonString":"string", "SetDescription":"string", "SetType":123, "ShortName":"string", "TimeSlot":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AvailableForSaleIndicator":true,"ControlGroup.Id":123,"CopyCredits":true,"CopyNotes":true,"CopyOffers":true,"CopyPriceEvents":true,"CopyPrices":true,"CreateFriday":true,"CreateFromDateTime":"2000-01-01T00:00:00.000Z","CreateLocation":"string","CreateMode":"string","CreateMonday":true,"CreateSaturday":true,"CreateSunday":true,"CreateThursday":true,"CreateToDateTime":"2000-01-01T00:00:00.000Z","CreateTuesday":true,"CreateWednesday":true,"CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultRelativeDates":"string","Id":123,"Inactive":true,"OverrideOnSale":true,"PackageCode":"string","PackageCodeSeed":123,"PackageModeOfSaleRelativeDates":"string","PerformanceCode":"string","PerformanceCodeSeed":123,"PerformanceDescription":"string","PerformanceModeOfSaleRelativeDates":"string","PerformanceStatus.Id":123,"PerformanceTime":"string","PerformanceType.Id":123,"PriceEventRelativeDates":"string","PriceTypeRelativeDates":"string","ProductionSeason.Id":123,"PublishRelativeDates":"string","ReferenceDay":"2000-01-01T00:00:00.000Z","ReferencePerformanceId":123,"ReferenceSeasonString":"string","SetDescription":"string","SetType":123,"ShortName":"string","TimeSlot.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AvailableForSaleIndicator,ControlGroup.Id,CopyCredits,CopyNotes,CopyOffers,CopyPriceEvents,CopyPrices,CreateFriday,CreateFromDateTime,CreateLocation,CreateMode,CreateMonday,CreateSaturday,CreateSunday,CreateThursday,CreateToDateTime,CreateTuesday,CreateWednesday,CreatedBy,CreatedDateTime,DefaultRelativeDates,Id,Inactive,OverrideOnSale,PackageCode,PackageCodeSeed,PackageModeOfSaleRelativeDates,PerformanceCode,PerformanceCodeSeed,PerformanceDescription,PerformanceModeOfSaleRelativeDates,PerformanceStatus.Id,PerformanceTime,PerformanceType.Id,PriceEventRelativeDates,PriceTypeRelativeDates,ProductionSeason.Id,PublishRelativeDates,ReferenceDay,ReferencePerformanceId,ReferenceSeasonString,SetDescription,SetType,ShortName,TimeSlot.Id,UpdatedBy,UpdatedDateTime
true,123,true,true,true,true,true,true,"""2000-01-01T00:00:00.000Z""","""string""","""string""",true,true,true,true,"""2000-01-01T00:00:00.000Z""",true,true,"""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,"""string""",123,"""string""","""string""",123,"""string""","""string""",123,"""string""",123,"""string""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z""",123,"""string""","""string""",123,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

Flags:

  • --CopyDay
    Copies the packages, performances groups and performances from a day defined in the bulk copy set to the day specified in the request.
Query:
{"CopyToDate":"2000-01-01T00:00:00.000Z", "PackageCodeCounter":123, "PerformanceCodeCounter":123, "BulkCopySetID":"string"}

[{"BulkCopySetID":"string","CopyToDate":"2000-01-01T00:00:00.000Z","PackageCodeCounter":123,"PerformanceCodeCounter":123}]

BulkCopySetID,CopyToDate,PackageCodeCounter,PerformanceCodeCounter
"""string""","""2000-01-01T00:00:00.000Z""",123,123
  • --CopyEvent
    Copies the performance specified in the bulk copy set to the date and time specified in the request.
Query:
{"CopyToDate":"2000-01-01T00:00:00.000Z", "PerformanceCodeCounter":123, "BulkCopySetID":"string"}

[{"BulkCopySetID":"string","CopyToDate":"2000-01-01T00:00:00.000Z","PerformanceCodeCounter":123}]

BulkCopySetID,CopyToDate,PerformanceCodeCounter
"""string""","""2000-01-01T00:00:00.000Z""",123
  • --ReplaceExclusions
    Replaces bulk copy exclusions for a given set by deleting them and inserting the new collection.
Query:
{"BulkCopySetID":"string", "BulkDailyCopyExclusions":[{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DoNotCopy":true, "Id":123, "IncludeWithoutCopy":true, "PackageId":123, "PerformanceId":123, "SetId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}, ...]}

BulkDailyCopyExclusions
get put

Creates a bulk daily copy exclusion.

Usage:
tq post BulkDailyCopyExclusions
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DoNotCopy":true, "Id":123, "IncludeWithoutCopy":true, "PackageId":123, "PerformanceId":123, "SetId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DoNotCopy":true,"Id":123,"IncludeWithoutCopy":true,"PackageId":123,"PerformanceId":123,"SetId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,DoNotCopy,Id,IncludeWithoutCopy,PackageId,PerformanceId,SetId,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,true,123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

BusinessUnits
get put

Create a new business unit.

Usage:
tq post BusinessUnits
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

C

CampaignDesignations
get put

Create a new association between a Designation and a Campaign.

Usage:
tq post CampaignDesignations
Query:
{"Campaign":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultIndicator":true, "Designation":{"Id":123}, "EditIndicator":true, "GoalAmount":123.456, "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Campaign.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultIndicator":true,"Designation.Id":123,"EditIndicator":true,"GoalAmount":123.456,"Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Campaign.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultIndicator,Designation.Id,EditIndicator,GoalAmount,Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,true,123.456,123,"""string""","""2000-01-01T00:00:00.000Z"""

CampaignFunds
get put

Create a new Fund association to a Campaign.

Usage:
tq post CampaignFunds
Query:
{"Campaign":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "EndDateTime":"2000-01-01T00:00:00.000Z", "Fund":{"Id":123}, "GoalAmount":123.456, "Id":123, "StartDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Campaign.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"EndDateTime":"2000-01-01T00:00:00.000Z","Fund.Id":123,"GoalAmount":123.456,"Id":123,"StartDateTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Campaign.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,EndDateTime,Fund.Id,GoalAmount,Id,StartDateTime,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,"""2000-01-01T00:00:00.000Z""",123,123.456,123,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

CardReaderTypes
get put

Create a new Card Reader Type.

Usage:
tq post CardReaderTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Cart
get put

Attach an existing booking to the cart.

Usage:
tq post Cart
Query:
{"BookingId":123, "SessionKey":"string"}

[{"BookingId":123,"SessionKey":"string"}]

BookingId,SessionKey
123,"""string"""

Flags:

  • --AddContribution
    Adds a contribution to the cart The donation must be applied directly to a fund. This method also allows a specific membership level ID to be specified.
Query:
{"Amount":123.456, "CustomDataItems":[{"DataType":"string", "Description":"string", "EditIndicator":true, "Index":123, "IsDropdown":true, "KeywordId":123, "Name":"string", "Value":"string"}, ...], "FundId":123, "MembershipLevelId":123, "Notes":"string", "Renew":true, "Upgrade":true, "SessionKey":"string"}
  • --AddFee
    Adds or Updates a fee Only user-defined fees can be added. Seat-based fees can be overridden to zero only, while order-based or user-defined fees can be overridden to any amount, as allowed by the rules in fee setup. To add and edit a user-defined fee call this method twice, once to add the fee, and once to override the amount.
Query:
{"Action":"string", "Amount":123.456, "FeeId":123, "ItemFeeId":123, "SessionKey":"string"}

[{"Action":"string","Amount":123.456,"FeeId":123,"ItemFeeId":123,"SessionKey":"string"}]

Action,Amount,FeeId,ItemFeeId,SessionKey
"""string""",123.456,123,123,"""string"""
  • --AddGiftCertificate
    Adds a gift certificate for the specified amount to the cart The resulting gift certificate number can be found with /Web/Cart (GET).
Query:
{"Amount":123.456, "Name":"string", "Notes":"string", "PaymentMethodId":123, "SessionKey":"string"}

[{"Amount":123.456,"Name":"string","Notes":"string","PaymentMethodId":123,"SessionKey":"string"}]

Amount,Name,Notes,PaymentMethodId,SessionKey
123.456,"""string""","""string""",123,"""string"""
  • --AddNFSPackagePerformanceItem
    Adds a new nfs package item to the cart This method adds a seated or unseated non fixed seat (NFS) or flex package to the cart by adding the component performances. When the package is seated, the best seating function can be used or specific seat numbers can be passed for use with SYOS functionality.
    A NFS or flex package line item is created when the first component performance is added to the cart.The ID number from the package line item is required when the remaining component performances are added. It is returned as NFSPackageLineItemId in the method's response. /Web/Cart/Validation can be called at any time, setting the ValidateNFSPackages boolean to true, to determine whether all of the rules for the package have been met with items in the shopping cart. This method will allow the reservation of held seats. To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
Query:
{"LeaveSingleSeats":true, "NFSPackageLineItemId":123, "NumberOfSeats":123, "PackageId":123, "PerformanceGroupId":123, "PerformanceId":123, "PriceType":"string", "PriceTypeReason":"string", "RequestedSeats":"string", "SpecialRequests":"string", "Unseated":true, "ZoneId":123, "SessionKey":"string"}

[{"LeaveSingleSeats":true,"NFSPackageLineItemId":123,"NumberOfSeats":123,"PackageId":123,"PerformanceGroupId":123,"PerformanceId":123,"PriceType":"string","PriceTypeReason":"string","RequestedSeats":"string","SessionKey":"string","SpecialRequests":"string","Unseated":true,"ZoneId":123}]

LeaveSingleSeats,NFSPackageLineItemId,NumberOfSeats,PackageId,PerformanceGroupId,PerformanceId,PriceType,PriceTypeReason,RequestedSeats,SessionKey,SpecialRequests,Unseated,ZoneId
true,123,123,123,123,123,"""string""","""string""","""string""","""string""","""string""",true,123
  • --AddOnAccount
    Adds an On Account balance to the cart Checkout will not be allowed for a general public order if On Account balance is added.
Query:
{"Amount":123.456, "Notes":"string", "PaymentMethodId":123, "SessionKey":"string"}

[{"Amount":123.456,"Notes":"string","PaymentMethodId":123,"SessionKey":"string"}]

Amount,Notes,PaymentMethodId,SessionKey
123.456,"""string""",123,"""string"""
  • --AddPackageItem
    Adds a new fixed seat package item to the cart Adds a seated or unseated fixed seat package line item to the cart and reserves seats using either the best seat function or reserves specific seats. PackageId line items can be added as alternate/upgrade line items to another line item in the cart. To add an alternate/upgrade line item, the parent line item ID must be retrieved using /Web/Cart (GET) and then passed as the ParentPackageLineItemId parameter value for this method. This method will allow the reservation of held seats.To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
Query:
{"LeaveSingleSeats":true, "NumberOfSeats":123, "PackageId":123, "ParentPackageLineItemId":123, "PriceType":"string", "PriceTypeReason":"string", "RequestedSeats":"string", "Unseated":true, "ZoneId":123, "SessionKey":"string"}

[{"LeaveSingleSeats":true,"NumberOfSeats":123,"PackageId":123,"ParentPackageLineItemId":123,"PriceType":"string","PriceTypeReason":"string","RequestedSeats":"string","SessionKey":"string","Unseated":true,"ZoneId":123}]

LeaveSingleSeats,NumberOfSeats,PackageId,ParentPackageLineItemId,PriceType,PriceTypeReason,RequestedSeats,SessionKey,Unseated,ZoneId
true,123,123,123,"""string""","""string""","""string""","""string""",true,123
  • --AddPaymentPlan
    Sets a payment plan on the cart using a start date, end date and a specific number of payments to be spread across the date range. The due date for the first payment is set to the entered beginning date, and the due date for subsequent payments is calculated by adding an equal number of days to each previous payment, based on the amount of time between the beginning and ending dates.
Query:
{"AccountId":123, "BillingTypeId":123, "Card":{"ExpiryMonth":123, "ExpiryYear":123, "Name":"string", "Number":"string", "PaymentMethodGroupId":123}, "EndDate":"2000-01-01T00:00:00.000Z", "NumberOfPayments":123, "StartDate":"2000-01-01T00:00:00.000Z", "SessionKey":"string"}

[{"AccountId":123,"BillingTypeId":123,"Card.ExpiryMonth":123,"Card.ExpiryYear":123,"Card.Name":"string","Card.Number":"string","Card.PaymentMethodGroupId":123,"EndDate":"2000-01-01T00:00:00.000Z","NumberOfPayments":123,"SessionKey":"string","StartDate":"2000-01-01T00:00:00.000Z"}]

AccountId,BillingTypeId,Card.ExpiryMonth,Card.ExpiryYear,Card.Name,Card.Number,Card.PaymentMethodGroupId,EndDate,NumberOfPayments,SessionKey,StartDate
123,123,123,123,"""string""","""string""",123,"""2000-01-01T00:00:00.000Z""",123,"""string""","""2000-01-01T00:00:00.000Z"""
  • --AddPaymentPlanBasedOnBillingSchedule
    Sets a payment plan on the cart using a start date, end date and a pre-defined billing schedule. The number of payments, payment amounts, and payment due dates are calculated based on the selected billing schedule. For details on setting up billing schedules see the TR_BILLING_SCHEDULE section of the System Tables document.
Query:
{"AccountId":123, "BillingScheduleId":123, "BillingTypeId":123, "Card":{"ExpiryMonth":123, "ExpiryYear":123, "Name":"string", "Number":"string", "PaymentMethodGroupId":123}, "EndDate":"2000-01-01T00:00:00.000Z", "OverrideAmountToSchedule":123.456, "StartDate":"2000-01-01T00:00:00.000Z", "SessionKey":"string"}

[{"AccountId":123,"BillingScheduleId":123,"BillingTypeId":123,"Card.ExpiryMonth":123,"Card.ExpiryYear":123,"Card.Name":"string","Card.Number":"string","Card.PaymentMethodGroupId":123,"EndDate":"2000-01-01T00:00:00.000Z","OverrideAmountToSchedule":123.456,"SessionKey":"string","StartDate":"2000-01-01T00:00:00.000Z"}]

AccountId,BillingScheduleId,BillingTypeId,Card.ExpiryMonth,Card.ExpiryYear,Card.Name,Card.Number,Card.PaymentMethodGroupId,EndDate,OverrideAmountToSchedule,SessionKey,StartDate
123,123,123,123,123,"""string""","""string""",123,"""2000-01-01T00:00:00.000Z""",123.456,"""string""","""2000-01-01T00:00:00.000Z"""
  • --AddPaymentPlanInstallments
    Sets a payment plan on the cart using a start date, end date and a list of installments with amount and due date. The total of the installment amounts must add up to the cart total. /Web/Cart/Validation can be used to validate that the payment plan is correct by passing True for ValidatePaymentPlan in that method.
Query:
{"AccountId":123, "BillingTypeId":123, "Card":{"ExpiryMonth":123, "ExpiryYear":123, "Name":"string", "Number":"string", "PaymentMethodGroupId":123}, "PaymentPlanInstallments":[{"Amount":123.456}, ...], "SessionKey":"string"}
  • --AddSubPackageItem
    Adds a new sub package item to the cart This method is used to add a seated or unseated super package line item to the cart for the specified session by adding the component sub packages. When the package is seated, the best seating function can be used or specific seat numbers can be passed for use with SYOS functionality. The method must be called once for each sub package. A super package line item is created when the first sub package is added to the cart.The ID number from the super package line item is required when the remaining component sub packages are added.It is returned as SuperPackageLineItemId in the response. Super package line items can be added as alternate/upgrade line items to another super package line item in the cart. To add an alternate/upgrade line item, the parent line item ID must be passed as the ParentSuperPackageLineItemId parameter value for this method.The parent line item ID can be retrieved using the /Web/Cart (GET) method.
Query:
{"LeaveSingleSeats":true, "NumberOfSeats":123, "ParentSuperPackageLineItemId":123, "PriceType":"string", "PriceTypeReason":"string", "RequestedSeats":"string", "SubPackageId":123, "SuperPackageLineItemId":123, "Unseated":true, "ZoneId":123, "SessionKey":"string"}

[{"LeaveSingleSeats":true,"NumberOfSeats":123,"ParentSuperPackageLineItemId":123,"PriceType":"string","PriceTypeReason":"string","RequestedSeats":"string","SessionKey":"string","SubPackageId":123,"SuperPackageLineItemId":123,"Unseated":true,"ZoneId":123}]

LeaveSingleSeats,NumberOfSeats,ParentSuperPackageLineItemId,PriceType,PriceTypeReason,RequestedSeats,SessionKey,SubPackageId,SuperPackageLineItemId,Unseated,ZoneId
true,123,123,"""string""","""string""","""string""","""string""",123,123,true,123
  • --ApplyCashPayment
    Applies a cash payment to the cart
Query:
{"Amount":123.456, "Notes":"string", "PaymentMethodId":123, "TenderedAmount":123.456, "SessionKey":"string"}

[{"Amount":123.456,"Notes":"string","PaymentMethodId":123,"SessionKey":"string","TenderedAmount":123.456}]

Amount,Notes,PaymentMethodId,SessionKey,TenderedAmount
123.456,"""string""",123,"""string""",123.456
  • --ApplyCheckPayment
    Applies a check payment to the cart
Query:
{"Amount":123.456, "CheckNumber":"string", "Notes":"string", "PayerName":"string", "PaymentMethodId":123, "SessionKey":"string"}

[{"Amount":123.456,"CheckNumber":"string","Notes":"string","PayerName":"string","PaymentMethodId":123,"SessionKey":"string"}]

Amount,CheckNumber,Notes,PayerName,PaymentMethodId,SessionKey
123.456,"""string""","""string""","""string""",123,"""string"""
  • --ApplyGiftCertificate
    Applies a gift certificate as payment for a cart
Query:
{"Amount":123.456, "GiftCertificateNumber":"string", "Notes":"string", "SessionKey":"string"}

[{"Amount":123.456,"GiftCertificateNumber":"string","Notes":"string","SessionKey":"string"}]

Amount,GiftCertificateNumber,Notes,SessionKey
123.456,"""string""","""string""","""string"""
  • --ApplyInvoicePayment
    Applies an invoice payment to the cart Checkout will not be allowed for a general public order if an Invoice payment is applied
Query:
{"Amount":123.456, "Notes":"string", "PaymentMethodId":123, "SessionKey":"string"}

[{"Amount":123.456,"Notes":"string","PaymentMethodId":123,"SessionKey":"string"}]

Amount,Notes,PaymentMethodId,SessionKey
123.456,"""string""",123,"""string"""
  • --ApplyOnAccountPayment
    Applies an On Account payment to the cart. Not valid for a general public cart.
Query:
{"Amount":123.456, "Notes":"string", "PaymentMethodId":123, "SessionKey":"string"}

[{"Amount":123.456,"Notes":"string","PaymentMethodId":123,"SessionKey":"string"}]

Amount,Notes,PaymentMethodId,SessionKey
123.456,"""string""",123,"""string"""
  • --ApplyOtherPayment
    Applies an other payment to the cart
Query:
{"Amount":123.456, "Notes":"string", "PaymentMethodId":123, "SessionKey":"string"}

[{"Amount":123.456,"Notes":"string","PaymentMethodId":123,"SessionKey":"string"}]

Amount,Notes,PaymentMethodId,SessionKey
123.456,"""string""",123,"""string"""
  • --Authorize
    Authorize payment using a card reader in a web based transaction.
Query:
{"Amount":123.456, "IsMoto":true, "MachineId":123, "TransactionOrigin":"string", "UserData":"string", "SessionKey":"string"}

[{"Amount":123.456,"IsMoto":true,"MachineId":123,"SessionKey":"string","TransactionOrigin":"string","UserData":"string"}]

Amount,IsMoto,MachineId,SessionKey,TransactionOrigin,UserData
123.456,true,123,"""string""","""string""","""string"""
  • --Checkout
    Validates, processes payment for, and saves an order for a specified session.
    Payment information can be provided as follows:
  • The full card details can be provided in the request
  • The request includes parameters for use with the 3D Secure protocol used by credit card verification services such as Verified by Visa and MasterCard SecureCode.
  • The method also allows the credit card authorization process to be skipped, which allows the use of third party authorizations.
  • The AccountID property in the request can be used in place of specifying credit card information. When a valid id value from CRM/Accounts is provided and the stored card data belongs to either the session owner or the session initiator, then that card data is passed through for authorization.If the account is invalid or does not belong to the session owner or initiator, then an error is returned.
  • Additionally, this method has two additional Address Verification parameters, allowing a calling application to optionally specify the street address and zip code that represents the billing address for the credit card.

When the method is run the status of the order is checked to ensure checkout has not started. The procedure will set the status in T_WEB_CHECKOUT to one of the following values: (S)ave in progress, (C)ompleted save, (E)rror when saving. The response includes a status and message details about the status.Possible status results are: SaveInProgress, SaveComplete, Error. In order to facilitate the use of the interceptor capability, the checkout method now makes a POST call to Txn / Orders.By default this call does nothing unless a developer has added interceptor plug -in code to the exposure.

Query:
{"AccountId":123, "Address":"string", "AllowUnderPayment":true, "Amount":123.456, "AuthorizationCode":"string", "Authorize":true, "CreditCardAuthenticationCode":"string", "CreditCardMonth":123, "CreditCardNumber":"string", "CreditCardOwner":"string", "CreditCardType":123, "CreditCardYear":123, "DeliveryDate":"2000-01-01T00:00:00.000Z", "ECommerce":true, "PaymentId":123, "PaymentReference":"string", "SecureValues":"string", "StoreAccount":true, "ZipCode":"string", "SessionKey":"string"}

[{"AccountId":123,"Address":"string","AllowUnderPayment":true,"Amount":123.456,"AuthorizationCode":"string","Authorize":true,"CreditCardAuthenticationCode":"string","CreditCardMonth":123,"CreditCardNumber":"string","CreditCardOwner":"string","CreditCardType":123,"CreditCardYear":123,"DeliveryDate":"2000-01-01T00:00:00.000Z","ECommerce":true,"PaymentId":123,"PaymentReference":"string","SecureValues":"string","SessionKey":"string","StoreAccount":true,"ZipCode":"string"}]

AccountId,Address,AllowUnderPayment,Amount,AuthorizationCode,Authorize,CreditCardAuthenticationCode,CreditCardMonth,CreditCardNumber,CreditCardOwner,CreditCardType,CreditCardYear,DeliveryDate,ECommerce,PaymentId,PaymentReference,SecureValues,SessionKey,StoreAccount,ZipCode
123,"""string""",true,123.456,"""string""",true,"""string""",123,"""string""","""string""",123,123,"""2000-01-01T00:00:00.000Z""",true,123,"""string""","""string""","""string""",true,"""string"""
  • --CheckoutWithCard
    Processes checkout for the cart, using card swipe information for payment. Used by TRBO. When the method is run the status of the order is checked to ensure checkout has not started. The procedure will set the status in T_WEB_CHECKOUT to one of the following values: (S)ave in progress, (C)ompleted save, (E)rror when saving. The response includes a status and message details about the status.Possible status results are: SaveInProgress, SaveComplete, Error. In order to facilitate the use of the interceptor capability, the checkout method now makes a POST call to Txn / Orders.By default this call does nothing unless a developer has added interceptor plug -in code to the exposure.
Query:
{"AllowUnderPayment":true, "Amount":123.456, "AuthorizationCode":"string", "Authorize":true, "CreditCardTrack1":"string", "CreditCardTrack2":"string", "CreditCardType":123, "DeliveryDate":"2000-01-01T00:00:00.000Z", "ECommerce":true, "StoreAccount":true, "ZipCode":"string", "SessionKey":"string"}

[{"AllowUnderPayment":true,"Amount":123.456,"AuthorizationCode":"string","Authorize":true,"CreditCardTrack1":"string","CreditCardTrack2":"string","CreditCardType":123,"DeliveryDate":"2000-01-01T00:00:00.000Z","ECommerce":true,"SessionKey":"string","StoreAccount":true,"ZipCode":"string"}]

AllowUnderPayment,Amount,AuthorizationCode,Authorize,CreditCardTrack1,CreditCardTrack2,CreditCardType,DeliveryDate,ECommerce,SessionKey,StoreAccount,ZipCode
true,123.456,"""string""",true,"""string""","""string""",123,"""2000-01-01T00:00:00.000Z""",true,"""string""",true,"""string"""
  • --PreviewPaymentPlanBasedOnBillingSchedule
    Returns the payment schedule that would be applied to the current cart for the selected billing schedule without applying it to the cart. The number of payments, payment amounts, and payment due dates are calculated based on the selected billing schedule. For details on setting up billing schedules see the TR_BILLING_SCHEDULE section of the System Tables document.
Query:
{"BillingScheduleId":123, "EndDate":"2000-01-01T00:00:00.000Z", "OverrideAmountToSchedule":123.456, "StartDate":"2000-01-01T00:00:00.000Z", "SessionKey":"string"}

[{"BillingScheduleId":123,"EndDate":"2000-01-01T00:00:00.000Z","OverrideAmountToSchedule":123.456,"SessionKey":"string","StartDate":"2000-01-01T00:00:00.000Z"}]

BillingScheduleId,EndDate,OverrideAmountToSchedule,SessionKey,StartDate
123,"""2000-01-01T00:00:00.000Z""",123.456,"""string""","""2000-01-01T00:00:00.000Z"""
  • --Price
    Price the current web cart associated with the specified sessionKey.
Query:
{"SessionKey":"string"}

[{"SessionKey":"string"}]

SessionKey
"""string"""
  • --PrintEmail
    Prints tickets for specified order, lineitems, or sublineitems and returns a formatted html body and attachments The method returns tickets for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Only tickets belonging to the customer associated via the current web session can be returned. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the tickets have been returned via the API, seats will be flagged as Ticketed in Tessitura. When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number. If PrinterType = "B", ticket designs with images are not supported
Query:
{"ReceiptSettingsID":"string", "HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "Mode":123, "NewTicketNoForReprints":true, "OrderId":123, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123, "SessionKey":"string"}

[{"HeaderDesignId":123,"IncludeReceipts":true,"LineItems":"string","Mode":123,"NewTicketNoForReprints":true,"OrderId":123,"PrinterType":"string","ReceiptSettingsID":"string","ReprintTickets":true,"SessionKey":"string","SubLineItems":"string","TicketDesignId":123}]

HeaderDesignId,IncludeReceipts,LineItems,Mode,NewTicketNoForReprints,OrderId,PrinterType,ReceiptSettingsID,ReprintTickets,SessionKey,SubLineItems,TicketDesignId
123,true,"""string""",123,true,123,"""string""","""string""",true,"""string""","""string""",123
  • --PrintPrintStrings
    Prints tickets for specified order, lineitems, or sublineitems and returns a collection of formatted strings based on printer type. The returned strings can then be sent to the appropriate printer. NOTE: Currently only Zebra printer types are supported by this method. (PrinterType = "Z") The method returns tickets for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Only tickets belonging to the customer associated via the current web session can be returned. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the tickets have been returned via the API, seats will be flagged as Ticketed in Tessitura. When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number.
Query:
{"HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "Mode":123, "NewTicketNoForReprints":true, "OrderId":123, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123, "SessionKey":"string"}

[{"HeaderDesignId":123,"IncludeReceipts":true,"LineItems":"string","Mode":123,"NewTicketNoForReprints":true,"OrderId":123,"PrinterType":"string","ReprintTickets":true,"SessionKey":"string","SubLineItems":"string","TicketDesignId":123}]

HeaderDesignId,IncludeReceipts,LineItems,Mode,NewTicketNoForReprints,OrderId,PrinterType,ReprintTickets,SessionKey,SubLineItems,TicketDesignId
123,true,"""string""",123,true,123,"""string""",true,"""string""","""string""",123
  • --PrintTicketElements
    Prints tickets for specified order, lineitems, or sublineitems and returns all ticket elements. The method returns ticket data for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Only tickets belonging to the customer associated via the current web session can be returned. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the ticket data has been returned via the API, seats will be flagged as Ticketed in Tessitura. When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number.
Query:
{"HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "Mode":123, "NewTicketNoForReprints":true, "OrderId":123, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123, "SessionKey":"string"}

[{"HeaderDesignId":123,"IncludeReceipts":true,"LineItems":"string","Mode":123,"NewTicketNoForReprints":true,"OrderId":123,"PrinterType":"string","ReprintTickets":true,"SessionKey":"string","SubLineItems":"string","TicketDesignId":123}]

HeaderDesignId,IncludeReceipts,LineItems,Mode,NewTicketNoForReprints,OrderId,PrinterType,ReprintTickets,SessionKey,SubLineItems,TicketDesignId
123,true,"""string""",123,true,123,"""string""",true,"""string""","""string""",123
  • --ReserveTickets
    Reserves tickets in cart Adds a seated or unseated performance line item to the cart and reserves seats using either the best seat function or reserves specific seats. This method will allow the reservation of held seats.To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
Query:
{"NumberOfSeats":123, "PerformanceId":123, "PriceType":"string", "PriceTypeReason":"string", "RequestedSeats":"string", "SpecialRequests":"string", "Unseated":true, "ZoneId":123, "SessionKey":"string"}

[{"NumberOfSeats":123,"PerformanceId":123,"PriceType":"string","PriceTypeReason":"string","RequestedSeats":"string","SessionKey":"string","SpecialRequests":"string","Unseated":true,"ZoneId":123}]

NumberOfSeats,PerformanceId,PriceType,PriceTypeReason,RequestedSeats,SessionKey,SpecialRequests,Unseated,ZoneId
123,123,"""string""","""string""","""string""","""string""","""string""",true,123
  • --ReserveTicketsForLineItem
    Reserves tickets in cart for an existing line item PerformanceId specified must be valid for the line item
Query:
{"LineItemID":"string", "NumberOfSeats":123, "PerformanceId":123, "PriceType":"string", "PriceTypeReason":"string", "RequestedSeats":"string", "SpecialRequests":"string", "Unseated":true, "ZoneId":123, "SessionKey":"string"}

[{"LineItemID":"string","NumberOfSeats":123,"PerformanceId":123,"PriceType":"string","PriceTypeReason":"string","RequestedSeats":"string","SessionKey":"string","SpecialRequests":"string","Unseated":true,"ZoneId":123}]

LineItemID,NumberOfSeats,PerformanceId,PriceType,PriceTypeReason,RequestedSeats,SessionKey,SpecialRequests,Unseated,ZoneId
"""string""",123,123,"""string""","""string""","""string""","""string""","""string""",true,123
  • --ReturnTicket
    Return a ticket by ticket number. This method is used to return tickets (generally for exchanges). The method can also be used to donate a ticket for resale. Returning a ticket will generate a credit on the ticket order.The credit must be applied to another line item(performance, package, etc.), fee, contribution, or on account payment method. Donating a ticket uses the standard Tessitura Donate for Resale function, which releases the seat without generating a credit.
Query:
{"Checksum":"string", "ReturnOrDonate":"string", "TicketNumber":123, "SessionKey":"string"}

[{"Checksum":"string","ReturnOrDonate":"string","SessionKey":"string","TicketNumber":123}]

Checksum,ReturnOrDonate,SessionKey,TicketNumber
"""string""","""string""","""string""",123
  • --ReturnTicketWithSeat
    Return a ticket by seat number. This method is used to return tickets (generally for exchanges). The method can also be used to donate a ticket for resale. Returning a ticket will generate a credit on the ticket order.The credit must be applied to another line item(performance, package, etc.), fee, contribution, or on account payment method. Donating a ticket uses the standard Tessitura Donate for Resale function, which releases the seat without generating a credit.
Query:
{"Checksum":"string", "PerformanceId":123, "ReturnOrDonate":"string", "SeatNumber":123, "SessionKey":"string"}

[{"Checksum":"string","PerformanceId":123,"ReturnOrDonate":"string","SeatNumber":123,"SessionKey":"string"}]

Checksum,PerformanceId,ReturnOrDonate,SeatNumber,SessionKey
"""string""",123,"""string""",123,"""string"""
  • --Validate
    Validates various aspects of the cart Payment Plans, Fixed Seat Packages, Non-Fixed Seat (flex) packages and Super Packages can be validated by setting the appropriate boolean in the request.
Query:
{"ValidateFSPackages":true, "ValidateNFSPackages":true, "ValidatePaymentPlan":true, "ValidateSuperPackages":true, "SessionKey":"string"}

[{"SessionKey":"string","ValidateFSPackages":true,"ValidateNFSPackages":true,"ValidatePaymentPlan":true,"ValidateSuperPackages":true}]

SessionKey,ValidateFSPackages,ValidateNFSPackages,ValidatePaymentPlan,ValidateSuperPackages
"""string""",true,true,true,true
  • --ValidateLimits
    Validates ticket limits Offer Limits are evaluated for the specified price type and seat count using the cart source code. Requires either a performance ID or a package ID. To enable ticket limit validation, add the Field Name "ENFORCE_SEAT_LIMIT_FOR_ORDERS" under the "Impresario" parent table with a value of "Yes." This setting applies to both the Web API and the Tessitura Client Application.
Query:
{"PackageId":123, "PerformanceId":123, "PriceTypeId":123, "SeatCount":123, "SessionKey":"string"}

[{"PackageId":123,"PerformanceId":123,"PriceTypeId":123,"SeatCount":123,"SessionKey":"string"}]

PackageId,PerformanceId,PriceTypeId,SeatCount,SessionKey
123,123,123,123,"""string"""

Colors
get put

Create a new color.

Usage:
tq post Colors
Query:
{"ColorValue":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ColorValue":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ColorValue,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

Composers
get put

Create a new composer.

Usage:
tq post Composers
Query:
{"Bio":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "FirstName":"string", "Id":123, "Inactive":true, "LastName":"string", "MiddleName":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Bio":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","FirstName":"string","Id":123,"Inactive":true,"LastName":"string","MiddleName":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Bio,CreateLocation,CreatedBy,CreatedDateTime,FirstName,Id,Inactive,LastName,MiddleName,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

Constituencies
get put

Create a new constituency.

Usage:
tq post Constituencies
Query:
{"ConstituencyType":{"Id":123}, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "EndDate":"2000-01-01T00:00:00.000Z", "Id":123, "StartDate":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ConstituencyType.Id":123,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"EndDate":"2000-01-01T00:00:00.000Z","Id":123,"StartDate":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ConstituencyType.Id,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,EndDate,Id,StartDate,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,"""2000-01-01T00:00:00.000Z""",123,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

ConstituencyTypes
get put

Create a new constituency type.

Usage:
tq post ConstituencyTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Rank":123, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Rank":123,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Rank,ShortDescription,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ConstituentDocuments
get put

Create document for a constituent.

Usage:
tq post ConstituentDocuments
Query:
{"Category":{"Id":123}, "ConstituentId":123, "Contents":"AA==", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "FileName":"string", "Id":123, "Notes":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Category.Id":123,"ConstituentId":123,"Contents":"AA==","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","FileName":"string","Id":123,"Notes":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category.Id,ConstituentId,Contents,CreateLocation,CreatedBy,CreatedDateTime,Description,FileName,Id,Notes,UpdatedBy,UpdatedDateTime
123,123,"""AA==""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ConstituentGroups
get put

Create a new constituent group.

Usage:
tq post ConstituentGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ConstituentInactives
get put

Create a new constituent inactive.

Usage:
tq post ConstituentInactives
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ConstituentProtectionTypes
get put

Create a new constituent protection type.

Usage:
tq post ConstituentProtectionTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ConstituentTypeAffiliates
get put

Create a new constituent type affiliate.

Usage:
tq post ConstituentTypeAffiliates
Query:
{"AffiliationType":{"Id":123}, "ConstituentType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "HouseholdPrimary":true, "Id":123, "Rank":123, "ShowWithGroup":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AffiliationType.Id":123,"ConstituentType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","HouseholdPrimary":true,"Id":123,"Rank":123,"ShowWithGroup":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AffiliationType.Id,ConstituentType.Id,CreateLocation,CreatedBy,CreatedDateTime,HouseholdPrimary,Id,Rank,ShowWithGroup,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ConstituentTypes
get put

Create a new constituent type.

Usage:
tq post ConstituentTypes
Query:
{"AddressTypeId":123, "ConstituentGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultAffiliatedConstituentTypeId":123, "DefaultAffiliationTypeId":123, "DefaultIndicator":true, "DefaultSalutationId":123, "Description":"string", "ElectronicAddressTypeId":123, "GiftAidIndicator":true, "Id":123, "Inactive":true, "LoginTypeId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AddressTypeId":123,"ConstituentGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultAffiliatedConstituentTypeId":123,"DefaultAffiliationTypeId":123,"DefaultIndicator":true,"DefaultSalutationId":123,"Description":"string","ElectronicAddressTypeId":123,"GiftAidIndicator":true,"Id":123,"Inactive":true,"LoginTypeId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AddressTypeId,ConstituentGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultAffiliatedConstituentTypeId,DefaultAffiliationTypeId,DefaultIndicator,DefaultSalutationId,Description,ElectronicAddressTypeId,GiftAidIndicator,Id,Inactive,LoginTypeId,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,true,123,"""string""",123,true,123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

Constituents
get put

Create a new constituent with addresses, electronicAddresses, salutations and phones.

Usage:
tq post Constituents
Query:
{"Addresses":[{"Id":123}, ...], "ConstituentType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DisplayName":"string", "ElectronicAddresses":[{"Id":123}, ...], "EmarketIndicator":{"Id":123}, "FirstName":"string", "Gender":{"Id":123}, "Id":123, "Inactive":{"Id":123}, "InactiveReason":{"Id":123}, "LastActivityDate":"2000-01-01T00:00:00.000Z", "LastGiftDate":"2000-01-01T00:00:00.000Z", "LastName":"string", "LastTicketDate":"2000-01-01T00:00:00.000Z", "MailIndicator":{"Id":123}, "MiddleName":"string", "NameStatus":{"Id":123}, "OriginalSource":{"Id":123}, "PhoneIndicator":{"Id":123}, "PhoneNumbers":[{"Id":123}, ...], "Prefix":{"Id":123}, "ProtectionType":{"Id":123}, "Salutations":[{"Id":123}, ...], "SortName":"string", "Suffix":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Flags:

  • --ConstituentUsingSnapshot
    Create a constituent optionally with primary address, primary salutation, primary electronic address, primary & general phones and affiliates information.
Query:
{"Address":{"Id":123}, "Affiliates":[{"Id":123}, ...], "ConstituentType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DisplayName":"string", "EditIndicator":true, "ElectronicAddress":{"Id":123}, "EmarketIndicator":{"Id":123}, "FirstName":"string", "Gender":{"Id":123}, "Id":123, "Inactive":{"Id":123}, "InactiveReason":{"Id":123}, "LastActivityDate":"2000-01-01T00:00:00.000Z", "LastName":"string", "MailIndicator":{"Id":123}, "MiddleName":"string", "NameStatus":{"Id":123}, "OriginalSource":{"Id":123}, "PhoneIndicator":{"Id":123}, "Prefix":{"Id":123}, "PrimaryPhoneNumbers":[{"Id":123}, ...], "ProtectionType":{"Id":123}, "Salutation":{"Id":123}, "ShortDisplayName":"string", "SortName":"string", "Suffix":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}
  • --ConvertGroupToIndividual
    Convert existing household to an individual.
Query:
{"ConstituentID":"string", "AffiliationIdsToBeDeleted":[0, ...], "AffiliationsToAssociationsInfo":[{"AffiliationId":123, "AssociationTypeId":123}, ...], "AssociationIdsToBeDeleted":[0, ...], "AssociationsToAffiliationsInfo":[{"AffiliationTypeId":123, "AssociationId":123}, ...], "IndividualConstituent":{"FirstName":"string", "GenderId":123, "LastName":"string", "MiddleName":"string", "PrefixId":123, "SuffixId":123}, "Merge":{"ConstituentIdToDelete":123, "ConstituentIdToKeep":123}}
  • --ConvertIndividualToHousehold
    Convert existing individual constituent to a household.
Query:
{"ConstituentID":"string", "AffiliationTypeId":123, "ConstituentTypeId":123}

[{"AffiliationTypeId":123,"ConstituentID":"string","ConstituentTypeId":123}]

AffiliationTypeId,ConstituentID,ConstituentTypeId
123,"""string""",123
  • --ConvertIndividualToOrganization
    Convert existing individual constituent to an organization.
Query:
{"ConstituentID":"string", "AffiliationIdsToBeDeleted":[0, ...], "AffiliationsToAssociationsInfo":[{"AffiliationId":123, "AssociationTypeId":123}, ...], "AssociationIdsToBeDeleted":[0, ...], "AssociationsToAffiliationsInfo":[{"AffiliationTypeId":123, "AssociationId":123}, ...], "ConstituentTypeId":123, "LastName":"string"}
  • --SchedulePurge
    Schedule a constituent to be purged. This only marks a constituent for purge, but does not actually purge the constituent. If constituent has open transactions or an order for a future performance, a bad request will be returned indicating open transactions. Pass IgnoreWarnings = true in request to bypass and schedule.
Query:
{"ConstituentID":"string", "IgnoreWarnings":true}

[{"ConstituentID":"string","IgnoreWarnings":true}]

ConstituentID,IgnoreWarnings
"""string""",true
  • --SearchByCardNumber
    Search for constituents by card number.
Query:
{"CardNumber":"string"}

[{"CardNumber":"string"}]

CardNumber
"""string"""
  • --SwapConstituentA1A2
    Swaps A1/A2 names on a household account and regenerates its salutation.
Query:
{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""
  • --UnschedulePurge
    Unschedule a constituent that has been previously set to be purged. If a purge has been completed, an error will be returned.
Query:
{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

ContactPermissionCategories
get put

Create a new contact permission category.

Usage:
tq post ContactPermissionCategories
Query:
{"AskFrequencyMonths":123, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AskFrequencyMonths":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AskFrequencyMonths,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ContactPermissionTypes
get put

Create a new contact permission type.

Usage:
tq post ContactPermissionTypes
Query:
{"Category":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultValueForAdd":"string", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "Presenter":true, "Rank":123, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Category.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultValueForAdd":"string","Description":"string","EditIndicator":true,"Id":123,"Inactive":true,"Presenter":true,"Rank":123,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultValueForAdd,Description,EditIndicator,Id,Inactive,Presenter,Rank,ShortDescription,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",true,123,true,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ContactPermissions
get put

Create a new contact permission

Usage:
tq post ContactPermissions
Query:
{"Answer":"string", "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "LastAskedDateTime":"2000-01-01T00:00:00.000Z", "ShouldAsk":true, "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Answer":"string","Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"LastAskedDateTime":"2000-01-01T00:00:00.000Z","ShouldAsk":true,"Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Answer,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,LastAskedDateTime,ShouldAsk,Type.Id,UpdatedBy,UpdatedDateTime
"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,"""2000-01-01T00:00:00.000Z""",true,123,"""string""","""2000-01-01T00:00:00.000Z"""

Flags:

  • --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.
Query:
{"InitiatorId":123, "OwnerId":123, "ProductionSeasonIds":"string", "ReturnRequiredOnly":true}

[{"InitiatorId":123,"OwnerId":123,"ProductionSeasonIds":"string","ReturnRequiredOnly":true}]

InitiatorId,OwnerId,ProductionSeasonIds,ReturnRequiredOnly
123,123,"""string""",true

ContactPointCategories
get put

Create a new contact point category.

Usage:
tq post ContactPointCategories
Query:
{"ContactPointKey":"string", "ContactPointTable":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ContactPointKey":"string","ContactPointTable":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ContactPointKey,ContactPointTable,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

ContactPointCategoryPurposes
get put

Create a new contact point category purpose.

Usage:
tq post ContactPointCategoryPurposes
Query:
{"ContactPointCategory":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Purpose":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ContactPointCategory.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Purpose.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ContactPointCategory.Id,CreateLocation,CreatedBy,CreatedDateTime,Id,Purpose.Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ContactPointPurposeCategories
get put

Create a new contact point purpose category.

Usage:
tq post ContactPointPurposeCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ContactPointPurposeMaps
get put

Create a new contact point purpose.

Usage:
tq post ContactPointPurposeMaps
Query:
{"ContactPoint":{"Id":123}, "ContactPointCategory":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "Purpose":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ContactPoint.Id":123,"ContactPointCategory.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"Purpose.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ContactPoint.Id,ContactPointCategory.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,Purpose.Id,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ContactPointPurposes
get put

Create a new contact point purpose.

Usage:
tq post ContactPointPurposes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "PurposeCategory":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"PurposeCategory.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,PurposeCategory.Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

ContactTypes
get put

Create a new contact type.

Usage:
tq post ContactTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ContributionDesignations
get put

Create a new contribution designation.

Usage:
tq post ContributionDesignations
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "LetterText":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"LetterText":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,LetterText,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ContributionImportSets
get put

Create a new contributionImportSet.

Usage:
tq post ContributionImportSets
Query:
{"AccountMatchKeyword":{"Id":123}, "AcknowledgmentLetterMode":123, "BatchType":{"Id":123}, "BillingSchedule":{"Id":123}, "BillingType":{"Id":123}, "Campaign":{"Id":123}, "ContributionDateTime":"2000-01-01T00:00:00.000Z", "ContributionPayMode":123, "CreateLocation":"string", "CreatePotentialDuplicate":true, "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CrediteeMode":123, "CrediteeType":{"Id":123}, "DefaultConstituentType":{"Id":123}, "DefaultCountryCode":"string", "DefaultHouseholdConstituentType":{"Id":123}, "DefaultOriginalSource":{"Id":123}, "Description":"string", "Designation":{"Id":123}, "FilePath":"string", "FormatFile":"string", "Fund":{"Id":123}, "Id":123, "ImportRefNoLocation":123, "Inactive":true, "PaymentMethod":{"Id":123}, "SalesChannel":{"Id":123}, "Source":{"Id":123}, "StripPhoneFormatting":true, "TransactAsHousehold":true, "TransactAsHouseholdCreditee":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Worker":{"Id":123}}

[{"AccountMatchKeyword.Id":123,"AcknowledgmentLetterMode":123,"BatchType.Id":123,"BillingSchedule.Id":123,"BillingType.Id":123,"Campaign.Id":123,"ContributionDateTime":"2000-01-01T00:00:00.000Z","ContributionPayMode":123,"CreateLocation":"string","CreatePotentialDuplicate":true,"CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","CrediteeMode":123,"CrediteeType.Id":123,"DefaultConstituentType.Id":123,"DefaultCountryCode":"string","DefaultHouseholdConstituentType.Id":123,"DefaultOriginalSource.Id":123,"Description":"string","Designation.Id":123,"FilePath":"string","FormatFile":"string","Fund.Id":123,"Id":123,"ImportRefNoLocation":123,"Inactive":true,"PaymentMethod.Id":123,"SalesChannel.Id":123,"Source.Id":123,"StripPhoneFormatting":true,"TransactAsHousehold":true,"TransactAsHouseholdCreditee":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Worker.Id":123}]

AccountMatchKeyword.Id,AcknowledgmentLetterMode,BatchType.Id,BillingSchedule.Id,BillingType.Id,Campaign.Id,ContributionDateTime,ContributionPayMode,CreateLocation,CreatePotentialDuplicate,CreatedBy,CreatedDateTime,CrediteeMode,CrediteeType.Id,DefaultConstituentType.Id,DefaultCountryCode,DefaultHouseholdConstituentType.Id,DefaultOriginalSource.Id,Description,Designation.Id,FilePath,FormatFile,Fund.Id,Id,ImportRefNoLocation,Inactive,PaymentMethod.Id,SalesChannel.Id,Source.Id,StripPhoneFormatting,TransactAsHousehold,TransactAsHouseholdCreditee,UpdatedBy,UpdatedDateTime,Worker.Id
123,123,123,123,123,123,"""2000-01-01T00:00:00.000Z""",123,"""string""",true,"""string""","""2000-01-01T00:00:00.000Z""",123,123,123,"""string""",123,123,"""string""",123,"""string""","""string""",123,123,123,true,123,123,123,true,true,true,"""string""","""2000-01-01T00:00:00.000Z""",123

Contributions
put

This resource is currently strictly for interceptor plugin use. This is called any time a new contribution is saved from the contribution editor in the client application. Only Id (ref_no) is provided in the request content.

Usage:
tq post Contributions
Query:
{"AccountId":123, "AppealId":123, "BatchId":123, "BillingAccount":"string", "BillingTypeId":123, "BusinessUnitId":123, "Campaign":{"Id":123}, "Cancel":"string", "Channel":{"Id":123}, "Constituent":{"Id":123}, "ContributionAmount":123.456, "ContributionDateTime":"2000-01-01T00:00:00.000Z", "ContributionDesignation":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Custom0":"string", "Custom1":"string", "Custom2":"string", "Custom3":"string", "Custom4":"string", "Custom5":"string", "Custom6":"string", "Custom7":"string", "Custom8":"string", "Custom9":"string", "EditIndicator":true, "Fund":{"Id":123}, "Id":123, "Initiator":{"Id":123}, "KindGiftDescription":"string", "KindGiftTransferDateTime":"2000-01-01T00:00:00.000Z", "MatchIndicator":"string", "MatchingContributionId":123, "MediaType":{"Id":123}, "MirrorLock":123, "Notes":"string", "PaymentEndDateTime":"2000-01-01T00:00:00.000Z", "PaymentStartDateTime":"2000-01-01T00:00:00.000Z", "Plan":{"Id":123}, "PledgeStatusId":123, "ReceivedAmount":123.456, "Solicitor":"string", "SourceId":123, "Type":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AccountId":123,"AppealId":123,"BatchId":123,"BillingAccount":"string","BillingTypeId":123,"BusinessUnitId":123,"Campaign.Id":123,"Cancel":"string","Channel.Id":123,"Constituent.Id":123,"ContributionAmount":123.456,"ContributionDateTime":"2000-01-01T00:00:00.000Z","ContributionDesignation":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Custom0":"string","Custom1":"string","Custom2":"string","Custom3":"string","Custom4":"string","Custom5":"string","Custom6":"string","Custom7":"string","Custom8":"string","Custom9":"string","EditIndicator":true,"Fund.Id":123,"Id":123,"Initiator.Id":123,"KindGiftDescription":"string","KindGiftTransferDateTime":"2000-01-01T00:00:00.000Z","MatchIndicator":"string","MatchingContributionId":123,"MediaType.Id":123,"MirrorLock":123,"Notes":"string","PaymentEndDateTime":"2000-01-01T00:00:00.000Z","PaymentStartDateTime":"2000-01-01T00:00:00.000Z","Plan.Id":123,"PledgeStatusId":123,"ReceivedAmount":123.456,"Solicitor":"string","SourceId":123,"Type":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AccountId,AppealId,BatchId,BillingAccount,BillingTypeId,BusinessUnitId,Campaign.Id,Cancel,Channel.Id,Constituent.Id,ContributionAmount,ContributionDateTime,ContributionDesignation,CreateLocation,CreatedBy,CreatedDateTime,Custom0,Custom1,Custom2,Custom3,Custom4,Custom5,Custom6,Custom7,Custom8,Custom9,EditIndicator,Fund.Id,Id,Initiator.Id,KindGiftDescription,KindGiftTransferDateTime,MatchIndicator,MatchingContributionId,MediaType.Id,MirrorLock,Notes,PaymentEndDateTime,PaymentStartDateTime,Plan.Id,PledgeStatusId,ReceivedAmount,Solicitor,SourceId,Type,UpdatedBy,UpdatedDateTime
123,123,123,"""string""",123,123,123,"""string""",123,123,123.456,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""",true,123,123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123,123.456,"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ControlGroupUserGroups
get put

Create a new control group/user group mapping.

Usage:
tq post ControlGroupUserGroups
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultIndicator":true, "EditIndicator":true, "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultIndicator":true,"EditIndicator":true,"Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultIndicator,EditIndicator,Id,UpdatedBy,UpdatedDateTime,UserGroupId
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,true,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

ControlGroups
get put

Create a new control group.

Usage:
tq post ControlGroups
Query:
{"CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Permission":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Permission":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreatedBy,CreatedDateTime,Description,Id,Inactive,Permission,UpdatedBy,UpdatedDateTime
"""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

CoreIdentity
get

Usage:
tq post CoreIdentity
Query:
{"Body":"string", "Headers":[{"Name":"string", "Value":"string"}, ...], "Method":"string", "Path":"string", "QueryParameters":[{"Name":"string", "Value":"string"}, ...]}

Countries
get put

Create a new country.

Usage:
tq post Countries
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DecimalSeparator":"string", "Description":"string", "Id":123, "Inactive":true, "IsoAlpha2Code":"string", "IsoAlpha3Code":"string", "PhoneCode":"string", "PhoneEditstring":"string", "PhoneMask":"string", "PhoneValidLengths":"string", "ReqCity":true, "ReqPcode":true, "ShortDesc":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseAvs":"string", "UseStateField":"string", "ZipEditstring":"string", "ZipMask":"string", "ZipValidLengths":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DecimalSeparator":"string","Description":"string","Id":123,"Inactive":true,"IsoAlpha2Code":"string","IsoAlpha3Code":"string","PhoneCode":"string","PhoneEditstring":"string","PhoneMask":"string","PhoneValidLengths":"string","ReqCity":true,"ReqPcode":true,"ShortDesc":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseAvs":"string","UseStateField":"string","ZipEditstring":"string","ZipMask":"string","ZipValidLengths":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,DecimalSeparator,Description,Id,Inactive,IsoAlpha2Code,IsoAlpha3Code,PhoneCode,PhoneEditstring,PhoneMask,PhoneValidLengths,ReqCity,ReqPcode,ShortDesc,UpdatedBy,UpdatedDateTime,UseAvs,UseStateField,ZipEditstring,ZipMask,ZipValidLengths
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,true,"""string""","""string""","""string""","""string""","""string""","""string""",true,true,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""","""string"""

CrediteeTypes
get put

Create a new crediteeType.

Usage:
tq post CrediteeTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CreditMembershipIndicator":true, "Description":"string", "GiftAidIndicator":true, "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","CreditMembershipIndicator":true,"Description":"string","GiftAidIndicator":true,"Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,CreditMembershipIndicator,Description,GiftAidIndicator,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,"""string""",true,123,true,"""string""","""2000-01-01T00:00:00.000Z"""

CurrencyTypes
get put

Create a new currency type.

Usage:
tq post CurrencyTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Rate":123.456, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Rate":123.456,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Rate,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123.456,"""string""","""2000-01-01T00:00:00.000Z"""

Custom
get

Executes a local procedure defined in TR_LOCAL_PROCEDURE. This will only return a collection of the first result set in a registered procedure. For the result set, null values in each data row are not returned as properties.

Usage:
tq post Custom
Query:
{"ParameterValues":[{"Name":"string", "Value":"string"}, ...], "Parameters":"string", "ProcedureId":123, "ProcedureName":"string"}

Flags:

  • --ExecuteLocalProcedureWithMultipleResultSets
    Executes a local procedure defined in TR_LOCAL_PROCEDURE. This resource supports multiple result sets in a registered procedure. The response object is different from Custom/Execute. For each result set, null values are not returned as properties.
Query:
{"ParameterValues":[{"Name":"string", "Value":"string"}, ...], "Parameters":"string", "ProcedureId":123, "ProcedureName":"string"}

CustomDefaultCategories
get put

Create a new custom default category.

Usage:
tq post CustomDefaultCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

CustomDefaults
get put

Create a new custom default.

Usage:
tq post CustomDefaults
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CustomDefaultCategory":{"Id":123}, "DefaultValue":"string", "Description":"string", "FieldName":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","CustomDefaultCategory.Id":123,"DefaultValue":"string","Description":"string","FieldName":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,CustomDefaultCategory.Id,DefaultValue,Description,FieldName,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

D

DeliveryMethods
get put

Create a new delivery method.

Usage:
tq post DeliveryMethods
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "PrintAtHome":true, "RequireAddress":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"PrintAtHome":true,"RequireAddress":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,PrintAtHome,RequireAddress,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,true,"""string""","""2000-01-01T00:00:00.000Z"""

DesignationCodes
get put

Create a new designation code.

Usage:
tq post DesignationCodes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Diagnostics
get put

Check connection information.

Usage:
tq post Diagnostics
Query:
{"ServerName":"string"}

[{"ServerName":"string"}]

ServerName
"""string"""

DirectDebitAccountTypes
get put

Create a new direct debit account type.

Usage:
tq post DirectDebitAccountTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

DiscountTypes
get put

Create a new discount type.

Usage:
tq post DiscountTypes
Query:
{"Amount":123.456, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "PercentIndicator":true, "RespectMinimumPrice":true, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Amount":123.456,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"PercentIndicator":true,"RespectMinimumPrice":true,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Amount,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,PercentIndicator,RespectMinimumPrice,ShortDescription,UpdatedBy,UpdatedDateTime
123.456,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

DocumentCategories
get put

Create a new documentCategory.

Usage:
tq post DocumentCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "ParentTableName":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"ParentTableName":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,ParentTableName,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

DonationLevels
get put

Create a new donation level.

Usage:
tq post DonationLevels
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "ProgramType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"ProgramType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,ProgramType.Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

E

EMV
get put

Authorize a payment via a Payment Express HIT, TriPOSCloud, or Adyen device.

Usage:
tq post EMV
Query:
{"Amount":123.456, "BillingAddress":{"AddressId":123, "Country":"string", "PostalCode":"string", "Street1":"string"}, "ConstituentId":123, "IsMoto":true, "MachineId":123, "PaymentId":123, "StoreAccount":true, "TransactionOrigin":"string", "UserData":"string"}

[{"Amount":123.456,"BillingAddress.AddressId":123,"BillingAddress.Country":"string","BillingAddress.PostalCode":"string","BillingAddress.Street1":"string","ConstituentId":123,"IsMoto":true,"MachineId":123,"PaymentId":123,"StoreAccount":true,"TransactionOrigin":"string","UserData":"string"}]

Amount,BillingAddress.AddressId,BillingAddress.Country,BillingAddress.PostalCode,BillingAddress.Street1,ConstituentId,IsMoto,MachineId,PaymentId,StoreAccount,TransactionOrigin,UserData
123.456,123,"""string""","""string""","""string""",123,true,123,123,true,"""string""","""string"""

Flags:

  • --Lane
    Add a new lane to merchant
Query:
{"Cert":"string", "ActivationCode":"string", "Description":"string", "LaneId":"string", "MarketCode":"string", "TerminalId":"string", "Merchant":"string"}

[{"ActivationCode":"string","Cert":"string","Description":"string","LaneId":"string","MarketCode":"string","Merchant":"string","TerminalId":"string"}]

ActivationCode,Cert,Description,LaneId,MarketCode,Merchant,TerminalId
"""string""","""string""","""string""","""string""","""string""","""string""","""string"""
  • --Signature
    Accepts the signature for a Payment Express HIT authorization.
Query:
{"MachineId":123, "PaymentId":123, "SignatureMatches":true, "StoreAccount":true}

[{"MachineId":123,"PaymentId":123,"SignatureMatches":true,"StoreAccount":true}]

MachineId,PaymentId,SignatureMatches,StoreAccount
123,123,true,true
  • --Token
    Creates a token on the specified constituent via a Payment Express HIT, TriPOSCloud, or Adyen device without authorizing a transaction.
Query:
{"ConstituentId":123, "IsMoto":true, "MachineId":123, "TransactionOrigin":"string"}

[{"ConstituentId":123,"IsMoto":true,"MachineId":123,"TransactionOrigin":"string"}]

ConstituentId,IsMoto,MachineId,TransactionOrigin
123,true,123,"""string"""

ElectronicAddressTypes
get put

Create a new electronic address type.

Usage:
tq post ElectronicAddressTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "IsEmail":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"IsEmail":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,IsEmail,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,"""string""","""2000-01-01T00:00:00.000Z"""

ElectronicAddresses
get put

Create a new electronic address.

Usage:
tq post ElectronicAddresses
Query:
{"Address":"string", "AffiliatedConstituent":{"Id":123}, "AllowHtmlFormat":true, "AllowMarketing":true, "AltSalutationType":{"Id":123}, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "ElectronicAddressType":{"Id":123}, "EndDate":"2000-01-01T00:00:00.000Z", "Id":123, "Inactive":true, "IsEmail":true, "IsFromAffiliation":true, "Months":"string", "PrimaryIndicator":true, "StartDate":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Address":"string","AffiliatedConstituent.Id":123,"AllowHtmlFormat":true,"AllowMarketing":true,"AltSalutationType.Id":123,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"ElectronicAddressType.Id":123,"EndDate":"2000-01-01T00:00:00.000Z","Id":123,"Inactive":true,"IsEmail":true,"IsFromAffiliation":true,"Months":"string","PrimaryIndicator":true,"StartDate":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Address,AffiliatedConstituent.Id,AllowHtmlFormat,AllowMarketing,AltSalutationType.Id,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,ElectronicAddressType.Id,EndDate,Id,Inactive,IsEmail,IsFromAffiliation,Months,PrimaryIndicator,StartDate,UpdatedBy,UpdatedDateTime
"""string""",123,true,true,123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,"""2000-01-01T00:00:00.000Z""",123,true,true,true,"""string""",true,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

Flags:

  • --Move
    Change the ownership of the electronic address to a new constituent.
Query:
{"ConstituentID":"string", "ElectronicAddressID":"string"}

[{"ConstituentID":"string","ElectronicAddressID":"string"}]

ConstituentID,ElectronicAddressID
"""string""","""string"""

EmailProfiles
get put

Create a new email profile

Usage:
tq post EmailProfiles
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EmailBcc":"string", "EmailCc":"string", "EmailDefaultSubject":"string", "EmailFrom":"string", "Id":123, "Inactive":true, "SMTPPassword":"string", "SMTPPort":123, "SMTPServer":"string", "SMTPUserName":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseSsl":true}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EmailBcc":"string","EmailCc":"string","EmailDefaultSubject":"string","EmailFrom":"string","Id":123,"Inactive":true,"SMTPPassword":"string","SMTPPort":123,"SMTPServer":"string","SMTPUserName":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseSsl":true}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EmailBcc,EmailCc,EmailDefaultSubject,EmailFrom,Id,Inactive,SMTPPassword,SMTPPort,SMTPServer,SMTPUserName,UpdatedBy,UpdatedDateTime,UseSsl
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""","""string""",123,true,"""string""",123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",true

EmailResponses

Updates an appeal with customer data in response to an email event. EventName should be one of open, click, hard-bounce, soft-bounce or opt-out.

Usage:
tq post EmailResponses
Query:
{"ConstituentId":123, "DownloadNumber":123, "EventDateTime":"2000-01-01T00:00:00.000Z", "EventName":"string"}

[{"ConstituentId":123,"DownloadNumber":123,"EventDateTime":"2000-01-01T00:00:00.000Z","EventName":"string"}]

ConstituentId,DownloadNumber,EventDateTime,EventName
123,123,"""2000-01-01T00:00:00.000Z""","""string"""

Emails

Sends an email via SMTP

Usage:
tq post Emails
Query:
{"Attachments":[{"Name":"string"}, ...], "DuplicateBodyAsAttachment":true, "DuplicateBodyAttachmentName":"string", "EmailProfileId":123, "EmbeddedImages":[{"MediaType":"string", "Name":"string"}, ...], "FromAddress":"string", "HtmlBody":"string", "PlainTextBody":"string", "RecipientAddress":"string", "Subject":"string"}

Flags:

  • --SendConstituentInfo
    Queues a Constituents Info email
Query:
{"ConstituentID":"string", "EmailAddress":"string", "EmailProfileId":123, "NameValues":[{"Name":"string", "Value":"string"}, ...], "TemplateId":123}
  • --SendLoginCredentials
    Queues a Login Credentials email. This endpoint will not generate a password token and should be used for testing a login credentials template. Use the SendCredentials endpoint in Web/Session to send a login credentials email with a generated password token.
Query:
{"LoginID":"string", "EmailAddress":"string", "EmailProfileId":123, "NameValues":[{"Name":"string", "Value":"string"}, ...], "TemplateId":123}
  • --SendOrderConfirmation
    Queues an Order Confirmation email
Query:
{"OrderID":"string", "EmailAddress":"string", "EmailProfileId":123, "NameValues":[{"Name":"string", "Value":"string"}, ...], "TemplateId":123}
  • --SendTickets
    Queues a ticket email
Query:
{"OrderID":"string", "EmailAddress":"string", "EmailProfileId":123, "PrintOrderTicketsRequest":{"BatchId":123, "HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "NewTicketNoForReprints":true, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123}, "TemplateId":123}

[{"EmailAddress":"string","EmailProfileId":123,"OrderID":"string","PrintOrderTicketsRequest.BatchId":123,"PrintOrderTicketsRequest.HeaderDesignId":123,"PrintOrderTicketsRequest.IncludeReceipts":true,"PrintOrderTicketsRequest.LineItems":"string","PrintOrderTicketsRequest.NewTicketNoForReprints":true,"PrintOrderTicketsRequest.PrinterType":"string","PrintOrderTicketsRequest.ReprintTickets":true,"PrintOrderTicketsRequest.SubLineItems":"string","PrintOrderTicketsRequest.TicketDesignId":123,"TemplateId":123}]

EmailAddress,EmailProfileId,OrderID,PrintOrderTicketsRequest.BatchId,PrintOrderTicketsRequest.HeaderDesignId,PrintOrderTicketsRequest.IncludeReceipts,PrintOrderTicketsRequest.LineItems,PrintOrderTicketsRequest.NewTicketNoForReprints,PrintOrderTicketsRequest.PrinterType,PrintOrderTicketsRequest.ReprintTickets,PrintOrderTicketsRequest.SubLineItems,PrintOrderTicketsRequest.TicketDesignId,TemplateId
"""string""",123,"""string""",123,123,true,"""string""",true,"""string""",true,"""string""",123,123

EmarketIndicators
get put

Create a new emarket indicator.

Usage:
tq post EmarketIndicators
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Eras
get put

Create a new era.

Usage:
tq post Eras
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

F

Facilities
get put

Create a new Facility.

Usage:
tq post Facilities
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultBestSeatMapId":123, "DefaultZoneMapId":123, "Description":"string", "Id":123, "SeatMap":{"Id":123}, "Theater":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultBestSeatMapId":123,"DefaultZoneMapId":123,"Description":"string","Id":123,"SeatMap.Id":123,"Theater.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultBestSeatMapId,DefaultZoneMapId,Description,Id,SeatMap.Id,Theater.Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

G

Genders
get put

Create a new gender.

Usage:
tq post Genders
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultPrefix":{"Id":123}, "Description":"string", "Id":123, "Inactive":true, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultPrefix.Id":123,"Description":"string","Id":123,"Inactive":true,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,DefaultPrefix.Id,Description,Id,Inactive,ShortDescription,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

GiftAidContactMethods
get put

Create a new gift aid contact method.

Usage:
tq post GiftAidContactMethods
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

GiftAidDeclarations
get put

Creates a Gift Aid Declaration.

Usage:
tq post GiftAidDeclarations
Query:
{"ConfirmDateTime":"2000-01-01T00:00:00.000Z", "Constituent":{"Id":123}, "ContactMethod":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DocumentStatus":{"Id":123}, "EligibleIndicator":true, "EndDateTime":"2000-01-01T00:00:00.000Z", "GiftAidType":{"Id":123}, "Id":123, "IneligibleReason":{"Id":123}, "Notes":"string", "ReceivedDateTime":"2000-01-01T00:00:00.000Z", "StartDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ConfirmDateTime":"2000-01-01T00:00:00.000Z","Constituent.Id":123,"ContactMethod.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DocumentStatus.Id":123,"EligibleIndicator":true,"EndDateTime":"2000-01-01T00:00:00.000Z","GiftAidType.Id":123,"Id":123,"IneligibleReason.Id":123,"Notes":"string","ReceivedDateTime":"2000-01-01T00:00:00.000Z","StartDateTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ConfirmDateTime,Constituent.Id,ContactMethod.Id,CreateLocation,CreatedBy,CreatedDateTime,DocumentStatus.Id,EligibleIndicator,EndDateTime,GiftAidType.Id,Id,IneligibleReason.Id,Notes,ReceivedDateTime,StartDateTime,UpdatedBy,UpdatedDateTime
"""2000-01-01T00:00:00.000Z""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,true,"""2000-01-01T00:00:00.000Z""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

GiftAidDocumentStatuses
get put

Create a new gift aid document status.

Usage:
tq post GiftAidDocumentStatuses
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

GiftAidIneligibleReasons
get put

Create a new gift aid ineligible reason.

Usage:
tq post GiftAidIneligibleReasons
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

GiftAidRates
get put

Create a new gift aid rate.

Usage:
tq post GiftAidRates
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Rate":123.456, "StartDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EndDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Rate":123.456,"StartDateTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,EndDateTime,Id,Rate,StartDateTime,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123.456,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

GiftAidStatuses
get put

Create a new gift aid status.

Usage:
tq post GiftAidStatuses
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

GiftAidTypes
get put

Create a new gift aid type.

Usage:
tq post GiftAidTypes
Query:
{"CharityClaimsRef":"string", "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CharityClaimsRef":"string","ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CharityClaimsRef,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

GiftCertificates
get

Get transaction details for a gift certificate and lock it for redemption in a specific batch.

Usage:
tq post GiftCertificates
Query:
{"BatchId":123, "LockForBatch":true, "Number":"string", "PaymentMethodId":123}

[{"BatchId":123,"LockForBatch":true,"Number":"string","PaymentMethodId":123}]

BatchId,LockForBatch,Number,PaymentMethodId
123,true,"""string""",123

Flags:

  • --Unlock
    Removes lock for gift certificate from any batch.
Query:
{"GiftCertificateNumber":"string"}

[{"GiftCertificateNumber":"string"}]

GiftCertificateNumber
"""string"""

H

HoldCodeCategories
get put

Create a new Hold Code Category.

Usage:
tq post HoldCodeCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

HoldCodeUserGroups
get put

Create a new hold code/user group mapping.

Usage:
tq post HoldCodeUserGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "HoldCode":{"Id":123}, "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","HoldCode.Id":123,"Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,HoldCode.Id,Id,UpdatedBy,UpdatedDateTime,UserGroupId
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

HoldCodes
get put

Create a Hold Code.

Usage:
tq post HoldCodes
Query:
{"BlackoutIndicator":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "Id":123, "Legend":"string", "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BlackoutIndicator":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditIndicator":true,"Id":123,"Legend":"string","Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BlackoutIndicator,CreateLocation,CreatedBy,CreatedDateTime,Description,EditIndicator,Id,Legend,Type.Id,UpdatedBy,UpdatedDateTime
true,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

I

InactiveReasons
get put

Create a new inactive reason.

Usage:
tq post InactiveReasons
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

IntegrationDefaults
get put

Create a new Integration Default.

Usage:
tq post IntegrationDefaults
Query:
{"AccessId":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultValue":"string", "Description":"string", "FieldName":"string", "Id":123, "Integration":{"Id":123}, "Organization":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AccessId":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultValue":"string","Description":"string","FieldName":"string","Id":123,"Integration.Id":123,"Organization.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AccessId,CreateLocation,CreatedBy,CreatedDateTime,DefaultValue,Description,FieldName,Id,Integration.Id,Organization.Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

Integrations
get put

Create a new action type.

Usage:
tq post Integrations
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

InterestCategories
get put

Create a new interest category.

Usage:
tq post InterestCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

InterestTypes
get put

Create a new interest type.

Usage:
tq post InterestTypes
Query:
{"Category":{"Id":123}, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "SearchIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UsedIn":"string"}

[{"Category.Id":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"SearchIndicator":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UsedIn":"string"}]

Category.Id,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,SearchIndicator,UpdatedBy,UpdatedDateTime,UsedIn
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

Interests
get put

Create a new interest associating an interest type to a constituent. For bulk interest edits, consider the CRM/Interests/CreateOrUpdate batching resource which allows multiple interests to be created, updated, or removed in a single request.

Usage:
tq post Interests
Query:
{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "InterestType":{"Id":123}, "Selected":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Weight":123}

[{"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"InterestType.Id":123,"Selected":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Weight":123}]

Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,InterestType.Id,Selected,UpdatedBy,UpdatedDateTime,Weight
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,true,"""string""","""2000-01-01T00:00:00.000Z""",123

Flags:

  • --Or
    Creates, updates, or deletes interests passed as a collection. We recommend that this resource be used for making multiple edits to Constituent Interests in a single API request. Interests that exist will be updated with provided Weight and Selected values. If an existing interest is provided with a Weight of 0 or NULL and a Selected: false, the interest will be deleted. New Interests should be created with an Id of -999 (or NULL).
Query:
{"Interests":[{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "InterestType":{"Id":123}, "Selected":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Weight":123}, ...]}

Internal
get put

Create a new address along with the phones and attach all the phones to the address. By default first phone is of phone type 1, second phone is of phone type 2 and third phone is of phone type 3.

Usage:
tq post Internal
Query:
{"AddressType":{"Id":123}, "AffiliatedConstituent":{"Id":123}, "AllowTelemarketing1":true, "AllowTelemarketing2":true, "AllowTelemarketing3":true, "AltSalutationType":{"Id":123}, "City":"string", "Constituent":{"Id":123}, "Country":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DayEveningIndicator1":"string", "DayEveningIndicator2":"string", "DayEveningIndicator3":"string", "DeliveryPoint":"string", "EditIndicator":true, "EditIndicator1":true, "EditIndicator2":true, "EditIndicator3":true, "EndDate":"2000-01-01T00:00:00.000Z", "GeoArea":123, "Id":123, "Inactive":true, "Label":true, "Months":"string", "NcoaAction":123, "NcoaSession":123, "PhoneId1":123, "PhoneId2":123, "PhoneId3":123, "PhoneNumber1":"string", "PhoneNumber1Formatted":"string", "PhoneNumber2":"string", "PhoneNumber2Formatted":"string", "PhoneNumber3":"string", "PhoneNumber3Formatted":"string", "PhoneSearch1":"string", "PhoneSearch2":"string", "PhoneSearch3":"string", "PostalCode":"string", "PostalCodeFormatted":"string", "PrimaryIndicator":true, "StartDate":"2000-01-01T00:00:00.000Z", "State":{"Id":123}, "Street1":"string", "Street2":"string", "Street3":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UpdatedDateTime1":"2000-01-01T00:00:00.000Z", "UpdatedDateTime2":"2000-01-01T00:00:00.000Z", "UpdatedDateTime3":"2000-01-01T00:00:00.000Z"}

[{"AddressType.Id":123,"AffiliatedConstituent.Id":123,"AllowTelemarketing1":true,"AllowTelemarketing2":true,"AllowTelemarketing3":true,"AltSalutationType.Id":123,"City":"string","Constituent.Id":123,"Country.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DayEveningIndicator1":"string","DayEveningIndicator2":"string","DayEveningIndicator3":"string","DeliveryPoint":"string","EditIndicator":true,"EditIndicator1":true,"EditIndicator2":true,"EditIndicator3":true,"EndDate":"2000-01-01T00:00:00.000Z","GeoArea":123,"Id":123,"Inactive":true,"Label":true,"Months":"string","NcoaAction":123,"NcoaSession":123,"PhoneId1":123,"PhoneId2":123,"PhoneId3":123,"PhoneNumber1":"string","PhoneNumber1Formatted":"string","PhoneNumber2":"string","PhoneNumber2Formatted":"string","PhoneNumber3":"string","PhoneNumber3Formatted":"string","PhoneSearch1":"string","PhoneSearch2":"string","PhoneSearch3":"string","PostalCode":"string","PostalCodeFormatted":"string","PrimaryIndicator":true,"StartDate":"2000-01-01T00:00:00.000Z","State.Id":123,"Street1":"string","Street2":"string","Street3":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UpdatedDateTime1":"2000-01-01T00:00:00.000Z","UpdatedDateTime2":"2000-01-01T00:00:00.000Z","UpdatedDateTime3":"2000-01-01T00:00:00.000Z"}]

AddressType.Id,AffiliatedConstituent.Id,AllowTelemarketing1,AllowTelemarketing2,AllowTelemarketing3,AltSalutationType.Id,City,Constituent.Id,Country.Id,CreateLocation,CreatedBy,CreatedDateTime,DayEveningIndicator1,DayEveningIndicator2,DayEveningIndicator3,DeliveryPoint,EditIndicator,EditIndicator1,EditIndicator2,EditIndicator3,EndDate,GeoArea,Id,Inactive,Label,Months,NcoaAction,NcoaSession,PhoneId1,PhoneId2,PhoneId3,PhoneNumber1,PhoneNumber1Formatted,PhoneNumber2,PhoneNumber2Formatted,PhoneNumber3,PhoneNumber3Formatted,PhoneSearch1,PhoneSearch2,PhoneSearch3,PostalCode,PostalCodeFormatted,PrimaryIndicator,StartDate,State.Id,Street1,Street2,Street3,UpdatedBy,UpdatedDateTime,UpdatedDateTime1,UpdatedDateTime2,UpdatedDateTime3
123,123,true,true,true,123,"""string""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""",true,true,true,true,"""2000-01-01T00:00:00.000Z""",123,123,true,true,"""string""",123,123,123,123,123,"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""",true,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z"""

InventoryContactPermissionTypes
get put

Create an inventoryContactPermissionType.

Usage:
tq post InventoryContactPermissionTypes
Query:
{"ContactPermissionType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ProductionElementId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ContactPermissionType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ProductionElementId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ContactPermissionType.Id,CreateLocation,CreatedBy,CreatedDateTime,Id,ProductionElementId,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z"""

InventoryWebContents
get put

Create an inventoryWebContent.

Usage:
tq post InventoryWebContents
Query:
{"ContentType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ProductionElementId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Value":"string"}

[{"ContentType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ProductionElementId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Value":"string"}]

ContentType.Id,CreateLocation,CreatedBy,CreatedDateTime,Id,ProductionElementId,UpdatedBy,UpdatedDateTime,Value
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

InvoiceBilling
get

Invoice billing

Usage:
tq post InvoiceBilling
Query:
{"AppealId":123, "BatchTypeId":123, "BillingTypeId":123, "BusinessUnitId":123, "CutoffDateTime":"2000-01-01T00:00:00.000Z", "ElectronicAddressPurposeId":123, "ElectronicAddressTypeId":123, "EndDateTime":"2000-01-01T00:00:00.000Z", "InvoiceEndDateTime":"2000-01-01T00:00:00.000Z", "InvoiceStartDateTime":"2000-01-01T00:00:00.000Z", "IsLabel":true, "ListId":123, "MailDateTime":"2000-01-01T00:00:00.000Z", "MailTypeId":123, "MaxNumberOfBillsToPrint":123, "MediaTypeId":123, "MinAmount":123.456, "MinNumberOfBillsToPrint":123, "NewSourceDescription":"string", "PaymentMethodGroupId":123, "PaymentMethodId":123, "RespectElectronicAddressMarketingFlag":true, "SalutationTypeId":123, "ShouldCollectAll":true, "ShouldUpdate":true, "StartDateTime":"2000-01-01T00:00:00.000Z", "UserId":"string"}

[{"AppealId":123,"BatchTypeId":123,"BillingTypeId":123,"BusinessUnitId":123,"CutoffDateTime":"2000-01-01T00:00:00.000Z","ElectronicAddressPurposeId":123,"ElectronicAddressTypeId":123,"EndDateTime":"2000-01-01T00:00:00.000Z","InvoiceEndDateTime":"2000-01-01T00:00:00.000Z","InvoiceStartDateTime":"2000-01-01T00:00:00.000Z","IsLabel":true,"ListId":123,"MailDateTime":"2000-01-01T00:00:00.000Z","MailTypeId":123,"MaxNumberOfBillsToPrint":123,"MediaTypeId":123,"MinAmount":123.456,"MinNumberOfBillsToPrint":123,"NewSourceDescription":"string","PaymentMethodGroupId":123,"PaymentMethodId":123,"RespectElectronicAddressMarketingFlag":true,"SalutationTypeId":123,"ShouldCollectAll":true,"ShouldUpdate":true,"StartDateTime":"2000-01-01T00:00:00.000Z","UserId":"string"}]

AppealId,BatchTypeId,BillingTypeId,BusinessUnitId,CutoffDateTime,ElectronicAddressPurposeId,ElectronicAddressTypeId,EndDateTime,InvoiceEndDateTime,InvoiceStartDateTime,IsLabel,ListId,MailDateTime,MailTypeId,MaxNumberOfBillsToPrint,MediaTypeId,MinAmount,MinNumberOfBillsToPrint,NewSourceDescription,PaymentMethodGroupId,PaymentMethodId,RespectElectronicAddressMarketingFlag,SalutationTypeId,ShouldCollectAll,ShouldUpdate,StartDateTime,UserId
123,123,123,123,"""2000-01-01T00:00:00.000Z""",123,123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",true,123,"""2000-01-01T00:00:00.000Z""",123,123,123,123.456,123,"""string""",123,123,true,123,true,true,"""2000-01-01T00:00:00.000Z""","""string"""

Issues
get put

Create an issue for a Constituent

Usage:
tq post Issues
Query:
{"ActivityType":{"Id":123}, "Constituent":{"Id":123}, "ContactType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "HasReminder":true, "Id":123, "IssueDate":"2000-01-01T00:00:00.000Z", "Notes":"string", "Origin":{"Id":123}, "PackageId":123, "PerformanceId":123, "ResolvedIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UrgentIndicator":true}

[{"ActivityType.Id":123,"Constituent.Id":123,"ContactType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"HasReminder":true,"Id":123,"IssueDate":"2000-01-01T00:00:00.000Z","Notes":"string","Origin.Id":123,"PackageId":123,"PerformanceId":123,"ResolvedIndicator":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UrgentIndicator":true}]

ActivityType.Id,Constituent.Id,ContactType.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,HasReminder,Id,IssueDate,Notes,Origin.Id,PackageId,PerformanceId,ResolvedIndicator,UpdatedBy,UpdatedDateTime,UrgentIndicator
123,123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,true,123,"""2000-01-01T00:00:00.000Z""","""string""",123,123,123,true,"""string""","""2000-01-01T00:00:00.000Z""",true

K

KeywordCategories
get put

Create a new keyword category.

Usage:
tq post KeywordCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Keywords
get put

Create a new keyword.

Usage:
tq post Keywords
Query:
{"Category":{"Id":123}, "ConstituentType":123, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CustomDefaultValue":"string", "CustomId":123, "CustomLimit":123, "CustomRequired":true, "DataType":"string", "Description":"string", "DetailColumn":"string", "DetailTable":"string", "EditIndicator":true, "EditMask":"string", "ExtendedDescription":"string", "FrequentUpdateDate":"2000-01-01T00:00:00.000Z", "HelpText":"string", "Id":123, "KeyColumn":"string", "KeywordUse":"string", "MultipleValue":true, "ParentKeyColumn":"string", "ParentTable":"string", "PrimaryGroupDefault":"string", "ReferenceDescriptionColumn":"string", "ReferenceIdColumn":"string", "ReferenceSort":"string", "ReferenceTable":"string", "ReferenceWhere":"string", "SortOrder":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseForSearch":true, "ValuesCodedIndicator":true}

[{"Category.Id":123,"ConstituentType":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","CustomDefaultValue":"string","CustomId":123,"CustomLimit":123,"CustomRequired":true,"DataType":"string","Description":"string","DetailColumn":"string","DetailTable":"string","EditIndicator":true,"EditMask":"string","ExtendedDescription":"string","FrequentUpdateDate":"2000-01-01T00:00:00.000Z","HelpText":"string","Id":123,"KeyColumn":"string","KeywordUse":"string","MultipleValue":true,"ParentKeyColumn":"string","ParentTable":"string","PrimaryGroupDefault":"string","ReferenceDescriptionColumn":"string","ReferenceIdColumn":"string","ReferenceSort":"string","ReferenceTable":"string","ReferenceWhere":"string","SortOrder":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseForSearch":true,"ValuesCodedIndicator":true}]

Category.Id,ConstituentType,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,CustomDefaultValue,CustomId,CustomLimit,CustomRequired,DataType,Description,DetailColumn,DetailTable,EditIndicator,EditMask,ExtendedDescription,FrequentUpdateDate,HelpText,Id,KeyColumn,KeywordUse,MultipleValue,ParentKeyColumn,ParentTable,PrimaryGroupDefault,ReferenceDescriptionColumn,ReferenceIdColumn,ReferenceSort,ReferenceTable,ReferenceWhere,SortOrder,UpdatedBy,UpdatedDateTime,UseForSearch,ValuesCodedIndicator
123,123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,123,true,"""string""","""string""","""string""","""string""",true,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""string""",true,"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z""",true,true

L

Languages
get put

Create a new language.

Usage:
tq post Languages
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ListCategories
get put

Create a new list category.

Usage:
tq post ListCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Lists
get put

Create a List.

Usage:
tq post Lists
Query:
{"AffiliatedIndividuals":123, "AnalyticsIndicator":true, "Category":{"Id":123}, "ConstituentCount":123, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Criteria":[{"Id":123}, ...], "Description":"string", "EditIndicator":true, "EditMode":"string", "Generate":true, "Households":123, "Id":123, "Inactive":true, "Individuals":123, "IsDynamic":true, "LastUsedDateTime":"2000-01-01T00:00:00.000Z", "ListSql":"string", "Organizations":123, "OutputSet":{"Id":123}, "RelationshipOptions":{"AffiliatedGroupInactive":true, "AffiliatedGroupTypes":"string", "AffiliatedGroupUseDates":true, "AffiliatedIndividualInactive":true, "AffiliatedIndividualTypes":"string", "AffiliatedIndividualUseDates":true, "AssociatedInactive":true, "AssociatedTypes":"string", "AssociatedUseDates":true, "CreateLocation":"string", "CreatedBy":"string", "KeepOrReplaceOriginal":"string", "ReplaceIndividuals":"string", "UpdatedBy":"string"}, "TMSIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Flags:

  • --Generate
    Generate a List.
Query:
{"ListID":"string"}

[{"ListID":"string"}]

ListID
"""string"""
  • --Results
    Get results for List and OutputSet combination. If no outputSetId is passed in the request, a default output set must be set for the list. Response returns custom HTTP headers: X-Page, X-Page-Size, and X-Total-Count. Default page is 1 and default page size is 100.
Query:
{"ListID":"string", "AddressPurposeId":123, "DisableListGenerate":true, "EMarketingIndicator":true, "ElectronicAddressPurposeId":123, "ElectronicAddressTypeId":123, "FormatDate":true, "MailingDateTime":"2000-01-01T00:00:00.000Z", "MembershipOrganizationId":123, "OutputSetId":123, "Page":123, "PageSize":123, "SalutationTypeId":123, "SearchText":"string", "SortBy":"string", "UseLabelAddress":true}

[{"AddressPurposeId":123,"DisableListGenerate":true,"EMarketingIndicator":true,"ElectronicAddressPurposeId":123,"ElectronicAddressTypeId":123,"FormatDate":true,"ListID":"string","MailingDateTime":"2000-01-01T00:00:00.000Z","MembershipOrganizationId":123,"OutputSetId":123,"Page":123,"PageSize":123,"SalutationTypeId":123,"SearchText":"string","SortBy":"string","UseLabelAddress":true}]

AddressPurposeId,DisableListGenerate,EMarketingIndicator,ElectronicAddressPurposeId,ElectronicAddressTypeId,FormatDate,ListID,MailingDateTime,MembershipOrganizationId,OutputSetId,Page,PageSize,SalutationTypeId,SearchText,SortBy,UseLabelAddress
123,true,true,123,123,true,"""string""","""2000-01-01T00:00:00.000Z""",123,123,123,123,123,"""string""","""string""",true
  • --Search
    Search for List. Response returns custom HTTP headers: X-Page, X-Page-Size, and X-Total-Count. Default page is 1 and default page size is 50.
Query:
{"CategoryId":123, "MyListsOnly":true, "Page":123, "PageSize":123, "SearchText":"string", "ShowEmpty":true}

[{"CategoryId":123,"MyListsOnly":true,"Page":123,"PageSize":123,"SearchText":"string","ShowEmpty":true}]

CategoryId,MyListsOnly,Page,PageSize,SearchText,ShowEmpty
123,true,123,123,"""string""",true

LoginTypes
get put

Create a new login type.

Usage:
tq post LoginTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

M

MachineSettings
get put

Create a new Machine Setting.

Usage:
tq post MachineSettings
Query:
{"CardReaderHost":"string", "CardReaderPort":123, "CardReaderType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Inactive":true, "MerchantId":"string", "PXStation":"string", "PXUserKey":"string", "PXUserName":"string", "TessituraPaymentsPosDevice":"string", "TessituraPaymentsPosDeviceModel":"string", "TnspaySoftwareTerminal":true, "TriPOSCloudConfiguration":{"Id":123}, "TriposLane":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "WorkstationName":"string"}

[{"CardReaderHost":"string","CardReaderPort":123,"CardReaderType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Inactive":true,"MerchantId":"string","PXStation":"string","PXUserKey":"string","PXUserName":"string","TessituraPaymentsPosDevice":"string","TessituraPaymentsPosDeviceModel":"string","TnspaySoftwareTerminal":true,"TriPOSCloudConfiguration.Id":123,"TriposLane":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","WorkstationName":"string"}]

CardReaderHost,CardReaderPort,CardReaderType.Id,CreateLocation,CreatedBy,CreatedDateTime,Id,Inactive,MerchantId,PXStation,PXUserKey,PXUserName,TessituraPaymentsPosDevice,TessituraPaymentsPosDeviceModel,TnspaySoftwareTerminal,TriPOSCloudConfiguration.Id,TriposLane,UpdatedBy,UpdatedDateTime,WorkstationName
"""string""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,true,"""string""","""string""","""string""","""string""","""string""","""string""",true,123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

MailIndicators
get put

Create a new mail indicator.

Usage:
tq post MailIndicators
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

MediaTypes
get put

Create a new media type.

Usage:
tq post MediaTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "GenerateCost":123.456, "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","GenerateCost":123.456,"Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,GenerateCost,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123.456,123,true,"""string""","""2000-01-01T00:00:00.000Z"""

MembershipLevelCategories
get put

Create a new membership level category.

Usage:
tq post MembershipLevelCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Memberships
get

This returns a result of calculated changes to a constituent membership. This resource makes no actual changes and only returns calculated membership data for information purposes. NOTE: As part of the upcoming changes to membership functionality, this resource will change significantly in an upcoming major Tessitura release and likely break code that references it. Please make a note that code that references it will need to be revisited as part of that upgrade process.

Usage:
tq post Memberships
Query:
{"CalcCampaignId":123, "CalcConstituentId":123, "CalcContributionAmount":123.456, "CalcContributionDate":"2000-01-01T00:00:00.000Z", "CalcExpirationDate":"2000-01-01T00:00:00.000Z", "CalcInitialDate":"2000-01-01T00:00:00.000Z", "CrediteeId":123, "DeclineBenefits":"string", "MembershipLevelOverride":"string", "MembershipOrganizationId":123, "RealOrMirror":"string", "RenewUpgradeIndicator":"string"}

[{"CalcCampaignId":123,"CalcConstituentId":123,"CalcContributionAmount":123.456,"CalcContributionDate":"2000-01-01T00:00:00.000Z","CalcExpirationDate":"2000-01-01T00:00:00.000Z","CalcInitialDate":"2000-01-01T00:00:00.000Z","CrediteeId":123,"DeclineBenefits":"string","MembershipLevelOverride":"string","MembershipOrganizationId":123,"RealOrMirror":"string","RenewUpgradeIndicator":"string"}]

CalcCampaignId,CalcConstituentId,CalcContributionAmount,CalcContributionDate,CalcExpirationDate,CalcInitialDate,CrediteeId,DeclineBenefits,MembershipLevelOverride,MembershipOrganizationId,RealOrMirror,RenewUpgradeIndicator
123,123,123.456,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,"""string""","""string""",123,"""string""","""string"""

ModeOfSaleCategories
get put

Create a new mode of sale category.

Usage:
tq post ModeOfSaleCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Sequence":123, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Sequence":123,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Sequence,ShortDescription,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ModeOfSaleOffers
get put

Create a new mode of sale offer.

Usage:
tq post ModeOfSaleOffers
Query:
{"AppealId":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "MaxSeats":123, "ModeOfSaleId":123, "OverrideDefaultPriceTypeIndicator":true, "PackageId":123, "PerformanceId":123, "PriceTypeId":123, "Rank":123, "SourceId":123, "StartDateTime":"2000-01-01T00:00:00.000Z", "Terms":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AppealId":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EndDateTime":"2000-01-01T00:00:00.000Z","Id":123,"MaxSeats":123,"ModeOfSaleId":123,"OverrideDefaultPriceTypeIndicator":true,"PackageId":123,"PerformanceId":123,"PriceTypeId":123,"Rank":123,"SourceId":123,"StartDateTime":"2000-01-01T00:00:00.000Z","Terms":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AppealId,CreateLocation,CreatedBy,CreatedDateTime,EndDateTime,Id,MaxSeats,ModeOfSaleId,OverrideDefaultPriceTypeIndicator,PackageId,PerformanceId,PriceTypeId,Rank,SourceId,StartDateTime,Terms,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123,123,true,123,123,123,123,123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

ModeOfSalePriceTypes
get put

Create a new mode of sale price type.

Usage:
tq post ModeOfSalePriceTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultIndicator":true, "Id":123, "ModeOfSale":{"Id":123}, "PriceType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultIndicator":true,"Id":123,"ModeOfSale.Id":123,"PriceType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,DefaultIndicator,Id,ModeOfSale.Id,PriceType.Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ModeOfSaleSurveyQuestions
get put

Create a new mode of sale survey question.

Usage:
tq post ModeOfSaleSurveyQuestions
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ModeOfSale":{"Id":123}, "Question":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ModeOfSale.Id":123,"Question.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Id,ModeOfSale.Id,Question.Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ModeOfSaleUserGroups
get put

Create a new mode of sale/user group mapping.

Usage:
tq post ModeOfSaleUserGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultIndicator":true, "Id":123, "ModeOfSale":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultIndicator":true,"Id":123,"ModeOfSale.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,DefaultIndicator,Id,ModeOfSale.Id,UpdatedBy,UpdatedDateTime,UserGroupId
"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

ModesOfSale
get put

Create a new mode of sale.

Usage:
tq post ModesOfSale
Query:
{"AllowUnseatedPaidInd":true, "Category":{"Id":123}, "CategoryRequired":true, "ClearSourceNoInd":true, "ClearSourceOnReload":true, "ConfirmationMode":true, "ConstLinkRequired":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultAckFormatId":123, "DefaultChannelId":123, "DefaultDeliveryMethodId":123, "DefaultHeaderFormatId":123, "DefaultSalesLayoutId":123, "Description":"string", "EditDate":true, "EditSourceOnReload":true, "GeneralPublicInd":true, "HaboDays":123, "HaboForeign":true, "HoldUntilDate":"2000-01-01T00:00:00.000Z", "HoldUntilDays":123, "HoldUntilMethod":"string", "Id":123, "Inactive":true, "MustBePaidInd":true, "MustBeSeatedInd":true, "MustBeTicketedInd":true, "PricingRuleSetId":123, "SampleForGeneralPublic":123, "SampleForKnownConstituent":123, "SliAutoDeleteInd":true, "StartPkgOrPerf":"string", "SubsSummaryRequired":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AllowUnseatedPaidInd":true,"Category.Id":123,"CategoryRequired":true,"ClearSourceNoInd":true,"ClearSourceOnReload":true,"ConfirmationMode":true,"ConstLinkRequired":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultAckFormatId":123,"DefaultChannelId":123,"DefaultDeliveryMethodId":123,"DefaultHeaderFormatId":123,"DefaultSalesLayoutId":123,"Description":"string","EditDate":true,"EditSourceOnReload":true,"GeneralPublicInd":true,"HaboDays":123,"HaboForeign":true,"HoldUntilDate":"2000-01-01T00:00:00.000Z","HoldUntilDays":123,"HoldUntilMethod":"string","Id":123,"Inactive":true,"MustBePaidInd":true,"MustBeSeatedInd":true,"MustBeTicketedInd":true,"PricingRuleSetId":123,"SampleForGeneralPublic":123,"SampleForKnownConstituent":123,"SliAutoDeleteInd":true,"StartPkgOrPerf":"string","SubsSummaryRequired":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AllowUnseatedPaidInd,Category.Id,CategoryRequired,ClearSourceNoInd,ClearSourceOnReload,ConfirmationMode,ConstLinkRequired,CreateLocation,CreatedBy,CreatedDateTime,DefaultAckFormatId,DefaultChannelId,DefaultDeliveryMethodId,DefaultHeaderFormatId,DefaultSalesLayoutId,Description,EditDate,EditSourceOnReload,GeneralPublicInd,HaboDays,HaboForeign,HoldUntilDate,HoldUntilDays,HoldUntilMethod,Id,Inactive,MustBePaidInd,MustBeSeatedInd,MustBeTicketedInd,PricingRuleSetId,SampleForGeneralPublic,SampleForKnownConstituent,SliAutoDeleteInd,StartPkgOrPerf,SubsSummaryRequired,UpdatedBy,UpdatedDateTime
true,123,true,true,true,true,true,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,123,123,123,"""string""",true,true,true,123,true,"""2000-01-01T00:00:00.000Z""",123,"""string""",123,true,true,true,true,123,123,123,true,"""string""",true,"""string""","""2000-01-01T00:00:00.000Z"""

N

NScanAccessAreas
get put

Create a new NScan Access Area.

Usage:
tq post NScanAccessAreas
Query:
{"AreaCode":"string", "ConstituencyIds":"string", "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Inactive":true, "KeywordId":123, "KeywordValue":"string", "ListId":123, "MaxEntries":123, "MembershipLevelIds":"string", "PerformanceIds":"string", "PriceTypeIds":"string", "PriceZoneIds":"string", "PromptQuantity":true, "StartDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AreaCode":"string","ConstituencyIds":"string","ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EndDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Inactive":true,"KeywordId":123,"KeywordValue":"string","ListId":123,"MaxEntries":123,"MembershipLevelIds":"string","PerformanceIds":"string","PriceTypeIds":"string","PriceZoneIds":"string","PromptQuantity":true,"StartDateTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AreaCode,ConstituencyIds,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EndDateTime,Id,Inactive,KeywordId,KeywordValue,ListId,MaxEntries,MembershipLevelIds,PerformanceIds,PriceTypeIds,PriceZoneIds,PromptQuantity,StartDateTime,UpdatedBy,UpdatedDateTime
"""string""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z""",123,true,123,"""string""",123,123,"""string""","""string""","""string""","""string""",true,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

NameStatuses
get put

Create a new name status.

Usage:
tq post NameStatuses
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

O

ObjectPermissions
get put

Create a new object permission.

Usage:
tq post ObjectPermissions
Query:
{"ApplicationObject":{"Id":123}, "CanCreate":"string", "CanDelete":"string", "CanEdit":"string", "CanView":"string", "Constituency":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroup":{"Id":"string"}}

[{"ApplicationObject.Id":123,"CanCreate":"string","CanDelete":"string","CanEdit":"string","CanView":"string","Constituency.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroup.Id":"string"}]

ApplicationObject.Id,CanCreate,CanDelete,CanEdit,CanView,Constituency.Id,CreateLocation,CreatedBy,CreatedDateTime,Id,UpdatedBy,UpdatedDateTime,UserGroup.Id
123,"""string""","""string""","""string""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

OrderBilling
get

Order billing

Usage:
tq post OrderBilling
Query:
{"AppealId":123, "BatchTypeId":123, "BillingTypeId":123, "CutoffDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "ListId":123, "MaxNumberOfBillsToPrint":123, "MediaTypeId":123, "MinAmount":123.456, "MinNumberOfBillsToPrint":123, "ModesOfSale":"string", "NewSourceDescription":"string", "OrderEndDateTime":"2000-01-01T00:00:00.000Z", "OrderStartDateTime":"2000-01-01T00:00:00.000Z", "PaymentMethodGroupId":123, "PerformanceEndDateTime":"2000-01-01T00:00:00.000Z", "PerformanceStartDateTime":"2000-01-01T00:00:00.000Z", "Seasons":"string", "ShouldUpdate":true, "StartDateTime":"2000-01-01T00:00:00.000Z", "UserId":"string"}

[{"AppealId":123,"BatchTypeId":123,"BillingTypeId":123,"CutoffDateTime":"2000-01-01T00:00:00.000Z","EndDateTime":"2000-01-01T00:00:00.000Z","ListId":123,"MaxNumberOfBillsToPrint":123,"MediaTypeId":123,"MinAmount":123.456,"MinNumberOfBillsToPrint":123,"ModesOfSale":"string","NewSourceDescription":"string","OrderEndDateTime":"2000-01-01T00:00:00.000Z","OrderStartDateTime":"2000-01-01T00:00:00.000Z","PaymentMethodGroupId":123,"PerformanceEndDateTime":"2000-01-01T00:00:00.000Z","PerformanceStartDateTime":"2000-01-01T00:00:00.000Z","Seasons":"string","ShouldUpdate":true,"StartDateTime":"2000-01-01T00:00:00.000Z","UserId":"string"}]

AppealId,BatchTypeId,BillingTypeId,CutoffDateTime,EndDateTime,ListId,MaxNumberOfBillsToPrint,MediaTypeId,MinAmount,MinNumberOfBillsToPrint,ModesOfSale,NewSourceDescription,OrderEndDateTime,OrderStartDateTime,PaymentMethodGroupId,PerformanceEndDateTime,PerformanceStartDateTime,Seasons,ShouldUpdate,StartDateTime,UserId
123,123,123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123,123,123.456,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""",true,"""2000-01-01T00:00:00.000Z""","""string"""

OrderCategories
get put

Create a new order category.

Usage:
tq post OrderCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Orders
get put

This resource is currently only for interceptor plugin use. This is called any time a new order is saved via the API or from the client application. Only OrderId is provided in the request content.

This resource will be invoked from a cart checkout.

Usage:
tq post Orders
Query:
{"AcceptingRollovers":true, "AccountId":123, "AltAddressId":123, "AltElectronicAddressId":123, "AppealId":123, "AppliedMessageRules":"string", "BatchId":123, "BusinessUnitId":123, "CategoryId":123, "ChannelId":123, "ConstituentId":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Custom0":"string", "Custom1":"string", "Custom2":"string", "Custom3":"string", "Custom4":"string", "Custom5":"string", "Custom6":"string", "Custom7":"string", "Custom8":"string", "Custom9":"string", "DeliveryDate":"2000-01-01T00:00:00.000Z", "DeliveryMethodId":123, "HoldUntilDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "InitiatorId":123, "LineItems":[{"Id":123}, ...], "Messages":[{"Id":123}, ...], "MirrorLock":123, "ModeOfSaleId":123, "Notes":"string", "OrderDateTime":"2000-01-01T00:00:00.000Z", "ReloadPricingRules":true, "Solicitor":"string", "SourceId":123, "TotalDue":123.456, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "VirtualConstituencies":"string"}

Flags:

  • --OrdersForDelivery
    Get all the orders for delivery.
Query:
{"DeliveryMethods":"string", "MaxRowsToReturn":123, "ModesOfSale":"string", "OrderDaysInPast":123, "OrderEndDateTime":"2000-01-01T00:00:00.000Z", "OrderStartDateTime":"2000-01-01T00:00:00.000Z", "OrganizationName":"string", "PerformanceEndDateTime":"2000-01-01T00:00:00.000Z", "PerformanceStartDateTime":"2000-01-01T00:00:00.000Z", "UsePrimaryEmail":true}

[{"DeliveryMethods":"string","MaxRowsToReturn":123,"ModesOfSale":"string","OrderDaysInPast":123,"OrderEndDateTime":"2000-01-01T00:00:00.000Z","OrderStartDateTime":"2000-01-01T00:00:00.000Z","OrganizationName":"string","PerformanceEndDateTime":"2000-01-01T00:00:00.000Z","PerformanceStartDateTime":"2000-01-01T00:00:00.000Z","UsePrimaryEmail":true}]

DeliveryMethods,MaxRowsToReturn,ModesOfSale,OrderDaysInPast,OrderEndDateTime,OrderStartDateTime,OrganizationName,PerformanceEndDateTime,PerformanceStartDateTime,UsePrimaryEmail
"""string""",123,"""string""",123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",true
  • --Price
    Prices an order(including pricing rules). Should have at least one line item, with each line item having at least one sub line item. Individual sub line items can be ignored for pricing by passing ApplyPricing = false, on those sub line items.
Query:
{"AcceptingRollovers":true, "AccountId":123, "AltAddressId":123, "AltElectronicAddressId":123, "AppealId":123, "AppliedMessageRules":"string", "BatchId":123, "BusinessUnitId":123, "CategoryId":123, "ChannelId":123, "ConstituentId":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Custom0":"string", "Custom1":"string", "Custom2":"string", "Custom3":"string", "Custom4":"string", "Custom5":"string", "Custom6":"string", "Custom7":"string", "Custom8":"string", "Custom9":"string", "DeliveryDate":"2000-01-01T00:00:00.000Z", "DeliveryMethodId":123, "HoldUntilDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "InitiatorId":123, "LineItems":[{"Id":123}, ...], "Messages":[{"Id":123}, ...], "MirrorLock":123, "ModeOfSaleId":123, "Notes":"string", "OrderDateTime":"2000-01-01T00:00:00.000Z", "ReloadPricingRules":true, "Solicitor":"string", "SourceId":123, "TotalDue":123.456, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "VirtualConstituencies":"string"}
  • --PrintTicketElements
    Returns ticket elements by header, receipts, and tickets; created primarily for use for building HTML ticket templates The method returns ticket data for unprinted fully-paid orders or reprints printed tickets specified via order number, one or more line item numbers, or one or more sub line item numbers. In the case of partially-paid orders, only line items or sub line items which have been fully-paid will be eligible for printing. Ticket information can be returned in the default design specified for the ticket price type, or you may specify a ticket design to utilize via the request parameters. After the ticket data has been returned via the API, seats will be flagged as Ticketed in Tessitura. When reprinting tickets, one of the request parameters provides you with the option to regenerate the ticket number or reuse the current ticket number. Composite tickets are not currently supported, so a request to print one will instead return ticket elements for each performance, as if no composite ticket design had been selected for the package.
Query:
{"OrderID":"string", "BatchId":123, "HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "NewTicketNoForReprints":true, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123}

[{"BatchId":123,"HeaderDesignId":123,"IncludeReceipts":true,"LineItems":"string","NewTicketNoForReprints":true,"OrderID":"string","PrinterType":"string","ReprintTickets":true,"SubLineItems":"string","TicketDesignId":123}]

BatchId,HeaderDesignId,IncludeReceipts,LineItems,NewTicketNoForReprints,OrderID,PrinterType,ReprintTickets,SubLineItems,TicketDesignId
123,123,true,"""string""",true,"""string""","""string""",true,"""string""",123

Organizations
get put

Create a new organization.

Usage:
tq post Organizations
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "LicenseeAccountCode":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"LicenseeAccountCode":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,LicenseeAccountCode,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

OriginalSources
get put

Create a new original source.

Usage:
tq post OriginalSources
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Origins
get put

Create a new origin.

Usage:
tq post Origins
Query:
{"ActivityType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ActivityType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ActivityType.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

OutputSets
get put

Create an Output Set.

Usage:
tq post OutputSets
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "ElementGroups":[{"IncludePrimaryAffiliation":true, "IsSingleRow":true, "KeywordId":123}, ...], "Id":123, "LastUsedDateTime":"2000-01-01T00:00:00.000Z", "TMSIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

P

PackagePriceTypes
get put

Create a new package price type.

Usage:
tq post PackagePriceTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "PackageId":123, "PriceTypeId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"PackageId":123,"PriceTypeId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Id,PackageId,PriceTypeId,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

PackageTypes
get put

Create a new package type.

Usage:
tq post PackageTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PackageWebContents
get put

Create a packageWebContent.

Usage:
tq post PackageWebContents
Query:
{"ContentType":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "PackageId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Value":"string"}

[{"ContentType.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"PackageId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Value":"string"}]

ContentType.Id,CreateLocation,CreatedBy,CreatedDateTime,Id,PackageId,UpdatedBy,UpdatedDateTime,Value
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

Packages
get

Search for packages

Usage:
tq post Packages
Query:
{"ArtistIds":"string", "BusinessUnitId":123, "ConstituentId":123, "FullTextSearch":"string", "MatchAllPerformances":true, "ModeOfSaleId":123, "PackageEndDate":"2000-01-01T00:00:00.000Z", "PackageFacilityIds":"string", "PackageKeywordAndOr":"string", "PackageKeywordIds":"string", "PackageStartDate":"2000-01-01T00:00:00.000Z", "PackageTypeIds":"string", "PerformanceEndDate":"2000-01-01T00:00:00.000Z", "PerformanceFacilityIds":"string", "PerformanceKeywordAndOr":"string", "PerformanceKeywordIds":"string", "PerformanceStartDate":"2000-01-01T00:00:00.000Z", "SeasonIds":"string"}

[{"ArtistIds":"string","BusinessUnitId":123,"ConstituentId":123,"FullTextSearch":"string","MatchAllPerformances":true,"ModeOfSaleId":123,"PackageEndDate":"2000-01-01T00:00:00.000Z","PackageFacilityIds":"string","PackageKeywordAndOr":"string","PackageKeywordIds":"string","PackageStartDate":"2000-01-01T00:00:00.000Z","PackageTypeIds":"string","PerformanceEndDate":"2000-01-01T00:00:00.000Z","PerformanceFacilityIds":"string","PerformanceKeywordAndOr":"string","PerformanceKeywordIds":"string","PerformanceStartDate":"2000-01-01T00:00:00.000Z","SeasonIds":"string"}]

ArtistIds,BusinessUnitId,ConstituentId,FullTextSearch,MatchAllPerformances,ModeOfSaleId,PackageEndDate,PackageFacilityIds,PackageKeywordAndOr,PackageKeywordIds,PackageStartDate,PackageTypeIds,PerformanceEndDate,PerformanceFacilityIds,PerformanceKeywordAndOr,PerformanceKeywordIds,PerformanceStartDate,SeasonIds
"""string""",123,123,"""string""",true,123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string"""

PaymentComponent

This request is used to configure a transaction and retrieve the JavaScript location for implementing the Tessitura Merchant Services Payment Component. For complete documentation on how to implement the Payment Component, please visit https://bitbucket.org/TN_WebShare/tessituramerchantservicesintegrationsample

Usage:
tq post PaymentComponent
Query:
{"Amount":123.456, "CardBrandsToInclude":["", ...], "ComponentVersion":"string", "ConstituentId":123, "MerchantId":"string", "ShowStoredCards":true}

PaymentGatewayAccounts

Generate a payment card token from a ReferenceNumber obtained from a previous Authorization request (Vantiv only)

Usage:
tq post PaymentGatewayAccounts
Query:
{"ConstituentId":123, "ReferenceNumber":"string"}

[{"ConstituentId":123,"ReferenceNumber":"string"}]

ConstituentId,ReferenceNumber
123,"""string"""

Flags:

  • --StoreToken
    Store an externally generated payment card token in Tessitura. Note that for this call to function, the card_mnemonic column in TR_ACCOUNT_TYPE must be filled in appropriately for your credit card processor. Look for the TR_ACCOUNT_TYPE topic in the Tessitura help documentation for more information on the card mnemonic column.
Query:
{"Card":{"AccountId":123, "CardHolderName":"string", "CardNumber":"string", "Cvv2":"string", "ExpirationDate":"string", "TessituraMerchantServicesData":"string", "Track1":"string", "Track2":"string"}, "ConstituentId":123, "DateUsed":"2000-01-01T00:00:00.000Z", "IsECommerce":true, "NetworkTransactionId":"string", "PaymentMethodGroupId":123, "ShopperReference":"string", "Token":"string"}

[{"Card.AccountId":123,"Card.CardHolderName":"string","Card.CardNumber":"string","Card.Cvv2":"string","Card.ExpirationDate":"string","Card.TessituraMerchantServicesData":"string","Card.Track1":"string","Card.Track2":"string","ConstituentId":123,"DateUsed":"2000-01-01T00:00:00.000Z","IsECommerce":true,"NetworkTransactionId":"string","PaymentMethodGroupId":123,"ShopperReference":"string","Token":"string"}]

Card.AccountId,Card.CardHolderName,Card.CardNumber,Card.Cvv2,Card.ExpirationDate,Card.TessituraMerchantServicesData,Card.Track1,Card.Track2,ConstituentId,DateUsed,IsECommerce,NetworkTransactionId,PaymentMethodGroupId,ShopperReference,Token
123,"""string""","""string""","""string""","""string""","""string""","""string""","""string""",123,"""2000-01-01T00:00:00.000Z""",true,"""string""",123,"""string""","""string"""

PaymentGatewayActivities
get put

Create a new Payment Gateway Activity

Usage:
tq post PaymentGatewayActivities
Query:
{"AccountId":123, "AccountNumber":"string", "ActivityData":"string", "Amount":123.456, "AuthCode":"string", "AvsAddress":"string", "AvsPostalcode":"string", "AvsResultCode":"string", "BalanceAmount":123.456, "BalanceCurrencyCode":"string", "ConstituentId":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CvvResultCode":"string", "EcommerceIndicator":"string", "EmvApplicationIdentifier":"string", "EmvApplicationName":"string", "EmvCryptogram":"string", "EmvHostResponseCode":"string", "EmvHostResponseMessage":"string", "EmvPinVerified":"string", "EntryMethod":"string", "ExpirationDate":"string", "Id":123, "MerchantId":"string", "Name":"string", "NetworkTransactionId":"string", "Origin":"string", "PaymentGatewayTransactionType":{"Id":123}, "PaymentId":123, "PaymentMethodGroupId":123, "PaymentMethodId":123, "ProviderCommunicationDurationMs":123, "ProviderTransactionDateTime":"2000-01-01T00:00:00.000Z", "ReferenceNumber":"string", "ResponseCode":"string", "ResponseMessage":"string", "Success":"string", "TerminalIdentifier":"string", "TotalDurationMs":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserData":"string"}

[{"AccountId":123,"AccountNumber":"string","ActivityData":"string","Amount":123.456,"AuthCode":"string","AvsAddress":"string","AvsPostalcode":"string","AvsResultCode":"string","BalanceAmount":123.456,"BalanceCurrencyCode":"string","ConstituentId":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","CvvResultCode":"string","EcommerceIndicator":"string","EmvApplicationIdentifier":"string","EmvApplicationName":"string","EmvCryptogram":"string","EmvHostResponseCode":"string","EmvHostResponseMessage":"string","EmvPinVerified":"string","EntryMethod":"string","ExpirationDate":"string","Id":123,"MerchantId":"string","Name":"string","NetworkTransactionId":"string","Origin":"string","PaymentGatewayTransactionType.Id":123,"PaymentId":123,"PaymentMethodGroupId":123,"PaymentMethodId":123,"ProviderCommunicationDurationMs":123,"ProviderTransactionDateTime":"2000-01-01T00:00:00.000Z","ReferenceNumber":"string","ResponseCode":"string","ResponseMessage":"string","Success":"string","TerminalIdentifier":"string","TotalDurationMs":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserData":"string"}]

AccountId,AccountNumber,ActivityData,Amount,AuthCode,AvsAddress,AvsPostalcode,AvsResultCode,BalanceAmount,BalanceCurrencyCode,ConstituentId,CreateLocation,CreatedBy,CreatedDateTime,CvvResultCode,EcommerceIndicator,EmvApplicationIdentifier,EmvApplicationName,EmvCryptogram,EmvHostResponseCode,EmvHostResponseMessage,EmvPinVerified,EntryMethod,ExpirationDate,Id,MerchantId,Name,NetworkTransactionId,Origin,PaymentGatewayTransactionType.Id,PaymentId,PaymentMethodGroupId,PaymentMethodId,ProviderCommunicationDurationMs,ProviderTransactionDateTime,ReferenceNumber,ResponseCode,ResponseMessage,Success,TerminalIdentifier,TotalDurationMs,UpdatedBy,UpdatedDateTime,UserData
123,"""string""","""string""",123.456,"""string""","""string""","""string""","""string""",123.456,"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""",123,"""string""","""string""","""string""","""string""",123,123,123,123,123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

PaymentGatewayCredentials

Usage:
tq post PaymentGatewayCredentials
Query:
{"ConstituentId":123, "MerchantId":"string"}

[{"ConstituentId":123,"MerchantId":"string"}]

ConstituentId,MerchantId
123,"""string"""

PaymentGatewayNotifications
get put

Create a new notification event.

Usage:
tq post PaymentGatewayNotifications
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EventType":"string", "Id":123, "Payload":"string", "ProcessedDate":"2000-01-01T00:00:00.000Z", "ReceivedDate":"2000-01-01T00:00:00.000Z", "Reference":"string", "Topic":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EventType":"string","Id":123,"Payload":"string","ProcessedDate":"2000-01-01T00:00:00.000Z","ReceivedDate":"2000-01-01T00:00:00.000Z","Reference":"string","Topic":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,EventType,Id,Payload,ProcessedDate,ReceivedDate,Reference,Topic,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

PaymentGatewayTransactionTypes
get put

Create a new Payment Gateway Transaction Type.

Usage:
tq post PaymentGatewayTransactionTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PaymentMethodGroups
get put

Create a new payment method group.

Usage:
tq post PaymentMethodGroups
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "MerchantId":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"MerchantId":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,MerchantId,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

PaymentMethodUserGroups
get put

Create a new payment method/user group mapping.

Usage:
tq post PaymentMethodUserGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "IncomeIndicator":true, "MaxRefund":123.456, "PaymentMethod":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"IncomeIndicator":true,"MaxRefund":123.456,"PaymentMethod.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,Id,IncomeIndicator,MaxRefund,PaymentMethod.Id,UpdatedBy,UpdatedDateTime,UserGroupId
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,true,123.456,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

PaymentMethods
get put

Create a new payment method.

Usage:
tq post PaymentMethods
Query:
{"AccountType":{"Id":123}, "AuthIndicator":true, "BusinessUnitId":123, "CanRefund":true, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CurrencyTypeId":123, "DefaultIndicator":true, "Description":"string", "GiftAidIndicator":true, "GlAccountId":"string", "Id":123, "Inactive":true, "Income":true, "MerchantId":"string", "MerchantIdForSwipe":"string", "NoCopiesOnAuth":123, "NoCopiesOnSave":123, "OpenCashDrawer":true, "PaymentMethodGroup":{"Id":123}, "PaymentType":{"Id":123}, "ReceiptFormatId":123, "RequireCheckIndicator":true, "RequireCvv":true, "RequirePostalCode":"string", "ShortDesc":"string", "StoreTenderedAmount":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseWithCardReader":true}

[{"AccountType.Id":123,"AuthIndicator":true,"BusinessUnitId":123,"CanRefund":true,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","CurrencyTypeId":123,"DefaultIndicator":true,"Description":"string","GiftAidIndicator":true,"GlAccountId":"string","Id":123,"Inactive":true,"Income":true,"MerchantId":"string","MerchantIdForSwipe":"string","NoCopiesOnAuth":123,"NoCopiesOnSave":123,"OpenCashDrawer":true,"PaymentMethodGroup.Id":123,"PaymentType.Id":123,"ReceiptFormatId":123,"RequireCheckIndicator":true,"RequireCvv":true,"RequirePostalCode":"string","ShortDesc":"string","StoreTenderedAmount":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseWithCardReader":true}]

AccountType.Id,AuthIndicator,BusinessUnitId,CanRefund,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,CurrencyTypeId,DefaultIndicator,Description,GiftAidIndicator,GlAccountId,Id,Inactive,Income,MerchantId,MerchantIdForSwipe,NoCopiesOnAuth,NoCopiesOnSave,OpenCashDrawer,PaymentMethodGroup.Id,PaymentType.Id,ReceiptFormatId,RequireCheckIndicator,RequireCvv,RequirePostalCode,ShortDesc,StoreTenderedAmount,UpdatedBy,UpdatedDateTime,UseWithCardReader
123,true,123,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,true,"""string""",true,"""string""",123,true,true,"""string""","""string""",123,123,true,123,123,123,true,true,"""string""","""string""",true,"""string""","""2000-01-01T00:00:00.000Z""",true

PaymentSignatures
get put

Create a new payment signature.

Usage:
tq post PaymentSignatures
Query:
{"Id":123}

[{"Id":123}]

Id
123

Flags:

  • --PostForOrder
    Create a new payment signature.
Query:
{"OrderID":"string", "Id":123}

[{"Id":123,"OrderID":"string"}]

Id,OrderID
123,"""string"""

PaymentTypes
get put

Create a new payment type.

Usage:
tq post PaymentTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Payments
get

Reserves a payment id generated per the request's required "increment" parameter. Increment number must be greater than 0.

Usage:
tq post Payments
Query:
{"Increment":123}

[{"Increment":123}]

Increment
123

PerformanceGroups
get put

Create a new Performance Group.

Usage:
tq post PerformanceGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "DisplayByZone":true, "Facility":{"Id":123}, "FixedSeatIndicator":true, "Id":123, "Season":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "ZoneMap":{"Id":123}}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","DisplayByZone":true,"Facility.Id":123,"FixedSeatIndicator":true,"Id":123,"Season.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","ZoneMap.Id":123}]

CreateLocation,CreatedBy,CreatedDateTime,Description,DisplayByZone,Facility.Id,FixedSeatIndicator,Id,Season.Id,UpdatedBy,UpdatedDateTime,ZoneMap.Id
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,true,123,123,"""string""","""2000-01-01T00:00:00.000Z""",123

PerformancePackageModeOfSales
get put

Create a new performance package mode of sale.

Usage:
tq post PerformancePackageModeOfSales
Query:
{"AutoAttend":"string", "ETicketReleaseDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ModeOfSaleId":123, "PackageId":123, "PerformanceId":123, "PrintIndicator":true, "PrintOnAutoAttend":true, "SeatIndicator":true, "StartDateTime":"2000-01-01T00:00:00.000Z"}

[{"AutoAttend":"string","ETicketReleaseDateTime":"2000-01-01T00:00:00.000Z","EndDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ModeOfSaleId":123,"PackageId":123,"PerformanceId":123,"PrintIndicator":true,"PrintOnAutoAttend":true,"SeatIndicator":true,"StartDateTime":"2000-01-01T00:00:00.000Z"}]

AutoAttend,ETicketReleaseDateTime,EndDateTime,Id,ModeOfSaleId,PackageId,PerformanceId,PrintIndicator,PrintOnAutoAttend,SeatIndicator,StartDateTime
"""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123,123,123,true,true,true,"""2000-01-01T00:00:00.000Z"""

PerformancePriceLayers
get put

Create a new performance price layer.

Usage:
tq post PerformancePriceLayers
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultDesignationCodeId":123, "DefaultGlAccountId":123, "DefaultResaleAccountId":123, "Description":"string", "EffectiveDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "PerformanceId":123, "PerformancePriceTypes":[{"Id":123}, ...], "PriceLayerType":{"Id":123}, "TemplateId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Flags:

  • --PostSummaries
    Create/Update the prices for a set of performances.
Query:
{"Layers":[{"DefaultDesignationCodeId":123, "DefaultGlAccountId":123, "DefaultResaleAccountId":123, "Description":"string", "EffectiveDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "PerformanceId":123, "PerformancePriceTypes":[{"Id":123}, ...], "PriceLayerTypeId":123, "TemplateId":123}, ...]}
  • --Search
    Get all performance price layers for the list of performances. Only one of AsOfDateTime or AsOfRelativeDate can be specified to get prices effective for that date time.
Query:
{"AsOfDateTime":"string", "AsOfRelativeDate":"string", "PerformanceIds":"string"}

[{"AsOfDateTime":"string","AsOfRelativeDate":"string","PerformanceIds":"string"}]

AsOfDateTime,AsOfRelativeDate,PerformanceIds
"""string""","""string""","""string"""
  • --SearchSummaries
    Get all performance price layers for the list of performances. Only one of AsOfDateTime or AsOfRelativeDate can be specified to get prices effective for that date time.
Query:
{"AsOfDateTime":"string", "AsOfRelativeDate":"string", "PerformanceIds":"string"}

[{"AsOfDateTime":"string","AsOfRelativeDate":"string","PerformanceIds":"string"}]

AsOfDateTime,AsOfRelativeDate,PerformanceIds
"""string""","""string""","""string"""

PerformancePriceTypes
get put

Create a new performance price type.

Usage:
tq post PerformancePriceTypes
Query:
{"BaseIndicator":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DesignationCodeId":123, "EffectiveDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "GlAccountId":123, "Id":123, "IsWithinDateRange":true, "PerformanceId":123, "PerformancePriceLayerId":123, "PerformancePrices":[{"Id":123}, ...], "PriceTypeId":123, "ResaleAccountId":123, "StartDateTime":"2000-01-01T00:00:00.000Z", "TicketDesignId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

PerformancePrices
get put

Create a new performance price.

Usage:
tq post PerformancePrices
Query:
{"EditIndicator":true, "EffectiveDateTime":"2000-01-01T00:00:00.000Z", "Enabled":true, "HasEvents":true, "Id":123, "IsPriceBasedOnCurrentEvent":true, "MinPrice":123.456, "PerformanceId":123, "PerformancePriceTypeId":123, "Price":123.456, "ZoneId":123}

[{"EditIndicator":true,"EffectiveDateTime":"2000-01-01T00:00:00.000Z","Enabled":true,"HasEvents":true,"Id":123,"IsPriceBasedOnCurrentEvent":true,"MinPrice":123.456,"PerformanceId":123,"PerformancePriceTypeId":123,"Price":123.456,"ZoneId":123}]

EditIndicator,EffectiveDateTime,Enabled,HasEvents,Id,IsPriceBasedOnCurrentEvent,MinPrice,PerformanceId,PerformancePriceTypeId,Price,ZoneId
true,"""2000-01-01T00:00:00.000Z""",true,true,123,true,123.456,123,123,123.456,123

PerformanceStatuses
get put

Create a new performance status.

Usage:
tq post PerformanceStatuses
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PerformanceTypes
get put

Create a new performance type.

Usage:
tq post PerformanceTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "ValidCountryList":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","ValidCountryList":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime,ValidCountryList
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

Performances
get put

Apply a single hold on a performance seat.

Usage:
tq post Performances
Query:
{"PerformanceID":"string", "HoldCodeId":123, "HoldUntilDate":"2000-01-01T00:00:00.000Z", "ReplaceMode":123, "SeatID":"string"}

[{"HoldCodeId":123,"HoldUntilDate":"2000-01-01T00:00:00.000Z","PerformanceID":"string","ReplaceMode":123,"SeatID":"string"}]

HoldCodeId,HoldUntilDate,PerformanceID,ReplaceMode,SeatID
123,"""2000-01-01T00:00:00.000Z""","""string""",123,"""string"""

Flags:

  • --Copy
    Copy existing performance to a new performance with options.
Query:
{"AvailSaleIndicator":true, "Code":"string", "CopyCredits":true, "CopyNotes":true, "CopyOffers":true, "CopyPriceEvents":true, "CopyPriceLayers":true, "DateTime":"2000-01-01T00:00:00.000Z", "DefaultSaleDateOption":123, "Description":"string", "ModeOfSaleDateOption":123, "PriceEventDateOption":123, "PriceTypeDateOption":123, "ProductionSeasonId":123, "PublishDateOption":123, "ShortName":"string", "SourcePerformanceId":123, "StatusId":123, "TimeSlotId":123, "TypeId":123}

[{"AvailSaleIndicator":true,"Code":"string","CopyCredits":true,"CopyNotes":true,"CopyOffers":true,"CopyPriceEvents":true,"CopyPriceLayers":true,"DateTime":"2000-01-01T00:00:00.000Z","DefaultSaleDateOption":123,"Description":"string","ModeOfSaleDateOption":123,"PriceEventDateOption":123,"PriceTypeDateOption":123,"ProductionSeasonId":123,"PublishDateOption":123,"ShortName":"string","SourcePerformanceId":123,"StatusId":123,"TimeSlotId":123,"TypeId":123}]

AvailSaleIndicator,Code,CopyCredits,CopyNotes,CopyOffers,CopyPriceEvents,CopyPriceLayers,DateTime,DefaultSaleDateOption,Description,ModeOfSaleDateOption,PriceEventDateOption,PriceTypeDateOption,ProductionSeasonId,PublishDateOption,ShortName,SourcePerformanceId,StatusId,TimeSlotId,TypeId
true,"""string""",true,true,true,true,true,"""2000-01-01T00:00:00.000Z""",123,"""string""",123,123,123,123,123,"""string""",123,123,123,123
  • --Reschedule
    Reschedules an existing performance according to the provided options
Query:
{"Campaign":{"Id":123}, "Code":"string", "DateTime":"2000-01-01T00:00:00.000Z", "DefaultSaleDateOption":123, "Id":123, "ModeOfSaleDateOption":123, "OffersDateOption":123, "PriceEventDateOption":123, "PriceTypeDateOption":123, "ProductionSeasonId":123, "PublishDateOption":123, "TimeSlotId":123}

[{"Campaign.Id":123,"Code":"string","DateTime":"2000-01-01T00:00:00.000Z","DefaultSaleDateOption":123,"Id":123,"ModeOfSaleDateOption":123,"OffersDateOption":123,"PriceEventDateOption":123,"PriceTypeDateOption":123,"ProductionSeasonId":123,"PublishDateOption":123,"TimeSlotId":123}]

Campaign.Id,Code,DateTime,DefaultSaleDateOption,Id,ModeOfSaleDateOption,OffersDateOption,PriceEventDateOption,PriceTypeDateOption,ProductionSeasonId,PublishDateOption,TimeSlotId
123,"""string""","""2000-01-01T00:00:00.000Z""",123,123,123,123,123,123,123,123,123
  • --Search
    Search for performances, based on provided criteria.
Query:
{"ArtistIds":"string", "BusinessUnitId":123, "ConstituentId":123, "FacilityIds":"string", "FullTextSearch":"string", "KeywordAndOr":"string", "KeywordIds":"string", "ModeOfSaleId":123, "PerformanceEndDate":"2000-01-01T00:00:00.000Z", "PerformanceStartDate":"2000-01-01T00:00:00.000Z", "PerformanceTypeIds":"string", "ProductionSeasonIds":"string", "SeasonIds":"string"}

[{"ArtistIds":"string","BusinessUnitId":123,"ConstituentId":123,"FacilityIds":"string","FullTextSearch":"string","KeywordAndOr":"string","KeywordIds":"string","ModeOfSaleId":123,"PerformanceEndDate":"2000-01-01T00:00:00.000Z","PerformanceStartDate":"2000-01-01T00:00:00.000Z","PerformanceTypeIds":"string","ProductionSeasonIds":"string","SeasonIds":"string"}]

ArtistIds,BusinessUnitId,ConstituentId,FacilityIds,FullTextSearch,KeywordAndOr,KeywordIds,ModeOfSaleId,PerformanceEndDate,PerformanceStartDate,PerformanceTypeIds,ProductionSeasonIds,SeasonIds
"""string""",123,123,"""string""","""string""","""string""","""string""",123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string"""
  • --SeatHolds
    Update seat holds for a performance Can be used to add or remove holds from seats for the specified performance. Specifying a hold code of -1 for a seat will remove all hold codes from that seat.
Query:
{"PerformanceID":"string", "HoldUntilDate":"2000-01-01T00:00:00.000Z", "OnlyAffectAvailable":true, "ReplaceMode":123, "SeatHolds":[{"HoldCodeId":123, "SeatId":123}, ...]}

Philanthropy
get put

Create an philanthropyEntry for a constituent.

Usage:
tq post Philanthropy
Query:
{"Activity":"string", "Amount":123.456, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DonatedTo":"string", "DonatedToConstituent":{"Id":123}, "DonationDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "PhilanthropyType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Activity":"string","Amount":123.456,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DonatedTo":"string","DonatedToConstituent.Id":123,"DonationDateTime":"2000-01-01T00:00:00.000Z","Id":123,"PhilanthropyType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Activity,Amount,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,DonatedTo,DonatedToConstituent.Id,DonationDateTime,Id,PhilanthropyType.Id,UpdatedBy,UpdatedDateTime
"""string""",123.456,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z"""

PhilanthropyTypes
get put

Create a new philosophy type.

Usage:
tq post PhilanthropyTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PhoneIndicators
get put

Create a new phone indicator.

Usage:
tq post PhoneIndicators
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PhoneTypes
get put

Create a new phone type.

Usage:
tq post PhoneTypes
Query:
{"AllowMarketing":true, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DayEveningIndicator":"string", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AllowMarketing":true,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DayEveningIndicator":"string","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AllowMarketing,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DayEveningIndicator,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Phones
get put

Create a new phone.

Usage:
tq post Phones
Query:
{"Address":{"Id":123}, "AllowTelemarketing":true, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DayEveningIndicator":"string", "EditIndicator":true, "Id":123, "Inactive":true, "PhoneFormatted":"string", "PhoneNumber":"string", "PhoneSearch":"string", "PhoneType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Address.Id":123,"AllowTelemarketing":true,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DayEveningIndicator":"string","EditIndicator":true,"Id":123,"Inactive":true,"PhoneFormatted":"string","PhoneNumber":"string","PhoneSearch":"string","PhoneType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Address.Id,AllowTelemarketing,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,DayEveningIndicator,EditIndicator,Id,Inactive,PhoneFormatted,PhoneNumber,PhoneSearch,PhoneType.Id,UpdatedBy,UpdatedDateTime
123,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,true,"""string""","""string""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

PlanPriorities
get put

Create a new plan priority.

Usage:
tq post PlanPriorities
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Ranking":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Ranking":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Ranking,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

PlanSources
get put

Create a new plan source.

Usage:
tq post PlanSources
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PlanStatuses
get put

Create a new plan status.

Usage:
tq post PlanStatuses
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Rank":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Rank":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Rank,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

PlanTypes
get put

Create a new plan type.

Usage:
tq post PlanTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PlanWorkers
get put

Create a new plan worker.

Usage:
tq post PlanWorkers
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "Plan":{"Id":123}, "PrimaryIndicator":true, "Role":{"Id":123}, "ShowInPortfolio":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Worker":{"Id":123}}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"Plan.Id":123,"PrimaryIndicator":true,"Role.Id":123,"ShowInPortfolio":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Worker.Id":123}]

CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,Plan.Id,PrimaryIndicator,Role.Id,ShowInPortfolio,UpdatedBy,UpdatedDateTime,Worker.Id
"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,true,123,true,"""string""","""2000-01-01T00:00:00.000Z""",123

Plans
get put

Create a new plan.

Usage:
tq post Plans
Query:
{"AskAmount":123.456, "Campaign":{"Id":123}, "CompleteByDateTime":"2000-01-01T00:00:00.000Z", "Constituent":{"Id":123}, "ContributionAmount":123.456, "ContributionDesignation":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "CustomDataItems":[{"DataType":"string", "Description":"string", "EditIndicator":true, "Index":123, "IsDropdown":true, "KeywordId":123, "Name":"string", "Value":"string"}, ...], "EditIndicator":true, "Fund":{"Id":123}, "GoalAmount":123.456, "HasOpenSteps":true, "HasSteps":true, "Id":123, "LastStepDate":"2000-01-01T00:00:00.000Z", "LastStepType":{"Id":123}, "LastWorkerDisplayName":"string", "NextStepDate":"2000-01-01T00:00:00.000Z", "NextStepType":{"Id":123}, "Notes":"string", "OriginalSource":{"Id":123}, "PlanAssociates":"string", "PrimaryWorker":{"Id":123}, "Priority":{"Id":123}, "Probability":123.456, "RecordedAmount":123.456, "StartDateTime":"2000-01-01T00:00:00.000Z", "Status":{"Id":123}, "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

PledgeBilling
get

This is not intended for use outside of the Tessitura application. There is no standard way to return billing details for a run. For a given campaign, funds, bill types etc., It raises bills for all those scheduled payments that have due date between given start and end dates. It also checks to see that a bill was not raised after a given 'cut off date'.

Usage:
tq post PledgeBilling
Query:
{"AcknowledgementLetterId":123, "AppealId":123, "BatchTypeId":123, "BillingTypeId":123, "CampaignId":123, "CutoffDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "FundIds":"string", "IsLabel":true, "ListId":123, "MailDateTime":"2000-01-01T00:00:00.000Z", "MailTypeId":123, "MaxNumberOfBillsToPrint":123, "MediaTypeId":123, "MinAmount":123.456, "MinNumberOfBillsToPrint":123, "NewSourceDescription":"string", "PaymentMethodGroupId":123, "SalutationTypeId":123, "ShouldUpdate":true, "StartDateTime":"2000-01-01T00:00:00.000Z", "UserId":"string"}

[{"AcknowledgementLetterId":123,"AppealId":123,"BatchTypeId":123,"BillingTypeId":123,"CampaignId":123,"CutoffDateTime":"2000-01-01T00:00:00.000Z","EndDateTime":"2000-01-01T00:00:00.000Z","FundIds":"string","IsLabel":true,"ListId":123,"MailDateTime":"2000-01-01T00:00:00.000Z","MailTypeId":123,"MaxNumberOfBillsToPrint":123,"MediaTypeId":123,"MinAmount":123.456,"MinNumberOfBillsToPrint":123,"NewSourceDescription":"string","PaymentMethodGroupId":123,"SalutationTypeId":123,"ShouldUpdate":true,"StartDateTime":"2000-01-01T00:00:00.000Z","UserId":"string"}]

AcknowledgementLetterId,AppealId,BatchTypeId,BillingTypeId,CampaignId,CutoffDateTime,EndDateTime,FundIds,IsLabel,ListId,MailDateTime,MailTypeId,MaxNumberOfBillsToPrint,MediaTypeId,MinAmount,MinNumberOfBillsToPrint,NewSourceDescription,PaymentMethodGroupId,SalutationTypeId,ShouldUpdate,StartDateTime,UserId
123,123,123,123,123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""",true,123,"""2000-01-01T00:00:00.000Z""",123,123,123,123.456,123,"""string""",123,123,true,"""2000-01-01T00:00:00.000Z""","""string"""

PortfolioCustomElements
get put

Create a new portfolio custom element.

Usage:
tq post PortfolioCustomElements
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DataType":123, "Description":"string", "Id":123, "Inactive":true, "SqlQuery":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DataType":123,"Description":"string","Id":123,"Inactive":true,"SqlQuery":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DataType,Description,Id,Inactive,SqlQuery,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

Prefixes
get put

Create a new prefix.

Usage:
tq post Prefixes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Premieres
get put

Create a new premiere.

Usage:
tq post Premieres
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PriceCategories
get put

Create a new price category.

Usage:
tq post PriceCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Rank":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Rank":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Rank,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

PriceLayerTypes
get put

Create a new price layer type.

Usage:
tq post PriceLayerTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "ExcludeFromRules":true, "Id":123, "Inactive":true, "PriceCategory":{"Id":123}, "Rank":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","ExcludeFromRules":true,"Id":123,"Inactive":true,"PriceCategory.Id":123,"Rank":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,ExcludeFromRules,Id,Inactive,PriceCategory.Id,Rank,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,true,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

PriceTemplates
get put

Create a new price template.

Usage:
tq post PriceTemplates
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultDesignationCode":{"Id":123}, "DefaultGlAccount":{"Id":123}, "DefaultPriceLayerType":{"Id":123}, "DefaultResaleAccount":{"Id":123}, "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "Name":"string", "PriceCategory":{"Id":123}, "TemplatePriceTypes":[{"Id":123}, ...], "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "ZoneMap":{"Id":123}}

PriceTypeCategories
get put

Create a new price type category.

Usage:
tq post PriceTypeCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,ShortDescription,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

PriceTypeGroups
get put

Create a new price type group.

Usage:
tq post PriceTypeGroups
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PriceTypeReasons
get put

Create a new price type reason.

Usage:
tq post PriceTypeReasons
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "ShortDescription":"string", "TicketText":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"ShortDescription":"string","TicketText":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,ShortDescription,TicketText,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

PriceTypeUserGroups
get put

Create a new price typ/user group mapping.

Usage:
tq post PriceTypeUserGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "PriceType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"PriceType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,Id,PriceType.Id,UpdatedBy,UpdatedDateTime,UserGroupId
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

PriceTypes
get put

Create a new price type.

Usage:
tq post PriceTypes
Query:
{"AliasDescription":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultTicketDesign":{"Id":123}, "Description":"string", "EditIndicator":true, "EditableIndicator":true, "Id":123, "Inactive":true, "PriceTypeCategory":{"Id":123}, "PriceTypeGroup":{"Id":123}, "ReasonIndicator":true, "ShortDescription":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AliasDescription":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultTicketDesign.Id":123,"Description":"string","EditIndicator":true,"EditableIndicator":true,"Id":123,"Inactive":true,"PriceTypeCategory.Id":123,"PriceTypeGroup.Id":123,"ReasonIndicator":true,"ShortDescription":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AliasDescription,CreateLocation,CreatedBy,CreatedDateTime,DefaultTicketDesign.Id,Description,EditIndicator,EditableIndicator,Id,Inactive,PriceTypeCategory.Id,PriceTypeGroup.Id,ReasonIndicator,ShortDescription,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",true,true,123,true,123,123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

PricingRuleCategories
get put

Create a new pricing rule category.

Usage:
tq post PricingRuleCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PricingRuleMessageTypes
get put

Create a new pricing rule message type.

Usage:
tq post PricingRuleMessageTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

PricingRuleSets
get put

Create a new pricing rule set.

Usage:
tq post PricingRuleSets
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "Rules":[{"Id":123}, ...], "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

PricingRules
get put

Create a new pricing rule.

Usage:
tq post PricingRules
Query:
{"Appeals":"string", "ApplyOncePerOrder":true, "ApplyToLowestCommonNumberOfSeats":true, "Constituencies":"string", "ConstituentAttribute":123, "ConstituentAttributeOperator":{"Id":123}, "ConstituentAttributeValue1":"string", "ConstituentAttributeValue2":"string", "ConstituentExclusionListId":123, "ConstituentListId":123, "ConstituentRankType":123, "ConstituentRankingOperator":{"Id":123}, "ConstituentRankingValue1":123, "ConstituentRankingValue2":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "DiscountAmount":123.456, "DiscountIsPercent":true, "DiscountPercentRound":123, "DiscountPriceTypeId":123, "EditIndicator":true, "EndDateTime":"2000-01-01T00:00:00.000Z", "ExcludeGeneralPublic":true, "Id":123, "Inactive":true, "MaxSeats":123, "Messages":[{"Id":123}, ...], "OverTheLimitDateTime":"2000-01-01T00:00:00.000Z", "PromotedAppeals":"string", "PromotedSources":"string", "QualifyingPackage":"string", "QualifyingPerformance":"string", "QualifyingPriceType1":"string", "QualifyingPriceType2":"string", "QualifyingProductionSeason":"string", "QualifyingSeasonPackageType":"string", "QualifyingSeatCount1Value1":123, "QualifyingSeatCount1Value2":123, "QualifyingSeatCount2Value1":123, "QualifyingSeatCount2Value2":123, "QualifyingZone":"string", "RespectMinimumPrice":true, "ResultMaximumSeats":123, "ResultMaximumSeats2":123, "ResultPackage":"string", "ResultPerformance":"string", "ResultPriceType":"string", "ResultProductionSeason":"string", "ResultSeasonPackageType":"string", "ResultSeatCount":123, "ResultZone":"string", "RuleAction":123, "RuleCategory":{"Id":123}, "RuleType":{"Id":123}, "Sources":"string", "StartDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Printers
get put

Create a new printer.

Usage:
tq post Printers
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "MaxCol":123, "MaxRow":123, "MaxX2val":123, "MaxY2val":123, "Type":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"MaxCol":123,"MaxRow":123,"MaxX2val":123,"MaxY2val":123,"Type":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,MaxCol,MaxRow,MaxX2val,MaxY2val,Type,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,123,123,123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

ProductionSeasonMembershipOrganizations
get put

Create a new production season membership organization.

Usage:
tq post ProductionSeasonMembershipOrganizations
Query:
{"AllowMultipleEntry":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "MembershipOrganization":{"Id":123}, "ProductionSeason":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AllowMultipleEntry":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"MembershipOrganization.Id":123,"ProductionSeason.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AllowMultipleEntry,CreateLocation,CreatedBy,CreatedDateTime,Id,MembershipOrganization.Id,ProductionSeason.Id,UpdatedBy,UpdatedDateTime
true,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ProductionSeasons
get

Search for production seasons Returns production seasons matching the specified search criteria.

Usage:
tq post ProductionSeasons
Query:
{"ArtistIds":"string", "BusinessUnitId":123, "ConstituentId":123, "FacilityIds":"string", "FullTextSearch":"string", "KeywordAndOr":"string", "KeywordIds":"string", "MatchAllPerformances":true, "ModeOfSaleId":123, "PerformanceEndDate":"2000-01-01T00:00:00.000Z", "PerformanceStartDate":"2000-01-01T00:00:00.000Z", "SeasonIds":"string"}

[{"ArtistIds":"string","BusinessUnitId":123,"ConstituentId":123,"FacilityIds":"string","FullTextSearch":"string","KeywordAndOr":"string","KeywordIds":"string","MatchAllPerformances":true,"ModeOfSaleId":123,"PerformanceEndDate":"2000-01-01T00:00:00.000Z","PerformanceStartDate":"2000-01-01T00:00:00.000Z","SeasonIds":"string"}]

ArtistIds,BusinessUnitId,ConstituentId,FacilityIds,FullTextSearch,KeywordAndOr,KeywordIds,MatchAllPerformances,ModeOfSaleId,PerformanceEndDate,PerformanceStartDate,SeasonIds
"""string""",123,123,"""string""","""string""","""string""","""string""",true,123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string"""

Products

Get product descriptions

Usage:
tq post Products
Query:
{"PackageIds":"string", "PackageTypeIds":"string", "PerformanceIds":"string", "ProductionSeasonIds":"string"}

[{"PackageIds":"string","PackageTypeIds":"string","PerformanceIds":"string","ProductionSeasonIds":"string"}]

PackageIds,PackageTypeIds,PerformanceIds,ProductionSeasonIds
"""string""","""string""","""string""","""string"""

Flags:

  • --Search
    Search for products based on a set of criteria.
Query:
{"ArtistId":123, "BusinessUnitId":123, "ComposerId":123, "ConstituentId":123, "DayOfWeek":"string", "EndDateRange":"2000-01-01T00:00:00.000Z", "EndDateRangePackage":"2000-01-01T00:00:00.000Z", "FacilityId":123, "FullText":"string", "FullTextType":"string", "IsWebSearch":true, "KeywordAndOr":123, "KeywordDescriptions":"string", "KeywordId":123, "Keywords":"string", "LanguageId":123, "ModeOfSaleId":123, "OnSaleOnly":true, "OneOrAllPerformancesInPackage":"string", "PackageId":123, "PackageIds":"string", "PackageSeasonId":123, "PackageTypeId":123, "PerformanceIds":"string", "ProductionSeasonId":123, "ProductionSeasonIds":"string", "SeasonId":123, "SeasonIds":"string", "ShowAll":true, "ShowConstituentAvailability":true, "ShowGrossAvailability":true, "StartDateRange":"2000-01-01T00:00:00.000Z", "StartDateRangePackage":"2000-01-01T00:00:00.000Z", "TimeSlotId":123, "TitleId":123}

[{"ArtistId":123,"BusinessUnitId":123,"ComposerId":123,"ConstituentId":123,"DayOfWeek":"string","EndDateRange":"2000-01-01T00:00:00.000Z","EndDateRangePackage":"2000-01-01T00:00:00.000Z","FacilityId":123,"FullText":"string","FullTextType":"string","IsWebSearch":true,"KeywordAndOr":123,"KeywordDescriptions":"string","KeywordId":123,"Keywords":"string","LanguageId":123,"ModeOfSaleId":123,"OnSaleOnly":true,"OneOrAllPerformancesInPackage":"string","PackageId":123,"PackageIds":"string","PackageSeasonId":123,"PackageTypeId":123,"PerformanceIds":"string","ProductionSeasonId":123,"ProductionSeasonIds":"string","SeasonId":123,"SeasonIds":"string","ShowAll":true,"ShowConstituentAvailability":true,"ShowGrossAvailability":true,"StartDateRange":"2000-01-01T00:00:00.000Z","StartDateRangePackage":"2000-01-01T00:00:00.000Z","TimeSlotId":123,"TitleId":123}]

ArtistId,BusinessUnitId,ComposerId,ConstituentId,DayOfWeek,EndDateRange,EndDateRangePackage,FacilityId,FullText,FullTextType,IsWebSearch,KeywordAndOr,KeywordDescriptions,KeywordId,Keywords,LanguageId,ModeOfSaleId,OnSaleOnly,OneOrAllPerformancesInPackage,PackageId,PackageIds,PackageSeasonId,PackageTypeId,PerformanceIds,ProductionSeasonId,ProductionSeasonIds,SeasonId,SeasonIds,ShowAll,ShowConstituentAvailability,ShowGrossAvailability,StartDateRange,StartDateRangePackage,TimeSlotId,TitleId
123,123,123,123,"""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,"""string""","""string""",true,123,"""string""",123,"""string""",123,123,true,"""string""",123,"""string""",123,123,"""string""",123,"""string""",123,"""string""",true,true,true,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123

ProgramListings
get put

Create a new program listing.

Usage:
tq post ProgramListings
Query:
{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DonationLevel":{"Id":123}, "EditIndicator":true, "Id":123, "ProgramName":"string", "ProgramType":{"Id":123}, "SortName":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DonationLevel.Id":123,"EditIndicator":true,"Id":123,"ProgramName":"string","ProgramType.Id":123,"SortName":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,DonationLevel.Id,EditIndicator,Id,ProgramName,ProgramType.Id,SortName,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,true,123,"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

Programs
get put

Create a new program.

Usage:
tq post Programs
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

Pronouns
get put

Usage:
tq post Pronouns
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Q

QualificationCategories
get put

Create a new Qualification Category.

Usage:
tq post QualificationCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Qualifications
get put

Create a new Qualification.

Usage:
tq post Qualifications
Query:
{"Category":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Category.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

QueryElementFilters
get put

Create a query element filter.

Usage:
tq post QueryElementFilters
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DataType":123, "Description":"string", "EndOfDay":true, "FilterElement":"string", "Group":{"Id":123}, "Id":123, "ReferenceDescriptionColumn":"string", "ReferenceIdColumn":"string", "ReferenceSort":"string", "ReferenceTable":"string", "ReferenceWhere":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DataType":123,"Description":"string","EndOfDay":true,"FilterElement":"string","Group.Id":123,"Id":123,"ReferenceDescriptionColumn":"string","ReferenceIdColumn":"string","ReferenceSort":"string","ReferenceTable":"string","ReferenceWhere":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,DataType,Description,EndOfDay,FilterElement,Group.Id,Id,ReferenceDescriptionColumn,ReferenceIdColumn,ReferenceSort,ReferenceTable,ReferenceWhere,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",true,"""string""",123,123,"""string""","""string""","""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

QueryElementGroups
get put

Create a new query element group.

Usage:
tq post QueryElementGroups
Query:
{"Category":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DataFrom":"string", "DataWhere":"string", "Description":"string", "Id":123, "IsVirtual":true, "NumberOfParameters":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Category":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DataFrom":"string","DataWhere":"string","Description":"string","Id":123,"IsVirtual":true,"NumberOfParameters":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category,CreateLocation,CreatedBy,CreatedDateTime,DataFrom,DataWhere,Description,Id,IsVirtual,NumberOfParameters,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

QueryElements
get put

Create a new query element.

Usage:
tq post QueryElements
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DataSelect":"string", "Description":"string", "Group":{"Id":123}, "Id":123, "Inactive":true, "IsSingleRow":true, "KeywordId":123, "PrimaryGroupDefault":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DataSelect":"string","Description":"string","Group.Id":123,"Id":123,"Inactive":true,"IsSingleRow":true,"KeywordId":123,"PrimaryGroupDefault":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DataSelect,Description,Group.Id,Id,Inactive,IsSingleRow,KeywordId,PrimaryGroupDefault,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,123,true,true,123,true,"""string""","""2000-01-01T00:00:00.000Z"""

R

RankTypes
get put

Create a new rank type.

Usage:
tq post RankTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Rankings
get put

Create a new ranking.

Usage:
tq post Rankings
Query:
{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "Rank":123, "RankType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"Rank":123,"RankType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,Rank,RankType.Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ReceiptSettings
get put

Create a new Receipt Setting.

Usage:
tq post ReceiptSettings
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EmailFooter":"string", "EmailHeader":"string", "EmailSubject":"string", "Id":123, "Inactive":true, "PrintFooter":"string", "PrintHeader":"string", "ReceiptEmailProfile":{"Id":123}, "TicketEmailProfile":{"Id":123}, "TicketEmailSubject":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EmailFooter":"string","EmailHeader":"string","EmailSubject":"string","Id":123,"Inactive":true,"PrintFooter":"string","PrintHeader":"string","ReceiptEmailProfile.Id":123,"TicketEmailProfile.Id":123,"TicketEmailSubject":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EmailFooter,EmailHeader,EmailSubject,Id,Inactive,PrintFooter,PrintHeader,ReceiptEmailProfile.Id,TicketEmailProfile.Id,TicketEmailSubject,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""",123,true,"""string""","""string""",123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

RecordAttendance

Records attendance for a given ticket number.

Usage:
tq post RecordAttendance
Query:
{"OverrideDoorsOpen":true, "ProfileId":123, "TicketNo":123}

[{"OverrideDoorsOpen":true,"ProfileId":123,"TicketNo":123}]

OverrideDoorsOpen,ProfileId,TicketNo
true,123,123

ReferenceTableUserGroups
get put

Create a new reference table/user group mapping.

Usage:
tq post ReferenceTableUserGroups
Query:
{"CanEdit":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ReferenceTable":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"CanEdit":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ReferenceTable.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

CanEdit,CreateLocation,CreatedBy,CreatedDateTime,Id,ReferenceTable.Id,UpdatedBy,UpdatedDateTime,UserGroupId
true,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

Registration

This is a combined resource for registering a new constituent with logging into the current session. This resource combines a workflow of multiple API actions into a single request. This is primarily designed for creating a constituent with a primary electronic address, a primary login, and logging into the session using the provide login. Creates a new constituent and login. Affiliates can be specified for the constituent to create a household account. The login must be unique for the login type. The electronic address for this constituent must be primary. The primary indicator on ElectronicAddress is unused in this request. The session will be logged in with the new login after successful registration.

Usage:
tq post Registration
Query:
{"Address":{"AddressTypeId":123, "City":"string", "CountryId":123, "PostalCode":"string", "StateId":"string", "Street1":"string", "Street2":"string", "Street3":"string"}, "Affiliates":[{"AffiliationTypeId":123, "ConstituentTypeId":123, "FirstName":"string", "LastName":"string", "MiddleName":"string", "NameIndicator":123, "NameStatusId":123, "Note":"string", "SortName":"string", "Title":"string"}, ...], "ConstituentTypeId":123, "ElectronicAddress":{"Address":"string", "AllowHtmlFormat":true, "AllowMarketing":true, "ElectronicAddressTypeId":123}, "EmarketIndicatorId":123, "FirstName":"string", "GenderId":123, "LastName":"string", "MailIndicatorId":123, "MiddleName":"string", "NameStatusId":123, "OriginalSourceId":123, "PhoneIndicatorId":123, "Phones":[{"AllowTelemarketing":true, "DayEveningIndicator":"string", "PhoneNumber":"string", "PhoneTypeId":123}, ...], "PrefixId":123, "Salutation":{"BusinessTitle":"string", "EnvelopeSalutation1":"string", "EnvelopeSalutation2":"string", "LetterSalutation":"string", "SalutationTypeId":123}, "SortName":"string", "SourceId":123, "SuffixId":123, "WebLogin":{"Login":"string", "LoginTypeId":123, "Password":"string"}, "SessionKey":"string"}

RelationshipCategories
get put

Create a new relationship category.

Usage:
tq post RelationshipCategories
Query:
{"CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ReportRequests
get put

Creates the report request.

Usage:
tq post ReportRequests
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DeletedIndicator":true, "EmailBody":"string", "EmailRecipients":"string", "EmailSubject":"string", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "OutputOption":"string", "Parameters":[{"ParameterId":123, "ReportId":"string", "RequestId":123, "Value":"string"}, ...], "PublicIndicator":true, "QueueStatus":"string", "ReportId":"string", "ReportType":123, "RequestDateTime":"2000-01-01T00:00:00.000Z", "ResultCode":"string", "ResultText":"string", "ScheduleId":123, "Type":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string", "UserId":"string"}

Flags:

  • --GenerateScheduled
Query:
{}

[{}]

ReportSchedules
get put

Verify the next run for a schedule's recurrence pattern by passing the pattern. Returns its calculated next run date/time.

Usage:
tq post ReportSchedules
Query:
{"DayOfWeek":123, "DayWeekNumber":123, "EndDate":"2000-01-01T00:00:00.000Z", "EndTime":"2000-01-01T00:00:00.000Z", "Interval":123, "StartDate":"2000-01-01T00:00:00.000Z", "StartTime":"2000-01-01T00:00:00.000Z", "Type":"string"}

[{"DayOfWeek":123,"DayWeekNumber":123,"EndDate":"2000-01-01T00:00:00.000Z","EndTime":"2000-01-01T00:00:00.000Z","Interval":123,"StartDate":"2000-01-01T00:00:00.000Z","StartTime":"2000-01-01T00:00:00.000Z","Type":"string"}]

DayOfWeek,DayWeekNumber,EndDate,EndTime,Interval,StartDate,StartTime,Type
123,123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string"""

Flags:

  • --Save
    Create a report schedule.
Query:
{"AsOfDateTime":"2000-01-01T00:00:00.000Z", "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DayOfWeek":123, "DayWeekNumber":123, "EndDate":"2000-01-01T00:00:00.000Z", "EndTime":"2000-01-01T00:00:00.000Z", "HeaderRequest":{"Id":123}, "Id":123, "Inactive":true, "Interval":123, "Name":"string", "StartDate":"2000-01-01T00:00:00.000Z", "StartTime":"2000-01-01T00:00:00.000Z", "Type":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AsOfDateTime":"2000-01-01T00:00:00.000Z","ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DayOfWeek":123,"DayWeekNumber":123,"EndDate":"2000-01-01T00:00:00.000Z","EndTime":"2000-01-01T00:00:00.000Z","HeaderRequest.Id":123,"Id":123,"Inactive":true,"Interval":123,"Name":"string","StartDate":"2000-01-01T00:00:00.000Z","StartTime":"2000-01-01T00:00:00.000Z","Type":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AsOfDateTime,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DayOfWeek,DayWeekNumber,EndDate,EndTime,HeaderRequest.Id,Id,Inactive,Interval,Name,StartDate,StartTime,Type,UpdatedBy,UpdatedDateTime
"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123,true,123,"""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

ReportUserGroups
get put

Create a new report/user group mapping.

Usage:
tq post ReportUserGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ReportId":"string", "RunRight":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string", "ViewRight":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ReportId":"string","RunRight":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string","ViewRight":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,Id,ReportId,RunRight,UpdatedBy,UpdatedDateTime,UserGroupId,ViewRight
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string"""

Reports
get

Get parameter values for a report parameter.

Usage:
tq post Reports
Query:
{"ParameterName":"string", "ReportId":"string", "WhereDependencies":[{"ParameterId":"string"}, ...]}

Research
get put

Create a research entry for a constituent.

Usage:
tq post Research
Query:
{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "ResearchDate":"2000-01-01T00:00:00.000Z", "ResearchSource":"string", "ResearchType":{"Id":123}, "Researcher":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"ResearchDate":"2000-01-01T00:00:00.000Z","ResearchSource":"string","ResearchType.Id":123,"Researcher.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Id,ResearchDate,ResearchSource,ResearchType.Id,Researcher.Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,"""2000-01-01T00:00:00.000Z""","""string""",123,123,"""string""","""2000-01-01T00:00:00.000Z"""

ResearchTypes
get put

Create a new research type.

Usage:
tq post ResearchTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ResourceCategories
get put

Create a new Resource Category.

Usage:
tq post ResourceCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ResourceSchedules
get put

Create a Busy or Available resource schedule. Booking Assignment Schedules must be created in a booking.

Usage:
tq post ResourceSchedules
Query:
{"BookingAssignmentId":123, "ConstituentId":123, "Count":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "OverrideConflicts":true, "RecurrenceDayOfWeek":"string", "RecurrenceEndDate":"2000-01-01T00:00:00.000Z", "RecurrenceInterval":123, "RecurrenceOrdinal":123, "RecurrencePattern":123, "ResourceId":123, "StartDateTime":"2000-01-01T00:00:00.000Z", "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BookingAssignmentId":123,"ConstituentId":123,"Count":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EndDateTime":"2000-01-01T00:00:00.000Z","Id":123,"OverrideConflicts":true,"RecurrenceDayOfWeek":"string","RecurrenceEndDate":"2000-01-01T00:00:00.000Z","RecurrenceInterval":123,"RecurrenceOrdinal":123,"RecurrencePattern":123,"ResourceId":123,"StartDateTime":"2000-01-01T00:00:00.000Z","Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BookingAssignmentId,ConstituentId,Count,CreateLocation,CreatedBy,CreatedDateTime,Description,EndDateTime,Id,OverrideConflicts,RecurrenceDayOfWeek,RecurrenceEndDate,RecurrenceInterval,RecurrenceOrdinal,RecurrencePattern,ResourceId,StartDateTime,Type.Id,UpdatedBy,UpdatedDateTime
123,123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z""",123,true,"""string""","""2000-01-01T00:00:00.000Z""",123,123,123,123,"""2000-01-01T00:00:00.000Z""",123,"""string""","""2000-01-01T00:00:00.000Z"""

ResourceTypes
get put

Create a new resource type.

Usage:
tq post ResourceTypes
Query:
{"CanBeShared":true, "Category":{"Id":123}, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "HasCapacity":true, "Id":123, "Inactive":true, "RequireAvailability":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CanBeShared":true,"Category.Id":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditIndicator":true,"HasCapacity":true,"Id":123,"Inactive":true,"RequireAvailability":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CanBeShared,Category.Id,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EditIndicator,HasCapacity,Id,Inactive,RequireAvailability,UpdatedBy,UpdatedDateTime
true,123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,true,123,true,true,"""string""","""2000-01-01T00:00:00.000Z"""

Resources
get put

Create a Resource.

Usage:
tq post Resources
Query:
{"Capacity":123, "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultConfirmationText":"string", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "Notes":"string", "ResourceType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Capacity":123,"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultConfirmationText":"string","Description":"string","EditIndicator":true,"Id":123,"Inactive":true,"Notes":"string","ResourceType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Capacity,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultConfirmationText,Description,EditIndicator,Id,Inactive,Notes,ResourceType.Id,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",true,123,true,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

Flags:

  • --FindAvailableResources
    Get a set of resources available at the requested time/count/qualifications.
Query:
{"EndDateTime":"2000-01-01T00:00:00.000Z", "QualificationIds":"string", "ResourceCount":123, "ResourceTypeId":123, "StartDateTime":"2000-01-01T00:00:00.000Z"}

[{"EndDateTime":"2000-01-01T00:00:00.000Z","QualificationIds":"string","ResourceCount":123,"ResourceTypeId":123,"StartDateTime":"2000-01-01T00:00:00.000Z"}]

EndDateTime,QualificationIds,ResourceCount,ResourceTypeId,StartDateTime
"""2000-01-01T00:00:00.000Z""","""string""",123,123,"""2000-01-01T00:00:00.000Z"""
  • --ScheduleOccurrences
    Get schedule occurrences for set of resources and/or constituents during certain period of time.
Query:
{"ConstituentIds":"string", "EndDateTime":"2000-01-01T00:00:00.000Z", "ExpandWorkerAssignments":true, "ResourceIds":"string", "ResourceTypeIds":"string", "StartDateTime":"2000-01-01T00:00:00.000Z"}

[{"ConstituentIds":"string","EndDateTime":"2000-01-01T00:00:00.000Z","ExpandWorkerAssignments":true,"ResourceIds":"string","ResourceTypeIds":"string","StartDateTime":"2000-01-01T00:00:00.000Z"}]

ConstituentIds,EndDateTime,ExpandWorkerAssignments,ResourceIds,ResourceTypeIds,StartDateTime
"""string""","""2000-01-01T00:00:00.000Z""",true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

S

SalesChannels
get put

Create a new sales channel.

Usage:
tq post SalesChannels
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

SalesLayoutButtonTypes
get put

Create a new sales layout button type.

Usage:
tq post SalesLayoutButtonTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

SalesLayouts
get put

Create a new sales layout setup.

Usage:
tq post SalesLayouts
Query:
{"Columns":123, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "PaymentMethods":[{"Id":123}, ...], "PriceTypes":[{"Id":123}, ...], "PrimaryIndicator":true, "Rows":123, "SalesLayoutButtons":[{"Id":123}, ...], "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

SalutationTypes
get put

Create a new salutation type.

Usage:
tq post SalutationTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Salutations
get put

Create a new salutation.

Usage:
tq post Salutations
Query:
{"BusinessTitle":"string", "Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultIndicator":true, "EditIndicator":true, "EnvelopeSalutation1":"string", "EnvelopeSalutation2":"string", "Id":123, "IsFromAffiliation":true, "Label":true, "LetterSalutation":"string", "SalutationType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BusinessTitle":"string","Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultIndicator":true,"EditIndicator":true,"EnvelopeSalutation1":"string","EnvelopeSalutation2":"string","Id":123,"IsFromAffiliation":true,"Label":true,"LetterSalutation":"string","SalutationType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BusinessTitle,Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultIndicator,EditIndicator,EnvelopeSalutation1,EnvelopeSalutation2,Id,IsFromAffiliation,Label,LetterSalutation,SalutationType.Id,UpdatedBy,UpdatedDateTime
"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,true,"""string""","""string""",123,true,true,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z"""

SchedulePatternTypes
get put

Create a new Schedule Pattern.

Usage:
tq post SchedulePatternTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

ScheduleTypes
get put

Create a new Schedule Type.

Usage:
tq post ScheduleTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

SeasonTypes
get put

Create a new season type.

Usage:
tq post SeasonTypes
Query:
{"BusinessUnit":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BusinessUnit.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BusinessUnit.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Seasons
get put

Create a new season.

Usage:
tq post Seasons
Query:
{"ConfirmationNoticeFormat":123, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DefaultIndicator":true, "Description":"string", "DisplayInSeasonOverview":true, "EndDateTime":"2000-01-01T00:00:00.000Z", "FYear":123, "Id":123, "Inactive":true, "RenewalNoticeFormat":123, "StartDateTime":"2000-01-01T00:00:00.000Z", "SubscriptionFund1":123, "SubscriptionFund2":123, "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "YearlySeason":123}

[{"ConfirmationNoticeFormat":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DefaultIndicator":true,"Description":"string","DisplayInSeasonOverview":true,"EndDateTime":"2000-01-01T00:00:00.000Z","FYear":123,"Id":123,"Inactive":true,"RenewalNoticeFormat":123,"StartDateTime":"2000-01-01T00:00:00.000Z","SubscriptionFund1":123,"SubscriptionFund2":123,"Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","YearlySeason":123}]

ConfirmationNoticeFormat,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DefaultIndicator,Description,DisplayInSeasonOverview,EndDateTime,FYear,Id,Inactive,RenewalNoticeFormat,StartDateTime,SubscriptionFund1,SubscriptionFund2,Type.Id,UpdatedBy,UpdatedDateTime,YearlySeason
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,"""string""",true,"""2000-01-01T00:00:00.000Z""",123,123,true,123,"""2000-01-01T00:00:00.000Z""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z""",123

SeatCodes
get put

Create a new seat code.

Usage:
tq post SeatCodes
Query:
{"BackColor":123, "Context":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "DisplayLetter":"string", "ForeColor":123, "Id":123, "Inactive":true, "IsSeat":123, "TicketText":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BackColor":123,"Context":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","DisplayLetter":"string","ForeColor":123,"Id":123,"Inactive":true,"IsSeat":123,"TicketText":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BackColor,Context,CreateLocation,CreatedBy,CreatedDateTime,Description,DisplayLetter,ForeColor,Id,Inactive,IsSeat,TicketText,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,123,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

SeatStatuses
get put

Create a new seat status.

Usage:
tq post SeatStatuses
Query:
{"BackColor":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "ForeColor":123, "Id":123, "Inactive":true, "StatusCode":"string", "StatusLegend":"string", "StatusPriority":123, "Tck":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"BackColor":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","ForeColor":123,"Id":123,"Inactive":true,"StatusCode":"string","StatusLegend":"string","StatusPriority":123,"Tck":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

BackColor,CreateLocation,CreatedBy,CreatedDateTime,Description,ForeColor,Id,Inactive,StatusCode,StatusLegend,StatusPriority,Tck,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,123,true,"""string""","""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

Sections
get put

Create a new section.

Usage:
tq post Sections
Query:
{"AdditionalText":"string", "AdditionalText2":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "PrintDesc":"string", "PrintSequence":123, "SectionLegend":"string", "ShortDesc":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AdditionalText":"string","AdditionalText2":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"PrintDesc":"string","PrintSequence":123,"SectionLegend":"string","ShortDesc":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AdditionalText,AdditionalText2,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,PrintDesc,PrintSequence,SectionLegend,ShortDesc,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""",123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

ServiceResourceUserGroups
get put

Create a new service resource/user group mapping.

Usage:
tq post ServiceResourceUserGroups
Query:
{"CanCreate":true, "CanDelete":true, "CanRead":true, "CanUpdate":true, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "ServiceResource":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UserGroupId":"string"}

[{"CanCreate":true,"CanDelete":true,"CanRead":true,"CanUpdate":true,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"ServiceResource.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UserGroupId":"string"}]

CanCreate,CanDelete,CanRead,CanUpdate,CreateLocation,CreatedBy,CreatedDateTime,Id,ServiceResource.Id,UpdatedBy,UpdatedDateTime,UserGroupId
true,true,true,true,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""","""string"""

Session
get put

Add a new session variable to specified session.

Usage:
tq post Session
Query:
{"SessionKey":"string", "Name":"string", "Value":"string"}

[{"Name":"string","SessionKey":"string","Value":"string"}]

Name,SessionKey,Value
"""string""","""string""","""string"""

Flags:

  • --BusinessFacingSession
    Creates a new business-facing session and returns a unique session key. A source number and mode of sale must be supplied. An optional valid batch id may be included.
Query:
{"BusinessUnit":123, "IpAddress":"string", "Organization":"string", "SessionInfo":{"BatchId":123, "ModeOfSaleId":123, "PromotionCode":123}}

[{"BusinessUnit":123,"IpAddress":"string","Organization":"string","SessionInfo.BatchId":123,"SessionInfo.ModeOfSaleId":123,"SessionInfo.PromotionCode":123}]

BusinessUnit,IpAddress,Organization,SessionInfo.BatchId,SessionInfo.ModeOfSaleId,SessionInfo.PromotionCode
123,"""string""","""string""",123,123,123
  • --LoadOrder
    Load an existing order into the cart and return the cart details

Once an order is loaded, changes can be made to the order. When loaded, the session mode of sale changes to the mode of sale of the loaded order. The method raises an exception if called with existing items in the cart. This method loads all products and payments. Generally, these reloaded products and payments cannot be manipulated by the API. New products and payments can be added, then saved with Checkout. Locked orders cannot be loaded by this method. If the method is called for a locked order, a determination of whether or not the order is locked by an abandoned web session will be made based on the last access time of the session and the Order Lock Timeout value specified in T_DEFAULTS. (Order Lock Timeout is the number of minutes after which to consider an idle session abandoned.) If the session is determined to be abandoned, the order will be unlocked and loaded. NOTE: All orders loaded by this procedure get a mir_lock value of -1.

Query:
{"OrderID":"string", "SessionKey":"string"}

[{"OrderID":"string","SessionKey":"string"}]

OrderID,SessionKey
"""string""","""string"""
  • --Login
    Login a constituent using Username and Password. A constituent record must have an existing login in order for successful authentication.
    A login type parameter is used to determine which login is evaluated for authentication when a constituent record has more than one. This is generally used to differentiate each organization's logins in a consortium environment. This method sets four session variables:
  • UID -- The constituent ID for the session
  • LoginType -- The login type used for the session
  • UserName -- The username for the session
  • Status -- The status of the login (P = permanent, T = temporary) A constituent can be locked out of logging in after a certain number of failed log in attempts. The number of failed attempts before lockout and the length of lockout are set in the T_DEFAULTS table. Should a constituent exceed the allowed number of failed log in attempts, the method returns data on the number of failed login attempts per login along with a timestamp of the time at which the user was locked out of the login process.
Query:
{"LoginTypeId":123, "Password":"string", "PersistSessionOnFailure":true, "PromotionCode":123, "UserName":"string", "SessionKey":"string"}

[{"LoginTypeId":123,"Password":"string","PersistSessionOnFailure":true,"PromotionCode":123,"SessionKey":"string","UserName":"string"}]

LoginTypeId,Password,PersistSessionOnFailure,PromotionCode,SessionKey,UserName
123,"""string""",true,123,"""string""","""string"""
  • --LoginAsGuest
    Login for guest checkout. Allows anonymous checkout under constituent 0, attaching the supplied email address to the cart. The session will be marked as a guest login. If the email address exists attached to a login of the specified login type, that login's constituent ID will be used on the cart.
Query:
{"ElectronicAddressTypeId":123, "EmailAddress":"string", "LoginTypeId":123, "SessionKey":"string"}

[{"ElectronicAddressTypeId":123,"EmailAddress":"string","LoginTypeId":123,"SessionKey":"string"}]

ElectronicAddressTypeId,EmailAddress,LoginTypeId,SessionKey
123,"""string""",123,"""string"""
  • --LoginUsingConstituentInfo
    Login a constituent using Constituent ID, Phone Number and Postal Code. Email can also be passed for additional validation but is optional. A constituent record must have an existing login in order for successful authentication.
    A login type parameter is used to determine which login is evaluated for authentication when a constituent record has more than one. This is generally used to differentiate each organization's logins in a consortium environment. This method sets four session variables:
  • UID -- The constituent ID for the session
  • LoginType -- The login type used for the session
  • UserName -- The username for the session
  • Status -- The status of the login (P = permanent, T = temporary) A constituent can be locked out of logging in after a certain number of failed log in attempts. The number of failed attempts before lockout and the length of lockout are set in the T_DEFAULTS table. Should a constituent exceed the allowed number of failed log in attempts, the method returns data on the number of failed login attempts per login along with a timestamp of the time at which the user was locked out of the login process.
Query:
{"ConstituentId":123, "EmailAddress":"string", "LoginTypeId":123, "PhoneNumber":"string", "PostalCode":"string", "PromotionCode":123, "SessionKey":"string"}

[{"ConstituentId":123,"EmailAddress":"string","LoginTypeId":123,"PhoneNumber":"string","PostalCode":"string","PromotionCode":123,"SessionKey":"string"}]

ConstituentId,EmailAddress,LoginTypeId,PhoneNumber,PostalCode,PromotionCode,SessionKey
123,"""string""",123,"""string""","""string""",123,"""string"""
  • --LoginUsingEmail
    Login a constituent using Email and Password A constituent record must have an existing login in order for successful authentication.
    A login type parameter is used to determine which login is evaluated for authentication when a constituent record has more than one. This is generally used to differentiate each organization's logins in a consortium environment. This method sets four session variables:
  • UID -- The constituent ID for the session
  • LoginType -- The login type used for the session
  • UserName -- The username for the session
  • Status -- The status of the login (P = permanent, T = temporary) A constituent can be locked out of logging in after a certain number of failed log in attempts. The number of failed attempts before lockout and the length of lockout are set in the T_DEFAULTS table. Should a constituent exceed the allowed number of failed log in attempts, the method returns data on the number of failed login attempts per login along with a timestamp of the time at which the user was locked out of the login process.
Query:
{"EmailAddress":"string", "LoginTypeId":123, "Password":"string", "PromotionCode":123, "SessionKey":"string"}

[{"EmailAddress":"string","LoginTypeId":123,"Password":"string","PromotionCode":123,"SessionKey":"string"}]

EmailAddress,LoginTypeId,Password,PromotionCode,SessionKey
"""string""",123,"""string""",123,"""string"""
  • --LoginUsingExternal
    Login a constituent using External Authentication A constituent record must have an existing login in order for successful authentication.
    A login type parameter is used to determine which login is evaluated for authentication when a constituent record has more than one. This is generally used to differentiate each organization's logins in a consortium environment. This method sets four session variables:
  • UID -- The constituent ID for the session
  • LoginType -- The login type used for the session
  • UserName -- The username for the session
  • Status -- The status of the login (P = permanent, T = temporary) A constituent can be locked out of logging in after a certain number of failed log in attempts. The number of failed attempts before lockout and the length of lockout are set in the T_DEFAULTS table. Should a constituent exceed the allowed number of failed log in attempts, the method returns data on the number of failed login attempts per login along with a timestamp of the time at which the user was locked out of the login process.
Query:
{"LoginTypeId":123, "PromotionCode":123, "UserName":"string", "SessionKey":"string"}

[{"LoginTypeId":123,"PromotionCode":123,"SessionKey":"string","UserName":"string"}]

LoginTypeId,PromotionCode,SessionKey,UserName
123,123,"""string""","""string"""
  • --LoginUsingToken
    Login a constituent using Login Token and Email A constituent record must have an existing login in order for successful authentication.
    A login type parameter is used to determine which login is evaluated for authentication when a constituent record has more than one. This is generally used to differentiate each organization's logins in a consortium environment. This method sets four session variables:
  • UID -- The constituent ID for the session
  • LoginType -- The login type used for the session
  • UserName -- The username for the session
  • Status -- The status of the login (P = permanent, T = temporary) A constituent can be locked out of logging in after a certain number of failed log in attempts. The number of failed attempts before lockout and the length of lockout are set in the T_DEFAULTS table. Should a constituent exceed the allowed number of failed log in attempts, the method returns data on the number of failed login attempts per login along with a timestamp of the time at which the user was locked out of the login process.
Query:
{"EmailAddress":"string", "ForgotLoginToken":"string", "LoginTypeId":123, "PromotionCode":123, "SessionKey":"string"}

[{"EmailAddress":"string","ForgotLoginToken":"string","LoginTypeId":123,"PromotionCode":123,"SessionKey":"string"}]

EmailAddress,ForgotLoginToken,LoginTypeId,PromotionCode,SessionKey
"""string""","""string""",123,123,"""string"""
  • --Logout
    Logout a constituent Seats locked by the session are automatically released during logout. This behavior can be disabled by setting the DISCONNECT_ON_LOGOUT entry in T_DEFAULTS or the web.config file to False.
Query:
{"SessionKey":"string"}

[{"SessionKey":"string"}]

SessionKey
"""string"""
  • --PromoCode
    Returns promotion information for a session by number or description A primary use of this method is to translate promo codes (text) into source codes (integers). This method also returns the 6 fields of text that can be recorded for each web source, which can be used to display specific messaging when a promo code is entered by a constituent.
Query:
{"PromoCode":123, "PromoCodeString":"string", "SessionKey":"string"}

[{"PromoCode":123,"PromoCodeString":"string","SessionKey":"string"}]

PromoCode,PromoCodeString,SessionKey
123,"""string""","""string"""
  • --Reprint
    This method causes a Print at Home reprint request to be written for the specified order. Note that the order will only be reprinted by the Tessitura Print at Home Ticketing service if the service is configured to recognize the delivery method used by the order. The mode of sale for the order must also be set in the TR_PAHT_CONFIGURATION table to allow TPAHT reprints. See the Tessitura Print at Home Ticketing Service document for more details.
Query:
{"EmailAddressId":123, "OrderId":123, "SessionKey":"string"}

[{"EmailAddressId":123,"OrderId":123,"SessionKey":"string"}]

EmailAddressId,OrderId,SessionKey
123,123,"""string"""
  • --SendLoginCredentials
    Sends an email with a temporary login token to a specific email address and login type. The service searches for the email address in logins of the specified type. If it is found, a password token will be generated and the login credentials template that is configured in T_FORMAT_INFO will be sent.
Query:
{"EmailAddress":"string", "LoginTypeId":123, "TemplateFormatId":123, "SessionKey":"string"}

[{"EmailAddress":"string","LoginTypeId":123,"SessionKey":"string","TemplateFormatId":123}]

EmailAddress,LoginTypeId,SessionKey,TemplateFormatId
"""string""",123,"""string""",123
  • --Session
    Creates a new session and returns a unique session key.
Query:
{"BusinessUnitId":123, "IpAddress":"string", "Organization":"string", "PromotionCode":123}

[{"BusinessUnitId":123,"IpAddress":"string","Organization":"string","PromotionCode":123}]

BusinessUnitId,IpAddress,Organization,PromotionCode
123,"""string""","""string""",123
  • --TransferSession
    Transfers the authentication for the specified session to another session. This method is typically called after completing checkout, so the constituent is automatically transferred to a new session. This avoids having to log in again. NOTE: The new session must be generated using the /Web/Session (POST) method. You can choose to have the web API automatically disconnect the constituent's session from the Seat Server once transfer session has completed by setting the configuration value of DISCONNECT_SEAT_SERVER_SESSION_WHEN_TRANSFERING_SESSION to True in the Web API config file.
Query:
{"NewSessionKey":"string", "SessionKey":"string"}

[{"NewSessionKey":"string","SessionKey":"string"}]

NewSessionKey,SessionKey
"""string""","""string"""
  • --WebLogin
    Creates a webLogin for a user and logs back into the session using new credentials.
Query:
{"SessionKey":"string", "Constituent":{"Id":123}, "ConstituentUpdateDate":"2000-01-01T00:00:00.000Z", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Email":{"Id":123}, "FailedAttempts":123, "Id":123, "Inactive":true, "LastLoginDate":"2000-01-01T00:00:00.000Z", "LockedDate":"2000-01-01T00:00:00.000Z", "Login":"string", "LoginType":{"Id":123}, "Password":"string", "PrimaryIndicator":true, "TemporaryIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Constituent.Id":123,"ConstituentUpdateDate":"2000-01-01T00:00:00.000Z","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Email.Id":123,"FailedAttempts":123,"Id":123,"Inactive":true,"LastLoginDate":"2000-01-01T00:00:00.000Z","LockedDate":"2000-01-01T00:00:00.000Z","Login":"string","LoginType.Id":123,"Password":"string","PrimaryIndicator":true,"SessionKey":"string","TemporaryIndicator":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Constituent.Id,ConstituentUpdateDate,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Email.Id,FailedAttempts,Id,Inactive,LastLoginDate,LockedDate,Login,LoginType.Id,Password,PrimaryIndicator,SessionKey,TemporaryIndicator,UpdatedBy,UpdatedDateTime
123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,123,true,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""",123,"""string""",true,"""string""",true,"""string""","""2000-01-01T00:00:00.000Z"""

SourceGroups
get put

Create a new source group.

Usage:
tq post SourceGroups
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

SpecialActivities
get put

Create a new activity record.

Usage:
tq post SpecialActivities
Query:
{"ConstituentId":123, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Notes":"string", "NumberOfAttendees":123, "Performance":"string", "SpecialActivityDateTime":"2000-01-01T00:00:00.000Z", "Status":{"Id":123}, "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "WorkerConstituentId":123}

[{"ConstituentId":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Notes":"string","NumberOfAttendees":123,"Performance":"string","SpecialActivityDateTime":"2000-01-01T00:00:00.000Z","Status.Id":123,"Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","WorkerConstituentId":123}]

ConstituentId,CreateLocation,CreatedBy,CreatedDateTime,Id,Notes,NumberOfAttendees,Performance,SpecialActivityDateTime,Status.Id,Type.Id,UpdatedBy,UpdatedDateTime,WorkerConstituentId
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""","""2000-01-01T00:00:00.000Z""",123

SpecialActivityStatuses
get put

Create a new Special Activity Status.

Usage:
tq post SpecialActivityStatuses
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

SpecialActivityTypes
get put

Create a new Special Activity Type.

Usage:
tq post SpecialActivityTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

States
get put

Create a new state.

Usage:
tq post States
Query:
{"Country":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "StateCode":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Country.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"StateCode":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Country.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,StateCode,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

StepTypes
get put

Create a new step type.

Usage:
tq post StepTypes
Query:
{"AllowAttachments":"string", "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseAssociate":"string", "UseCompletedOnDateTime":"string", "UseDueDateTime":"string", "UseNote":"string", "UseWarningDays":"string", "UseWorker":"string"}

[{"AllowAttachments":"string","ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseAssociate":"string","UseCompletedOnDateTime":"string","UseDueDateTime":"string","UseNote":"string","UseWarningDays":"string","UseWorker":"string"}]

AllowAttachments,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime,UseAssociate,UseCompletedOnDateTime,UseDueDateTime,UseNote,UseWarningDays,UseWorker
"""string""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""","""string""","""string""","""string"""

Steps
get put

Create a new step.

Usage:
tq post Steps
Query:
{"Associate":{"Id":123}, "CompletedOnDateTime":"2000-01-01T00:00:00.000Z", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "DueDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Id":123, "NewValue":"string", "Notes":"string", "OldValue":"string", "Plan":{"Id":123}, "Priority":123, "StepDateTime":"2000-01-01T00:00:00.000Z", "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "WarningDays":123, "Worker":{"Id":123}}

[{"Associate.Id":123,"CompletedOnDateTime":"2000-01-01T00:00:00.000Z","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","DueDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Id":123,"NewValue":"string","Notes":"string","OldValue":"string","Plan.Id":123,"Priority":123,"StepDateTime":"2000-01-01T00:00:00.000Z","Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","WarningDays":123,"Worker.Id":123}]

Associate.Id,CompletedOnDateTime,CreateLocation,CreatedBy,CreatedDateTime,Description,DueDateTime,EditIndicator,Id,NewValue,Notes,OldValue,Plan.Id,Priority,StepDateTime,Type.Id,UpdatedBy,UpdatedDateTime,WarningDays,Worker.Id
123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z""",true,123,"""string""","""string""","""string""",123,123,"""2000-01-01T00:00:00.000Z""",123,"""string""","""2000-01-01T00:00:00.000Z""",123,123

Flags:

  • --AddDocument
    Add a document to the step.
Query:
{"Category":{"Id":123}, "ConstituentId":123, "Contents":"AA==", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "FileName":"string", "Id":123, "Notes":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "StepID":"string"}

[{"Category.Id":123,"ConstituentId":123,"Contents":"AA==","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","FileName":"string","Id":123,"Notes":"string","StepID":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category.Id,ConstituentId,Contents,CreateLocation,CreatedBy,CreatedDateTime,Description,FileName,Id,Notes,StepID,UpdatedBy,UpdatedDateTime
123,123,"""AA==""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

SubLineItemStatuses
get put

Create a new sub line item status.

Usage:
tq post SubLineItemStatuses
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Priority":123, "StatusCode":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Priority":123,"StatusCode":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Priority,StatusCode,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""string""","""2000-01-01T00:00:00.000Z"""

Suffixes
get put

Create a new suffix.

Usage:
tq post Suffixes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

SurveyQuestions
get put

Create a new survey question.

Usage:
tq post SurveyQuestions
Query:
{"AskType":123, "ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DataType":123, "DefaultValue":"string", "Id":123, "Inactive":true, "Question":"string", "ReferenceTable":"string", "ReferenceTableDescriptionColumn":"string", "ReferenceTableIdColumn":"string", "ReferenceTableSort":"string", "ReferenceTableWhereClause":"string", "Required":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AskType":123,"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DataType":123,"DefaultValue":"string","Id":123,"Inactive":true,"Question":"string","ReferenceTable":"string","ReferenceTableDescriptionColumn":"string","ReferenceTableIdColumn":"string","ReferenceTableSort":"string","ReferenceTableWhereClause":"string","Required":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AskType,ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,DataType,DefaultValue,Id,Inactive,Question,ReferenceTable,ReferenceTableDescriptionColumn,ReferenceTableIdColumn,ReferenceTableSort,ReferenceTableWhereClause,Required,UpdatedBy,UpdatedDateTime
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",123,true,"""string""","""string""","""string""","""string""","""string""","""string""",true,"""string""","""2000-01-01T00:00:00.000Z"""

SurveyResponses
get put

Create a new survey response.

Usage:
tq post SurveyResponses
Query:
{"Answer":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "OrderId":123, "QuestionId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Answer":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"OrderId":123,"QuestionId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Answer,CreateLocation,CreatedBy,CreatedDateTime,Id,OrderId,QuestionId,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,123,"""string""","""2000-01-01T00:00:00.000Z"""

T

TemplateCategories
get put

Create a new template category

Usage:
tq post TemplateCategories
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "Type":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditIndicator":true,"Id":123,"Inactive":true,"Type.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EditIndicator,Id,Inactive,Type.Id,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

TemplatePriceTypes
get put

Create a new template price type.

Usage:
tq post TemplatePriceTypes
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DesignationCode":{"Id":123}, "GlAccount":{"Id":123}, "Id":123, "PriceTemplate":{"Id":123}, "PriceType":{"Id":123}, "ResaleAccount":{"Id":123}, "TemplatePrices":[{"Id":123}, ...], "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

Flags:

  • --Batch
    Create or update a set of template price types.
Query:
{"TemplatePriceTypes":[{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DesignationCode":{"Id":123}, "GlAccount":{"Id":123}, "Id":123, "PriceTemplate":{"Id":123}, "PriceType":{"Id":123}, "ResaleAccount":{"Id":123}, "TemplatePrices":[{"Id":123}, ...], "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}, ...]}

TemplatePrices
get put

Create a new template price.

Usage:
tq post TemplatePrices
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Enabled":true, "Id":123, "MinPrice":123.456, "Price":123.456, "TemplatePriceType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Zone":{"Id":123}}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Enabled":true,"Id":123,"MinPrice":123.456,"Price":123.456,"TemplatePriceType.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Zone.Id":123}]

CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Enabled,Id,MinPrice,Price,TemplatePriceType.Id,UpdatedBy,UpdatedDateTime,Zone.Id
"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,true,123,123.456,123.456,123,"""string""","""2000-01-01T00:00:00.000Z""",123

Flags:

  • --Batch
    Create or update a set of template prices.
Query:
{"TemplatePrices":[{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Enabled":true, "Id":123, "MinPrice":123.456, "Price":123.456, "TemplatePriceType":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Zone":{"Id":123}}, ...]}

Templates
get put

Create a new template

Usage:
tq post Templates
Query:
{"Category":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditIndicator":true, "Id":123, "Inactive":true, "IsHtmlBody":true, "TemplateBody":"string", "TemplateSubject":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Category.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditIndicator":true,"Id":123,"Inactive":true,"IsHtmlBody":true,"TemplateBody":"string","TemplateSubject":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Category.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EditIndicator,Id,Inactive,IsHtmlBody,TemplateBody,TemplateSubject,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",true,123,true,true,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

Flags:

  • --ConstituentInfo
    Get a formatted html body for constituent info
Query:
{"ConstituentID":"string", "Request":[{"Name":"string", "Value":"string"}, ...], "TemplateID":"string"}
  • --LoginCredentials
    Get a formatted html body for login credentials. This endpoint will not generate a password token and should be used for testing a login credentials template. Use the SendCredentials endpoint in Web/Session to send a login credentials email with a generated password token.
Query:
{"LoginID":"string", "Request":[{"Name":"string", "Value":"string"}, ...], "TemplateID":"string"}
  • --OrderConfirmation
    Get a formatted html body for an order confirmation
Query:
{"OrderID":"string", "Request":[{"Name":"string", "Value":"string"}, ...], "TemplateID":"string"}
  • --RenderConstituentInfo
    Return the rendered constituent info template for the provided constituent Id
Query:
{"ConstituentID":"string", "Body":"string", "NameValues":[{"Name":"string", "Value":"string"}, ...]}
  • --RenderLoginCredentials
    Return the rendered login credentials template for the provided web login id This endpoint will not generate a password token and should be used for testing a login credentials template. Use the SendCredentials endpoint in Web/Session to send a login credentials email with a generated password token.
Query:
{"LoginID":"string", "Body":"string", "NameValues":[{"Name":"string", "Value":"string"}, ...]}
  • --RenderOrderConfirmation
    Return the rendered order confirmation template for the provided order Id
Query:
{"OrderID":"string", "Body":"string", "NameValues":[{"Name":"string", "Value":"string"}, ...]}
  • --RenderTickets
    Return the rendered tickets for the provided order Id Composite tickets are not currently supported, so a request to print one will instead return ticket elements for each performance, as if no composite ticket design had been selected for the package.
Query:
{"OrderID":"string", "Body":"string", "PrintOrderTicketsRequest":{"BatchId":123, "HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "NewTicketNoForReprints":true, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123}}

[{"Body":"string","OrderID":"string","PrintOrderTicketsRequest.BatchId":123,"PrintOrderTicketsRequest.HeaderDesignId":123,"PrintOrderTicketsRequest.IncludeReceipts":true,"PrintOrderTicketsRequest.LineItems":"string","PrintOrderTicketsRequest.NewTicketNoForReprints":true,"PrintOrderTicketsRequest.PrinterType":"string","PrintOrderTicketsRequest.ReprintTickets":true,"PrintOrderTicketsRequest.SubLineItems":"string","PrintOrderTicketsRequest.TicketDesignId":123}]

Body,OrderID,PrintOrderTicketsRequest.BatchId,PrintOrderTicketsRequest.HeaderDesignId,PrintOrderTicketsRequest.IncludeReceipts,PrintOrderTicketsRequest.LineItems,PrintOrderTicketsRequest.NewTicketNoForReprints,PrintOrderTicketsRequest.PrinterType,PrintOrderTicketsRequest.ReprintTickets,PrintOrderTicketsRequest.SubLineItems,PrintOrderTicketsRequest.TicketDesignId
"""string""","""string""",123,123,true,"""string""",true,"""string""",true,"""string""",123
  • --Tickets
    Get a formatted html body for tickets Composite tickets are not currently supported, so a request to print one will instead return ticket elements for each performance, as if no composite ticket design had been selected for the package.
Query:
{"OrderID":"string", "BatchId":123, "HeaderDesignId":123, "IncludeReceipts":true, "LineItems":"string", "NewTicketNoForReprints":true, "PrinterType":"string", "ReprintTickets":true, "SubLineItems":"string", "TicketDesignId":123, "TemplateID":"string"}

[{"BatchId":123,"HeaderDesignId":123,"IncludeReceipts":true,"LineItems":"string","NewTicketNoForReprints":true,"OrderID":"string","PrinterType":"string","ReprintTickets":true,"SubLineItems":"string","TemplateID":"string","TicketDesignId":123}]

BatchId,HeaderDesignId,IncludeReceipts,LineItems,NewTicketNoForReprints,OrderID,PrinterType,ReprintTickets,SubLineItems,TemplateID,TicketDesignId
123,123,true,"""string""",true,"""string""","""string""",true,"""string""","""string""",123

Theaters
get put

Create a new theater.

Usage:
tq post Theaters
Query:
{"City":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "DataWindowDefinition":"string", "Description":"string", "DrivingDirections":"string", "Id":123, "Inactive":true, "MaximumNumberOfSeats":123, "Phone":"string", "PostalCode":"string", "State":"string", "Street":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"City":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","DataWindowDefinition":"string","Description":"string","DrivingDirections":"string","Id":123,"Inactive":true,"MaximumNumberOfSeats":123,"Phone":"string","PostalCode":"string","State":"string","Street":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

City,CreateLocation,CreatedBy,CreatedDateTime,DataWindowDefinition,Description,DrivingDirections,Id,Inactive,MaximumNumberOfSeats,Phone,PostalCode,State,Street,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""","""string""",123,true,123,"""string""","""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z"""

TimeSlots
get put

Create a new time slot.

Usage:
tq post TimeSlots
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EndTime":"2000-01-01T00:00:00.000Z", "Id":123, "Inactive":true, "StartTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EndTime":"2000-01-01T00:00:00.000Z","Id":123,"Inactive":true,"StartTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,EndTime,Id,Inactive,StartTime,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z""",123,true,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

TriPOSCloudConfigurations
get put

Create a new TriPOS Cloud configuration.

Usage:
tq post TriPOSCloudConfigurations
Query:
{"ConfigSetting":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ConfigSetting":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ConfigSetting,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

U

UpgradeCategories
get put

Create a new Upgrade Category.

Usage:
tq post UpgradeCategories
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

UpgradeLogs
get put

Saves the given upgradeLog.

Usage:
tq post UpgradeLogs
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "HotFixNumber":123, "Id":123, "ReleaseDescription":"string", "ScriptId":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UpgradeCategorySummary":{"Id":123}, "Version":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","HotFixNumber":123,"Id":123,"ReleaseDescription":"string","ScriptId":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UpgradeCategorySummary.Id":123,"Version":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,HotFixNumber,Id,ReleaseDescription,ScriptId,UpdatedBy,UpdatedDateTime,UpgradeCategorySummary.Id,Version
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,123,"""string""",123,"""string""","""2000-01-01T00:00:00.000Z""",123,"""string"""

UserPreferences
get put

Create a new user preference.

Usage:
tq post UserPreferences
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Key":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Value":"string"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Key":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","Value":"string"}]

CreateLocation,CreatedBy,CreatedDateTime,Id,Key,UpdatedBy,UpdatedDateTime,Value
"""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string"""

Flags:

  • --SaveBatch
    Save a batch of user preferences.
Query:
{"UserPreferences":[{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Key":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "Value":"string"}, ...]}

Users
get

Allows for changing of a user's password

Usage:
tq post Users
Query:
{"NewPassword":"string", "OldPassword":"string", "UserName":"string"}

[{"NewPassword":"string","OldPassword":"string","UserName":"string"}]

NewPassword,OldPassword,UserName
"""string""","""string""","""string"""

V

ValidateWebLogin

Validate a web login.

Usage:
tq post ValidateWebLogin
Query:
{"LoginName":"string", "LoginTypeId":123, "Password":"string"}

[{"LoginName":"string","LoginTypeId":123,"Password":"string"}]

LoginName,LoginTypeId,Password
"""string""",123,"""string"""

W

WebContentTypes
get put

Create a Web Content Type.

Usage:
tq post WebContentTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EditMask":"string", "FullTextSearchIndicator":true, "Id":123, "Inactive":true, "LastContentUseUpdateDateTime":"2000-01-01T00:00:00.000Z", "Limit":123, "ReferenceDescriptionColumn":"string", "ReferenceIdColumn":"string", "ReferenceSort":"string", "ReferenceTable":"string", "ReferenceWhere":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "UseWebApi":true}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EditMask":"string","FullTextSearchIndicator":true,"Id":123,"Inactive":true,"LastContentUseUpdateDateTime":"2000-01-01T00:00:00.000Z","Limit":123,"ReferenceDescriptionColumn":"string","ReferenceIdColumn":"string","ReferenceSort":"string","ReferenceTable":"string","ReferenceWhere":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","UseWebApi":true}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,EditMask,FullTextSearchIndicator,Id,Inactive,LastContentUseUpdateDateTime,Limit,ReferenceDescriptionColumn,ReferenceIdColumn,ReferenceSort,ReferenceTable,ReferenceWhere,UpdatedBy,UpdatedDateTime,UseWebApi
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",true,123,true,"""2000-01-01T00:00:00.000Z""",123,"""string""","""string""","""string""","""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",true

WebLogins
get put

Create a new weblogin.

Usage:
tq post WebLogins
Query:
{"Constituent":{"Id":123}, "ConstituentUpdateDate":"2000-01-01T00:00:00.000Z", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "Email":{"Id":123}, "FailedAttempts":123, "Id":123, "Inactive":true, "LastLoginDate":"2000-01-01T00:00:00.000Z", "LockedDate":"2000-01-01T00:00:00.000Z", "Login":"string", "LoginType":{"Id":123}, "PrimaryIndicator":true, "TemporaryIndicator":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Constituent.Id":123,"ConstituentUpdateDate":"2000-01-01T00:00:00.000Z","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"Email.Id":123,"FailedAttempts":123,"Id":123,"Inactive":true,"LastLoginDate":"2000-01-01T00:00:00.000Z","LockedDate":"2000-01-01T00:00:00.000Z","Login":"string","LoginType.Id":123,"PrimaryIndicator":true,"TemporaryIndicator":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Constituent.Id,ConstituentUpdateDate,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,Email.Id,FailedAttempts,Id,Inactive,LastLoginDate,LockedDate,Login,LoginType.Id,PrimaryIndicator,TemporaryIndicator,UpdatedBy,UpdatedDateTime
123,"""2000-01-01T00:00:00.000Z""","""string""","""string""","""2000-01-01T00:00:00.000Z""",true,123,123,123,true,"""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,"""string""","""2000-01-01T00:00:00.000Z"""

WorkerQualifications
get put

Create a WorkerQualification.

Usage:
tq post WorkerQualifications
Query:
{"Constituent":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EndDateTime":"2000-01-01T00:00:00.000Z", "Id":123, "Qualification":{"Id":123}, "StartDateTime":"2000-01-01T00:00:00.000Z", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"Constituent.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EndDateTime":"2000-01-01T00:00:00.000Z","Id":123,"Qualification.Id":123,"StartDateTime":"2000-01-01T00:00:00.000Z","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

Constituent.Id,CreateLocation,CreatedBy,CreatedDateTime,EndDateTime,Id,Qualification.Id,StartDateTime,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""2000-01-01T00:00:00.000Z""",123,123,"""2000-01-01T00:00:00.000Z""","""string""","""2000-01-01T00:00:00.000Z"""

WorkerRoles
get put

Create a new worker role.

Usage:
tq post WorkerRoles
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "ShowInPortfolioDefault":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"ShowInPortfolioDefault":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,ShowInPortfolioDefault,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,true,"""string""","""2000-01-01T00:00:00.000Z"""

WorkerTypes
get put

Create a new worker type.

Usage:
tq post WorkerTypes
Query:
{"ControlGroup":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"ControlGroup.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

ControlGroup.Id,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,UpdatedBy,UpdatedDateTime
123,"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,"""string""","""2000-01-01T00:00:00.000Z"""

Workers
get put

Create a new worker.

Usage:
tq post Workers
Query:
{"ConstituentId":123, "ConstituentInactive":{"Id":123}, "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "EditIndicator":true, "FirstName":"string", "Id":123, "Inactive":true, "LastName":"string", "Prefix":{"Id":123}, "ShortDisplayName":"string", "SortName":"string", "Suffix":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "WorkerType":{"Id":123}}

[{"ConstituentId":123,"ConstituentInactive.Id":123,"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","EditIndicator":true,"FirstName":"string","Id":123,"Inactive":true,"LastName":"string","Prefix.Id":123,"ShortDisplayName":"string","SortName":"string","Suffix.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","WorkerType.Id":123}]

ConstituentId,ConstituentInactive.Id,CreateLocation,CreatedBy,CreatedDateTime,EditIndicator,FirstName,Id,Inactive,LastName,Prefix.Id,ShortDisplayName,SortName,Suffix.Id,UpdatedBy,UpdatedDateTime,WorkerType.Id
123,123,"""string""","""string""","""2000-01-01T00:00:00.000Z""",true,"""string""",123,true,"""string""",123,"""string""","""string""",123,"""string""","""2000-01-01T00:00:00.000Z""",123

Z

ZoneGroups
get put

Create a new zone group.

Usage:
tq post ZoneGroups
Query:
{"AliasDescription":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "Rank":123, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"AliasDescription":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"Rank":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

AliasDescription,CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,Rank,UpdatedBy,UpdatedDateTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

ZoneMaps
get put

Create a new zone map.

Usage:
tq post ZoneMaps
Query:
{"CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "Id":123, "Inactive":true, "SeatMap":{"Id":123}, "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z"}

[{"CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","Id":123,"Inactive":true,"SeatMap.Id":123,"UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z"}]

CreateLocation,CreatedBy,CreatedDateTime,Description,Id,Inactive,SeatMap.Id,UpdatedBy,UpdatedDateTime
"""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""",123,true,123,"""string""","""2000-01-01T00:00:00.000Z"""

Zones
get put

Create a new zone.

Usage:
tq post Zones
Query:
{"Abbreviation":"string", "CreateLocation":"string", "CreatedBy":"string", "CreatedDateTime":"2000-01-01T00:00:00.000Z", "Description":"string", "EndTime":"string", "Id":123, "Rank":123, "ShortDescription":"string", "StartTime":"string", "UpdatedBy":"string", "UpdatedDateTime":"2000-01-01T00:00:00.000Z", "ZoneGroup":{"Id":123}, "ZoneLegend":"string", "ZoneMapId":123, "ZoneTime":"string"}

[{"Abbreviation":"string","CreateLocation":"string","CreatedBy":"string","CreatedDateTime":"2000-01-01T00:00:00.000Z","Description":"string","EndTime":"string","Id":123,"Rank":123,"ShortDescription":"string","StartTime":"string","UpdatedBy":"string","UpdatedDateTime":"2000-01-01T00:00:00.000Z","ZoneGroup.Id":123,"ZoneLegend":"string","ZoneMapId":123,"ZoneTime":"string"}]

Abbreviation,CreateLocation,CreatedBy,CreatedDateTime,Description,EndTime,Id,Rank,ShortDescription,StartTime,UpdatedBy,UpdatedDateTime,ZoneGroup.Id,ZoneLegend,ZoneMapId,ZoneTime
"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""","""string""","""string""",123,123,"""string""","""string""","""string""","""2000-01-01T00:00:00.000Z""",123,"""string""",123,"""string"""

Flags:

  • --Search
    Search for products based on a set of criteria.
Query:
{"PackageIds":"string", "PackageTypeIds":"string", "PerformanceIds":"string", "ProductionSeasonIds":"string", "ZoneIds":"string"}

[{"PackageIds":"string","PackageTypeIds":"string","PerformanceIds":"string","ProductionSeasonIds":"string","ZoneIds":"string"}]

PackageIds,PackageTypeIds,PerformanceIds,ProductionSeasonIds,ZoneIds
"""string""","""string""","""string""","""string""","""string"""