GET api/v2/AccessLevelGroups?OccupancyId={OccupancyId}

Returns a list of AccessLevelGroupViewModels for a given Occupancy that the API token has rights to view

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OccupancyId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of AccessLevelGroupViewModelV2
NameDescriptionTypeAdditional information
AccessLevelGroupId

Represents the PK of the AccessLevelGroup

 integer

None.
Name

Represents the name of the AccessLevelGroup

 string

None.
FacilityId

Represents the Id of the Facility this AccessLevelGroup is associated with

 globally unique identifier

None.
FacilityName

Represents the Name of the Facility this AccessLevelGroup is associated with

 string

None.
OccupantId

Represents the Id of the Occupancy this AccessLevelGroup is associated with

 globally unique identifier

None.
OccupantName

Represents the Name of the Occupant this AccessLevelGroup is associated with

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "AccessLevelGroupId": 1,
    "Name": "sample string 2",
    "FacilityId": "a396904e-aad2-4bc2-ba8f-6dc34b23239b",
    "FacilityName": "sample string 3",
    "OccupantId": "a01f4e6a-8377-4f7e-b04d-c3a1e7fe6977",
    "OccupantName": "sample string 4"
  },
  {
    "AccessLevelGroupId": 1,
    "Name": "sample string 2",
    "FacilityId": "a396904e-aad2-4bc2-ba8f-6dc34b23239b",
    "FacilityName": "sample string 3",
    "OccupantId": "a01f4e6a-8377-4f7e-b04d-c3a1e7fe6977",
    "OccupantName": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAccessLevelGroupViewModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <AccessLevelGroupViewModelV2>
    <AccessLevelGroupId>1</AccessLevelGroupId>
    <FacilityId>a396904e-aad2-4bc2-ba8f-6dc34b23239b</FacilityId>
    <FacilityName>sample string 3</FacilityName>
    <Name>sample string 2</Name>
    <OccupantId>a01f4e6a-8377-4f7e-b04d-c3a1e7fe6977</OccupantId>
    <OccupantName>sample string 4</OccupantName>
  </AccessLevelGroupViewModelV2>
  <AccessLevelGroupViewModelV2>
    <AccessLevelGroupId>1</AccessLevelGroupId>
    <FacilityId>a396904e-aad2-4bc2-ba8f-6dc34b23239b</FacilityId>
    <FacilityName>sample string 3</FacilityName>
    <Name>sample string 2</Name>
    <OccupantId>a01f4e6a-8377-4f7e-b04d-c3a1e7fe6977</OccupantId>
    <OccupantName>sample string 4</OccupantName>
  </AccessLevelGroupViewModelV2>
</ArrayOfAccessLevelGroupViewModelV2>