HoldCodeUserGroups Test
TXN/HoldCodeUserGroups/Summary?userGroup={userGroup}&holdCode={holdCode}
Get a summary representation of all hold code/user group mappings. Optional filter for a UserGroup or HoldCode.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/HoldCodeUserGroups/Summary?userGroup={userGroup}&holdCode={holdCode}

URI Parameters

Parameter Name Data Type Required Notes
userGroup string N
holdCode integer N

Request Body

None.

No request body.

Response object type : Collection of HoldCodeUserGroupSummary

Response object type Collection of HoldCodeUserGroupSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
HoldCode HoldCodeSummary N
FK: T_HC.hc_no
Id integer N
UserGroupId string N
[
  {
    "Id": 1,
    "HoldCode": {
      "BlackoutIndicator": true,
      "Description": "sample string 2",
      "Legend": "sample string 3",
      "Id": 1
    },
    "UserGroupId": "sample string 1"
  },
  {
    "Id": 1,
    "HoldCode": {
      "BlackoutIndicator": true,
      "Description": "sample string 2",
      "Legend": "sample string 3",
      "Id": 1
    },
    "UserGroupId": "sample string 1"
  }
]
<HoldCodeUserGroupSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HoldCodeUserGroup>
    <HoldCode>
      <BlackoutIndicator>true</BlackoutIndicator>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <Legend>sample string 3</Legend>
    </HoldCode>
    <Id>1</Id>
    <UserGroupId>sample string 1</UserGroupId>
  </HoldCodeUserGroup>
  <HoldCodeUserGroup>
    <HoldCode>
      <BlackoutIndicator>true</BlackoutIndicator>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <Legend>sample string 3</Legend>
    </HoldCode>
    <Id>1</Id>
    <UserGroupId>sample string 1</UserGroupId>
  </HoldCodeUserGroup>
</HoldCodeUserGroupSummaries>

No entries in change log for this operation.