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-08-20T10:15:04.6281193+00:00",
"AccessLevelEndDate": "2026-08-20T10:15:04.6281193+00:00",
"Deleted": true,
"ACSystemId": "d3bad0b0-640e-4080-9f47-549747a32e86",
"CompanyId": "582c6760-149e-4232-869c-31e51e1f762e",
"ApplyByDefault": true,
"AccessLevelTypeId": "42f2929c-b31f-4e5e-a78c-5aed76c8a758",
"FacilityId": "3241c096-4fe7-4b24-bd17-ea8f81d0d449"
},
{
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2026-08-20T10:15:04.6281193+00:00",
"AccessLevelEndDate": "2026-08-20T10:15:04.6281193+00:00",
"Deleted": true,
"ACSystemId": "d3bad0b0-640e-4080-9f47-549747a32e86",
"CompanyId": "582c6760-149e-4232-869c-31e51e1f762e",
"ApplyByDefault": true,
"AccessLevelTypeId": "42f2929c-b31f-4e5e-a78c-5aed76c8a758",
"FacilityId": "3241c096-4fe7-4b24-bd17-ea8f81d0d449"
}
]
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>d3bad0b0-640e-4080-9f47-549747a32e86</ACSystemId>
<AccessLevelEndDate>2026-08-20T10:15:04.6281193+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-08-20T10:15:04.6281193+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>582c6760-149e-4232-869c-31e51e1f762e</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModelV2>
<AccessLevelViewModelV2>
<ACSystemId>d3bad0b0-640e-4080-9f47-549747a32e86</ACSystemId>
<AccessLevelEndDate>2026-08-20T10:15:04.6281193+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-08-20T10:15:04.6281193+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>582c6760-149e-4232-869c-31e51e1f762e</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModelV2>
</ArrayOfAccessLevelViewModelV2>