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 AccessLevelViewModelV2Name | 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": "2025-05-09T17:24:20.0235919+00:00", "AccessLevelEndDate": "2025-05-09T17:24:20.0235919+00:00", "Deleted": true, "ACSystemId": "505b51be-e0c0-4d02-8836-7747b7752465", "CompanyId": "cfa5f054-3693-4bb7-bd79-457ba88cac49", "ApplyByDefault": true, "AccessLevelTypeId": "46f4bd52-1d44-4eb9-947a-6ac67a276f81", "FacilityId": "68694da3-a815-473e-ac2a-6e5038dd93f7" }, { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2025-05-09T17:24:20.0235919+00:00", "AccessLevelEndDate": "2025-05-09T17:24:20.0235919+00:00", "Deleted": true, "ACSystemId": "505b51be-e0c0-4d02-8836-7747b7752465", "CompanyId": "cfa5f054-3693-4bb7-bd79-457ba88cac49", "ApplyByDefault": true, "AccessLevelTypeId": "46f4bd52-1d44-4eb9-947a-6ac67a276f81", "FacilityId": "68694da3-a815-473e-ac2a-6e5038dd93f7" } ]
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>505b51be-e0c0-4d02-8836-7747b7752465</ACSystemId> <AccessLevelEndDate>2025-05-09T17:24:20.0235919+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-05-09T17:24:20.0235919+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>cfa5f054-3693-4bb7-bd79-457ba88cac49</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModelV2> <AccessLevelViewModelV2> <ACSystemId>505b51be-e0c0-4d02-8836-7747b7752465</ACSystemId> <AccessLevelEndDate>2025-05-09T17:24:20.0235919+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2025-05-09T17:24:20.0235919+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>cfa5f054-3693-4bb7-bd79-457ba88cac49</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModelV2> </ArrayOfAccessLevelViewModelV2>