Fetch Device Group Information
Http Method: GET
URL Path: /v1/a/{groupPath}
Response Type: application/json
Required Permissions: ViewDeviceGroups
Returns information about a Device Group. The Device Group must belong to the account authenticated by the API key.
Request
Path Parameters
groupPath
The {groupPath}
parameter provides the path identifier of the Device Group being queried. This Device Group must be owned by the account authenticated by the calling API Key.
Response
Return Codes
Code | Description |
---|---|
200 | Success, check the returned body data for the device list |
400 | BadRequest, unable to process the request, check calling path |
403 | Forbidden, the authenticated API key does not have permission to access this resource. Check that the Key is correct and has suitable permissions. |
404 | Not Found, no Device Group can be found with the requested path that is available to the caller. |
500 | Server side error, such as inaccessible database. Please contact Star if this occurs frequently. |
Note
Currently, a 404 will never be returned, a 400 or 403 would occur instead, but it is recommended to handle a 404 as it may be returned in future versions of the API.
Response Body
In case of a successful call, a JSON body will be returned by the service, containing the Device Group information.
Example
{
"Name": "groupName",
"MatchPath": "groupPath",
"AutoCreateDeviceQueue": true,
"Enabled": true,
"RequireDeviceKey": false,
"ContactEMail": "",
"ContactName": "",
"AutoBuzzBeforePrint": 0,
"AutoBuzzAfterPrint": 0,
"Copies": 1,
"AutoClaimBCR": true,
"Owner": "accountName",
"Created": "2021-03-19T11:48:36.1617301"
}
Returns an array of device information objects, each object providing the following fields:
Field | Info |
---|---|
Name | String: Assigned full name of the Device Group |
MatchPath | String: path element used for identifying th Device Group in API calls |
AutoCreateDeviceQueue | Boolean: Indicate that new devices connecting to this devices CloudPRNT endpoint URL will be automatically registered. |
Enabled | Boolean: Global setting to show that the whole Device Group is enabled for use |
RequireDeviceKey | Boolean: Indicate if a per-device key is required to connect a device to this group |
ContactEMail | String: Email address to be contacted in case of issues with this Device Group |
ContactName | String: Name of person to be contacted in case of issues with this Device Group |
AutoBuzzBeforePrint | Number: Default number of times to trigger an external buzzer before printing |
AutoBuzzAfterPrint | Number: Default number of times to trigger an external buzzer after printing |
Copies | Number: Default number of copies to print on devices in this Device Group |
AutoClaimBCR | Boolean: Automatically claim a connected barcode reader to receive barcode scan notifications |
Owner | String: name of the account that owns this device group |
Created | String: UTC Date/Time of the groups creation |
Usage Example
Using curl to retrieve information about a group with a path name of examplegroup
.
curl --header "Star-Api-Key: 6800ffd6-2367-4c8d-b067-d6a28151276a" https://beta.starprinter.online/v1/a/examplegroup