Valuekeep Developers - Web API Reference

Settings | Access Levels Assets Party

Overview


URL api/{tenantKey}/{orgKey}/settings/accessLevelsAssetsParties
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Access Levels Parties

Custom operation 'GetAccessLevelsParties'.

The following elements are required:

modifiedOn (DateTimeOffset) ModifiedOn.
maxRecords (int) MaxRecords.
company (string) Company.

Response:

When successful, the response body contains a list of resources of type 'PartiesAccessLevels'. See PartiesAccessLevels.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /settings/accessLevelsAssetsParties/getAccessLevelsParties

GET Get Access Levels Equipment Items

Custom operation 'GetAccessLevelsEquipmentItems'.

The following elements are required:

isTool (bool) IsTool.
modifiedOn (DateTimeOffset) ModifiedOn.
maxRecords (int) MaxRecords.
company (string) Company.

Response:

When successful, the response body contains a list of resources of type 'EquipmentItemsAccessLevels'. See EquipmentItemsAccessLevels.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /settings/accessLevelsAssetsParties/getAccessLevelsEquipmentItems

GET Get Access Levels Locations

Custom operation 'GetAccessLevelsLocations'.

The following elements are required:

modifiedOn (DateTimeOffset) ModifiedOn.
maxRecords (int) MaxRecords.
company (string) Company.

Response:

When successful, the response body contains a list of resources of type 'LocationsAccessLevels'. See LocationsAccessLevels.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /settings/accessLevelsAssetsParties/getAccessLevelsLocations

GET Get Access Levels

Custom operation 'GetAccessLevels'.

The following elements are required:

modifiedOn (DateTimeOffset) ModifiedOn.
maxRecords (int) MaxRecords.
company (string) Company.

Response:

When successful, the response body contains a list of resources of type 'AccessLevelsByCompany'. See AccessLevelsByCompany.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /settings/accessLevelsAssetsParties/getAccessLevels

Resources


AccessLevelsByCompany

The following elements are optional:

id (Guid) Id.
accessLevelKey (string) Access Level Key.
description (string) Description.
isDefault (bool) Is Default.
modifiedOn (DateTimeOffset) Modified On.
version (string) Version.


EquipmentItemsAccessLevels

The following elements are optional:

id (Guid) Id.
accessLevelKey (string) Access Level Key.
equipmentItemKey (string) Equipment Item Key.
isTool (bool) Is Tool.
modifiedOn (DateTimeOffset) Modified On.
version (string) Version.


LocationsAccessLevels

The following elements are optional:

id (Guid) Id.
accessLevelKey (string) Access Level Key.
locationKey (string) Location Key.
modifiedOn (DateTimeOffset) Modified On.
version (string) Version.


PartiesAccessLevels

The following elements are optional:

id (Guid) Id.
accessLevelKey (string) Access Level Key.
partyKey (string) Party Key.
modifiedOn (DateTimeOffset) Modified On.
version (string) Version.