GET api/v1/AccessLevels?ACSystemId={ACSystemId}&IncludeDeleted={IncludeDeleted}
Returns a list of AccessLevelViewModels for a given ACSystem that the API token has rights to view
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ACSystemId | globally unique identifier |
Required |
|
| 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-08-01T14:48:22.5489092+00:00",
"AccessLevelEndDate": "2026-08-01T14:48:22.5489092+00:00",
"Deleted": true,
"ACSystemId": "b28e64cd-90be-464c-bf94-eef9530b5da8",
"CompanyId": "9316a3f2-bbb4-44bf-92d7-d0bde841a536",
"ApplyByDefault": true,
"AccessLevelTypeId": "7961ed37-e91b-4218-bec6-a9e755f103f0",
"FacilityId": "c3476a77-549f-4cc1-9cb7-4323945c7d27"
},
{
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2026-08-01T14:48:22.5489092+00:00",
"AccessLevelEndDate": "2026-08-01T14:48:22.5489092+00:00",
"Deleted": true,
"ACSystemId": "b28e64cd-90be-464c-bf94-eef9530b5da8",
"CompanyId": "9316a3f2-bbb4-44bf-92d7-d0bde841a536",
"ApplyByDefault": true,
"AccessLevelTypeId": "7961ed37-e91b-4218-bec6-a9e755f103f0",
"FacilityId": "c3476a77-549f-4cc1-9cb7-4323945c7d27"
}
]
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>b28e64cd-90be-464c-bf94-eef9530b5da8</ACSystemId>
<AccessLevelEndDate>2026-08-01T14:48:22.5489092+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-08-01T14:48:22.5489092+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>9316a3f2-bbb4-44bf-92d7-d0bde841a536</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModel>
<AccessLevelViewModel>
<ACSystemId>b28e64cd-90be-464c-bf94-eef9530b5da8</ACSystemId>
<AccessLevelEndDate>2026-08-01T14:48:22.5489092+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2026-08-01T14:48:22.5489092+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>9316a3f2-bbb4-44bf-92d7-d0bde841a536</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModel>
</ArrayOfAccessLevelViewModel>