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 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-29T11:34:06.3262013+00:00", "AccessLevelEndDate": "2024-03-29T11:34:06.3262013+00:00", "Deleted": true, "ACSystemId": "d01f6506-b620-491c-97e7-1326580c9088", "CompanyId": "4f870ec5-3817-4fa7-891e-7994254b664b", "ApplyByDefault": true, "AccessLevelTypeId": "8c129eeb-7270-4da2-85fc-d31c10faf3c8", "FacilityId": "7e016a6b-9255-48f6-acfe-9e43944d7d17" }, { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-03-29T11:34:06.3262013+00:00", "AccessLevelEndDate": "2024-03-29T11:34:06.3262013+00:00", "Deleted": true, "ACSystemId": "d01f6506-b620-491c-97e7-1326580c9088", "CompanyId": "4f870ec5-3817-4fa7-891e-7994254b664b", "ApplyByDefault": true, "AccessLevelTypeId": "8c129eeb-7270-4da2-85fc-d31c10faf3c8", "FacilityId": "7e016a6b-9255-48f6-acfe-9e43944d7d17" } ]
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>d01f6506-b620-491c-97e7-1326580c9088</ACSystemId> <AccessLevelEndDate>2024-03-29T11:34:06.3262013+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-03-29T11:34:06.3262013+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>4f870ec5-3817-4fa7-891e-7994254b664b</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModel> <AccessLevelViewModel> <ACSystemId>d01f6506-b620-491c-97e7-1326580c9088</ACSystemId> <AccessLevelEndDate>2024-03-29T11:34:06.3262013+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-03-29T11:34:06.3262013+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>4f870ec5-3817-4fa7-891e-7994254b664b</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModel> </ArrayOfAccessLevelViewModel>