Facilities Test
TXN/Facilities/{facilityId}/Screens
Returns details of all screens and the HouseMap for the facility. The screen details include which other screens are assigned to each screen navigation arrow button.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/Facilities/{facilityId}/Screens

URI Parameters

Parameter Name Data Type Required Notes
facilityId integer N

Request Body

None.
No request body.

Response object type : ScreenMap

Response object type ScreenMap has the following properties.
Property Name Data Type Length Required Readonly Notes
Description string
Id integer
Screens Collection of Screen 
{
  "Id": 1,
  "Description": "sample string 2",
  "Screens": [
    {
      "Id": 1,
      "Description": "sample string 2",
      "RowCount": 3,
      "ColumnCount": 4,
      "ScreenUp": 5,
      "ScreenDown": 6,
      "ScreenLeft": 7,
      "ScreenRight": 8,
      "HouseMapRectangles": [
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        },
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        }
      ]
    },
    {
      "Id": 1,
      "Description": "sample string 2",
      "RowCount": 3,
      "ColumnCount": 4,
      "ScreenUp": 5,
      "ScreenDown": 6,
      "ScreenLeft": 7,
      "ScreenRight": 8,
      "HouseMapRectangles": [
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        },
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        }
      ]
    }
  ]
}
<ScreenMap xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Description>sample string 2</Description>
  <Id>1</Id>
  <Screens>
    <Screen>
      <ColumnCount>4</ColumnCount>
      <Description>sample string 2</Description>
      <HouseMapRectangles>
        <HouseMapRectangle>
          <BrushColor>5</BrushColor>
          <Height>3</Height>
          <PenColor>6</PenColor>
          <TextColor>7</TextColor>
          <TextText>sample string 10</TextText>
          <TextXCoordinate>8</TextXCoordinate>
          <TextYCoordinate>9</TextYCoordinate>
          <Width>4</Width>
          <XCoordinate>1</XCoordinate>
          <YCoordinate>2</YCoordinate>
        </HouseMapRectangle>
        <HouseMapRectangle>
          <BrushColor>5</BrushColor>
          <Height>3</Height>
          <PenColor>6</PenColor>
          <TextColor>7</TextColor>
          <TextText>sample string 10</TextText>
          <TextXCoordinate>8</TextXCoordinate>
          <TextYCoordinate>9</TextYCoordinate>
          <Width>4</Width>
          <XCoordinate>1</XCoordinate>
          <YCoordinate>2</YCoordinate>
        </HouseMapRectangle>
      </HouseMapRectangles>
      <Id>1</Id>
      <RowCount>3</RowCount>
      <ScreenDown>6</ScreenDown>
      <ScreenLeft>7</ScreenLeft>
      <ScreenRight>8</ScreenRight>
      <ScreenUp>5</ScreenUp>
    </Screen>
    <Screen>
      <ColumnCount>4</ColumnCount>
      <Description>sample string 2</Description>
      <HouseMapRectangles>
        <HouseMapRectangle>
          <BrushColor>5</BrushColor>
          <Height>3</Height>
          <PenColor>6</PenColor>
          <TextColor>7</TextColor>
          <TextText>sample string 10</TextText>
          <TextXCoordinate>8</TextXCoordinate>
          <TextYCoordinate>9</TextYCoordinate>
          <Width>4</Width>
          <XCoordinate>1</XCoordinate>
          <YCoordinate>2</YCoordinate>
        </HouseMapRectangle>
        <HouseMapRectangle>
          <BrushColor>5</BrushColor>
          <Height>3</Height>
          <PenColor>6</PenColor>
          <TextColor>7</TextColor>
          <TextText>sample string 10</TextText>
          <TextXCoordinate>8</TextXCoordinate>
          <TextYCoordinate>9</TextYCoordinate>
          <Width>4</Width>
          <XCoordinate>1</XCoordinate>
          <YCoordinate>2</YCoordinate>
        </HouseMapRectangle>
      </HouseMapRectangles>
      <Id>1</Id>
      <RowCount>3</RowCount>
      <ScreenDown>6</ScreenDown>
      <ScreenLeft>7</ScreenLeft>
      <ScreenRight>8</ScreenRight>
      <ScreenUp>5</ScreenUp>
    </Screen>
  </Screens>
</ScreenMap>

No entries in change log for this operation.