NScanAccessAreas Test
ReferenceData/NScanAccessAreas/{id}?filter={filter}&maintenanceMode={maintenanceMode}
Get the details of an NScan Access Area by id. To get the resource only if the user has write/edit access, pass filter="writeonly".. To get the resource in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/NScanAccessAreas/{id}?filter={filter}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
id integer Y The id of the resource.
filter string N Filter by user access (default: readwrite).
maintenanceMode boolean N Ignore control grouping (default: false).

Request Body

None.
No request body.

Response object type : NScanAccessArea

Response object type NScanAccessArea has the following properties.
Property Name Data Type Length Required Readonly Notes
AreaCode string N
ConstituencyIds string N
ControlGroup ControlGroupSummary N
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
Description string N
EndDateTime date N
Id integer N
Inactive boolean N
KeywordId integer N
KeywordValue string N
ListId integer N
MaxEntries integer N
MembershipLevelIds string N
PerformanceIds string N
PriceTypeIds string N
PriceZoneIds string N
PromptQuantity boolean N
StartDateTime date N
UpdatedBy string N
UpdatedDateTime date N 
{
  "AreaCode": "sample string 1",
  "ConstituencyIds": "sample string 2",
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:19:17.8197811-07:00",
  "CreateLocation": "sample string 3",
  "CreatedBy": "sample string 4",
  "Description": "sample string 5",
  "EndDateTime": "2025-04-24T08:19:17.8197811-07:00",
  "Id": 1,
  "Inactive": true,
  "KeywordId": 1,
  "KeywordValue": "sample string 7",
  "UpdatedDateTime": "2025-04-24T08:19:17.8197811-07:00",
  "UpdatedBy": "sample string 8",
  "ListId": 1,
  "MaxEntries": 1,
  "MembershipLevelIds": "sample string 9",
  "PerformanceIds": "sample string 10",
  "PriceTypeIds": "sample string 11",
  "PriceZoneIds": "sample string 12",
  "PromptQuantity": true,
  "StartDateTime": "2025-04-24T08:19:17.8197811-07:00"
}
<NScanAccessArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AreaCode>sample string 1</AreaCode>
  <ConstituencyIds>sample string 2</ConstituencyIds>
  <ControlGroup>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <Inactive>true</Inactive>
  </ControlGroup>
  <CreateLocation>sample string 3</CreateLocation>
  <CreatedBy>sample string 4</CreatedBy>
  <CreatedDateTime>2025-04-24T08:19:17.8197811-07:00</CreatedDateTime>
  <Description>sample string 5</Description>
  <EndDateTime>2025-04-24T08:19:17.8197811-07:00</EndDateTime>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <KeywordId>1</KeywordId>
  <KeywordValue>sample string 7</KeywordValue>
  <ListId>1</ListId>
  <MaxEntries>1</MaxEntries>
  <MembershipLevelIds>sample string 9</MembershipLevelIds>
  <PerformanceIds>sample string 10</PerformanceIds>
  <PriceTypeIds>sample string 11</PriceTypeIds>
  <PriceZoneIds>sample string 12</PriceZoneIds>
  <PromptQuantity>true</PromptQuantity>
  <StartDateTime>2025-04-24T08:19:17.8197811-07:00</StartDateTime>
  <UpdatedBy>sample string 8</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:19:17.8197811-07:00</UpdatedDateTime>
</NScanAccessArea>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required