GET api/v2/AccessLevels?CompanyId={CompanyId}&IncludeDeleted={IncludeDeleted}&AccessLevelType={AccessLevelType}
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 |
|
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": "2024-05-05T09:26:26.0282152+00:00", "AccessLevelEndDate": "2024-05-05T09:26:26.0282152+00:00", "Deleted": true, "ACSystemId": "15209905-d85e-4f10-882b-665bd815e573", "CompanyId": "c48b0e0c-2bcc-41e9-b9bf-8995e5ed8230", "ApplyByDefault": true, "AccessLevelTypeId": "8041b58f-4b34-4128-8582-45032a2b38e7", "FacilityId": "024dee8c-0ae1-4362-af76-f036b7da9c0e" }, { "AccessLevelId": 1, "Name": "sample string 2", "AccessLevelStartDate": "2024-05-05T09:26:26.0282152+00:00", "AccessLevelEndDate": "2024-05-05T09:26:26.0282152+00:00", "Deleted": true, "ACSystemId": "15209905-d85e-4f10-882b-665bd815e573", "CompanyId": "c48b0e0c-2bcc-41e9-b9bf-8995e5ed8230", "ApplyByDefault": true, "AccessLevelTypeId": "8041b58f-4b34-4128-8582-45032a2b38e7", "FacilityId": "024dee8c-0ae1-4362-af76-f036b7da9c0e" } ]
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>15209905-d85e-4f10-882b-665bd815e573</ACSystemId> <AccessLevelEndDate>2024-05-05T09:26:26.0282152+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-05-05T09:26:26.0282152+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>c48b0e0c-2bcc-41e9-b9bf-8995e5ed8230</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModelV2> <AccessLevelViewModelV2> <ACSystemId>15209905-d85e-4f10-882b-665bd815e573</ACSystemId> <AccessLevelEndDate>2024-05-05T09:26:26.0282152+00:00</AccessLevelEndDate> <AccessLevelId>1</AccessLevelId> <AccessLevelStartDate>2024-05-05T09:26:26.0282152+00:00</AccessLevelStartDate> <ApplyByDefault>true</ApplyByDefault> <CompanyId>c48b0e0c-2bcc-41e9-b9bf-8995e5ed8230</CompanyId> <Deleted>true</Deleted> <Name>sample string 2</Name> </AccessLevelViewModelV2> </ArrayOfAccessLevelViewModelV2>