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": "2025-12-11T07:06:42.3824087+00:00",
"AccessLevelEndDate": "2025-12-11T07:06:42.3824087+00:00",
"Deleted": true,
"ACSystemId": "19137a94-0367-492b-b932-5369f3abe7a2",
"CompanyId": "80d02ba4-d909-4d1b-a3f2-629ed9826750",
"ApplyByDefault": true,
"AccessLevelTypeId": "3564c94f-2646-434d-81a3-78766e0f740b",
"FacilityId": "dfd0e6bf-c84b-4d81-8a28-edfb6f75ff55"
},
{
"AccessLevelId": 1,
"Name": "sample string 2",
"AccessLevelStartDate": "2025-12-11T07:06:42.3824087+00:00",
"AccessLevelEndDate": "2025-12-11T07:06:42.3824087+00:00",
"Deleted": true,
"ACSystemId": "19137a94-0367-492b-b932-5369f3abe7a2",
"CompanyId": "80d02ba4-d909-4d1b-a3f2-629ed9826750",
"ApplyByDefault": true,
"AccessLevelTypeId": "3564c94f-2646-434d-81a3-78766e0f740b",
"FacilityId": "dfd0e6bf-c84b-4d81-8a28-edfb6f75ff55"
}
]
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>19137a94-0367-492b-b932-5369f3abe7a2</ACSystemId>
<AccessLevelEndDate>2025-12-11T07:06:42.3824087+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-12-11T07:06:42.3824087+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>80d02ba4-d909-4d1b-a3f2-629ed9826750</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModel>
<AccessLevelViewModel>
<ACSystemId>19137a94-0367-492b-b932-5369f3abe7a2</ACSystemId>
<AccessLevelEndDate>2025-12-11T07:06:42.3824087+00:00</AccessLevelEndDate>
<AccessLevelId>1</AccessLevelId>
<AccessLevelStartDate>2025-12-11T07:06:42.3824087+00:00</AccessLevelStartDate>
<ApplyByDefault>true</ApplyByDefault>
<CompanyId>80d02ba4-d909-4d1b-a3f2-629ed9826750</CompanyId>
<Deleted>true</Deleted>
<Name>sample string 2</Name>
</AccessLevelViewModel>
</ArrayOfAccessLevelViewModel>