GET api/v1/AccessLevels?CompanyId={CompanyId}&IncludeDeleted={IncludeDeleted}
Returns a list of AccessLevelViewModels for a given Company that the API token has rights to view
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId | globally unique identifier |
Required |
|
IncludeDeleted | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of AccessLevelViewModelName | 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-07-26T10:05:25.9336829+00:00", "AccessLevelEndDate": "2025-07-26T10:05:25.9336829+00:00", "Deleted": true, "ACSystemId": "e0238a65-6bb3-4fed-9fcb-dabadc886f52", "CompanyId": "0ae3c369-4e92-4a37-8662-bc1b20673328", "ApplyByDefault": true, "AccessLevelTypeId": "104e7402-4138-46a4-b8e7-b22682f21174", "FacilityId": "edeffa3a-11be-4914-92af-79e25a2b2ed1" }, { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-07-26T10:05:25.9336829+00:00", "AccessLevelEndDate": "2025-07-26T10:05:25.9336829+00:00", "Deleted": true, "ACSystemId": "e0238a65-6bb3-4fed-9fcb-dabadc886f52", "CompanyId": "0ae3c369-4e92-4a37-8662-bc1b20673328", "ApplyByDefault": true, "AccessLevelTypeId": "104e7402-4138-46a4-b8e7-b22682f21174", "FacilityId": "edeffa3a-11be-4914-92af-79e25a2b2ed1" } ]
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>e0238a65-6bb3-4fed-9fcb-dabadc886f52</ACSystemId> <AccessLevelEndDate>2025-07-26T10:05:25.9336829+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-07-26T10:05:25.9336829+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>0ae3c369-4e92-4a37-8662-bc1b20673328</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModel> <AccessLevelViewModel> <ACSystemId>e0238a65-6bb3-4fed-9fcb-dabadc886f52</ACSystemId> <AccessLevelEndDate>2025-07-26T10:05:25.9336829+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-07-26T10:05:25.9336829+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>0ae3c369-4e92-4a37-8662-bc1b20673328</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModel> </ArrayOfAccessLevelViewModel>