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 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": "2024-03-29T09:30:15.1526374+00:00", "AccessLevelEndDate": "2024-03-29T09:30:15.1526374+00:00", "Deleted": true, "ACSystemId": "08425715-f103-4f48-85c1-a59aeac7ae62", "CompanyId": "6ca03dc3-b787-4b9b-a108-3c404ecc9a68", "ApplyByDefault": true, "AccessLevelTypeId": "58d3b6a8-d32d-4f0b-9a36-e551a895456a", "FacilityId": "8d5cd4d0-cc99-4dcc-b60c-f26bcdd2fb88" }, { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-03-29T09:30:15.1526374+00:00", "AccessLevelEndDate": "2024-03-29T09:30:15.1526374+00:00", "Deleted": true, "ACSystemId": "08425715-f103-4f48-85c1-a59aeac7ae62", "CompanyId": "6ca03dc3-b787-4b9b-a108-3c404ecc9a68", "ApplyByDefault": true, "AccessLevelTypeId": "58d3b6a8-d32d-4f0b-9a36-e551a895456a", "FacilityId": "8d5cd4d0-cc99-4dcc-b60c-f26bcdd2fb88" } ]
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>08425715-f103-4f48-85c1-a59aeac7ae62</ACSystemId> <AccessLevelEndDate>2024-03-29T09:30:15.1526374+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-03-29T09:30:15.1526374+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>6ca03dc3-b787-4b9b-a108-3c404ecc9a68</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModel> <AccessLevelViewModel> <ACSystemId>08425715-f103-4f48-85c1-a59aeac7ae62</ACSystemId> <AccessLevelEndDate>2024-03-29T09:30:15.1526374+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-03-29T09:30:15.1526374+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>6ca03dc3-b787-4b9b-a108-3c404ecc9a68</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModel> </ArrayOfAccessLevelViewModel>