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-04-21T00:33:55.906159+00:00",
"AccessLevelEndDate": "2026-04-21T00:33:55.906159+00:00",
"Deleted": true,
"ACSystemId": "2001252b-9f3d-49fb-952f-595c4a326684",
"CompanyId": "31b0b21e-0a9c-4130-9339-28b1f7e55b19",
"ApplyByDefault": true,
"AccessLevelTypeId": "06dab722-1d27-44cb-8824-9ea69ebcbcd4",
"FacilityId": "b3424c39-8512-4813-9979-9e5f169d37af"
},
{
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2026-04-21T00:33:55.906159+00:00",
"AccessLevelEndDate": "2026-04-21T00:33:55.906159+00:00",
"Deleted": true,
"ACSystemId": "2001252b-9f3d-49fb-952f-595c4a326684",
"CompanyId": "31b0b21e-0a9c-4130-9339-28b1f7e55b19",
"ApplyByDefault": true,
"AccessLevelTypeId": "06dab722-1d27-44cb-8824-9ea69ebcbcd4",
"FacilityId": "b3424c39-8512-4813-9979-9e5f169d37af"
}
]
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>2001252b-9f3d-49fb-952f-595c4a326684</ACSystemId>
<AccessLevelEndDate>2026-04-21T00:33:55.906159+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-04-21T00:33:55.906159+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>31b0b21e-0a9c-4130-9339-28b1f7e55b19</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModelV2>
<AccessLevelViewModelV2>
<ACSystemId>2001252b-9f3d-49fb-952f-595c4a326684</ACSystemId>
<AccessLevelEndDate>2026-04-21T00:33:55.906159+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-04-21T00:33:55.906159+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>31b0b21e-0a9c-4130-9339-28b1f7e55b19</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModelV2>
</ArrayOfAccessLevelViewModelV2>