GET api/v1/AccessLevels?IncludeDeleted={IncludeDeleted}
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 |
Body Parameters
None.
Response Information
Resource Description
Collection of AccessLevelViewModel| 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 AccessLvel 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-01-18T13:36:48.4738897+00:00",
"AccessLevelEndDate": "2026-01-18T13:36:48.4738897+00:00",
"Deleted": true,
"ACSystemId": "d1d92d23-cf18-42f4-9e95-835cdcc2f363",
"CompanyId": "0e7138f1-cf81-4fa3-94c3-191eac0de854",
"ApplyByDefault": true,
"AccessLevelTypeId": "d5b60fc6-b100-41f2-be78-f4ef59076f6e",
"FacilityId": "1f960123-062c-40fc-af8c-47149cbd46ce"
},
{
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2026-01-18T13:36:48.4738897+00:00",
"AccessLevelEndDate": "2026-01-18T13:36:48.4738897+00:00",
"Deleted": true,
"ACSystemId": "d1d92d23-cf18-42f4-9e95-835cdcc2f363",
"CompanyId": "0e7138f1-cf81-4fa3-94c3-191eac0de854",
"ApplyByDefault": true,
"AccessLevelTypeId": "d5b60fc6-b100-41f2-be78-f4ef59076f6e",
"FacilityId": "1f960123-062c-40fc-af8c-47149cbd46ce"
}
]
application/xml, text/xml
Sample:
<ArrayOfAccessLevelViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<AccessLevelViewModel>
<ACSystemId>d1d92d23-cf18-42f4-9e95-835cdcc2f363</ACSystemId>
<AccessLevelEndDate>2026-01-18T13:36:48.4738897+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-01-18T13:36:48.4738897+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>0e7138f1-cf81-4fa3-94c3-191eac0de854</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModel>
<AccessLevelViewModel>
<ACSystemId>d1d92d23-cf18-42f4-9e95-835cdcc2f363</ACSystemId>
<AccessLevelEndDate>2026-01-18T13:36:48.4738897+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-01-18T13:36:48.4738897+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>0e7138f1-cf81-4fa3-94c3-191eac0de854</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModel>
</ArrayOfAccessLevelViewModel>