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 AccessLevelViewModelV2| Name | 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": "2026-02-10T08:38:20.058273+00:00",
"AccessLevelEndDate": "2026-02-10T08:38:20.058273+00:00",
"Deleted": true,
"ACSystemId": "1fd5841b-ab66-42d8-9667-b9a510153b8b",
"CompanyId": "6e5678ee-930c-4416-ac66-a24abf0d4afc",
"ApplyByDefault": true,
"AccessLevelTypeId": "98f34e17-a472-46c8-84df-892f93db53b2",
"FacilityId": "80b744f2-0f56-4ac3-a94a-ee8d3b726dc1"
},
{
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2026-02-10T08:38:20.058273+00:00",
"AccessLevelEndDate": "2026-02-10T08:38:20.058273+00:00",
"Deleted": true,
"ACSystemId": "1fd5841b-ab66-42d8-9667-b9a510153b8b",
"CompanyId": "6e5678ee-930c-4416-ac66-a24abf0d4afc",
"ApplyByDefault": true,
"AccessLevelTypeId": "98f34e17-a472-46c8-84df-892f93db53b2",
"FacilityId": "80b744f2-0f56-4ac3-a94a-ee8d3b726dc1"
}
]
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>1fd5841b-ab66-42d8-9667-b9a510153b8b</ACSystemId>
<AccessLevelEndDate>2026-02-10T08:38:20.058273+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-02-10T08:38:20.058273+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>6e5678ee-930c-4416-ac66-a24abf0d4afc</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModelV2>
<AccessLevelViewModelV2>
<ACSystemId>1fd5841b-ab66-42d8-9667-b9a510153b8b</ACSystemId>
<AccessLevelEndDate>2026-02-10T08:38:20.058273+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-02-10T08:38:20.058273+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>6e5678ee-930c-4416-ac66-a24abf0d4afc</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModelV2>
</ArrayOfAccessLevelViewModelV2>