GET api/v2/AccessLevels?IncludeDeleted={IncludeDeleted}&AccessLevelType={AccessLevelType}
Returns a list of AccessLevelViewModels that the API token has rights to view
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
IncludeDeleted | boolean |
Default value is False |
|
AccessLevelType | globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of AccessLevelViewModelV2Name | Description | Type | Additional information |
---|---|---|---|
AccessLevelId |
Represents the PK of the AccessLevel |
integer |
None. |
Name |
Represents the name of the AccessLevel |
string |
None. |
AccessLevelStartDate |
Represents AccessLevel starting date |
date |
None. |
AccessLevelEndDate |
Represents AccessLvel ending date |
date |
None. |
Deleted |
Represents whether or not AccessLevel is deleted |
boolean |
None. |
ACSystemId |
Represents PK for an ACSystem this AccessLevel belongs to |
globally unique identifier |
None. |
CompanyId |
Represents PK for Company this AccessLevel belongs to |
globally unique identifier |
None. |
ApplyByDefault |
Indicates whether or not to apply this AccessLevel by default when creating a User |
boolean |
None. |
AccessLevelTypeId |
Represents the type of a given AccessLevel |
globally unique identifier |
None. |
FacilityId |
Represents the ID of the Facility a given Access Level is associated with |
globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-09-18T10:35:29.8904475+00:00", "AccessLevelEndDate": "2025-09-18T10:35:29.8904475+00:00", "Deleted": true, "ACSystemId": "9af9d644-014c-47db-8e73-9dedf10d03f1", "CompanyId": "dda7299b-590a-497f-a2f0-8d369cc95a4d", "ApplyByDefault": true, "AccessLevelTypeId": "041e9085-967f-466e-a102-c87acf5fb45a", "FacilityId": "13fd877d-0790-48c2-913a-92e66fd08fd3" }, { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-09-18T10:35:29.8904475+00:00", "AccessLevelEndDate": "2025-09-18T10:35:29.8904475+00:00", "Deleted": true, "ACSystemId": "9af9d644-014c-47db-8e73-9dedf10d03f1", "CompanyId": "dda7299b-590a-497f-a2f0-8d369cc95a4d", "ApplyByDefault": true, "AccessLevelTypeId": "041e9085-967f-466e-a102-c87acf5fb45a", "FacilityId": "13fd877d-0790-48c2-913a-92e66fd08fd3" } ]
application/xml, text/xml
Sample:
<ArrayOfAccessLevelViewModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <AccessLevelViewModelV2> <ACSystemId>9af9d644-014c-47db-8e73-9dedf10d03f1</ACSystemId> <AccessLevelEndDate>2025-09-18T10:35:29.8904475+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-09-18T10:35:29.8904475+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>dda7299b-590a-497f-a2f0-8d369cc95a4d</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModelV2> <AccessLevelViewModelV2> <ACSystemId>9af9d644-014c-47db-8e73-9dedf10d03f1</ACSystemId> <AccessLevelEndDate>2025-09-18T10:35:29.8904475+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-09-18T10:35:29.8904475+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>dda7299b-590a-497f-a2f0-8d369cc95a4d</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModelV2> </ArrayOfAccessLevelViewModelV2>