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 AccessLevelViewModel

Name	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-06-01T02:01:57.831434+00:00",
    "AccessLevelEndDate": "2025-06-01T02:01:57.831434+00:00",
    "Deleted": true,
    "ACSystemId": "58bb15c1-1795-4cd2-9ba4-b0c30a37f27e",
    "CompanyId": "c3c4e116-ba4a-4c23-af0d-182f8b77c1ea",
    "ApplyByDefault": true,
    "AccessLevelTypeId": "5a13e40d-c705-47ee-ba36-d7bdbb665e7d",
    "FacilityId": "5a884781-a64b-4b2a-ab69-d24b238c2f6c"
  },
  {
    "AccessLevelId": 1,
    "Name": "sample string 2",
    "AccessLevelStartDate": "2025-06-01T02:01:57.831434+00:00",
    "AccessLevelEndDate": "2025-06-01T02:01:57.831434+00:00",
    "Deleted": true,
    "ACSystemId": "58bb15c1-1795-4cd2-9ba4-b0c30a37f27e",
    "CompanyId": "c3c4e116-ba4a-4c23-af0d-182f8b77c1ea",
    "ApplyByDefault": true,
    "AccessLevelTypeId": "5a13e40d-c705-47ee-ba36-d7bdbb665e7d",
    "FacilityId": "5a884781-a64b-4b2a-ab69-d24b238c2f6c"
  }
]

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>58bb15c1-1795-4cd2-9ba4-b0c30a37f27e</ACSystemId>
    <AccessLevelEndDate>2025-06-01T02:01:57.831434+00:00</AccessLevelEndDate>
    <AccessLevelId>1</AccessLevelId>
    <AccessLevelStartDate>2025-06-01T02:01:57.831434+00:00</AccessLevelStartDate>
    <ApplyByDefault>true</ApplyByDefault>
    <CompanyId>c3c4e116-ba4a-4c23-af0d-182f8b77c1ea</CompanyId>
    <Deleted>true</Deleted>
    <Name>sample string 2</Name>
  </AccessLevelViewModel>
  <AccessLevelViewModel>
    <ACSystemId>58bb15c1-1795-4cd2-9ba4-b0c30a37f27e</ACSystemId>
    <AccessLevelEndDate>2025-06-01T02:01:57.831434+00:00</AccessLevelEndDate>
    <AccessLevelId>1</AccessLevelId>
    <AccessLevelStartDate>2025-06-01T02:01:57.831434+00:00</AccessLevelStartDate>
    <ApplyByDefault>true</ApplyByDefault>
    <CompanyId>c3c4e116-ba4a-4c23-af0d-182f8b77c1ea</CompanyId>
    <Deleted>true</Deleted>
    <Name>sample string 2</Name>
  </AccessLevelViewModel>
</ArrayOfAccessLevelViewModel>