Update a Device Group
Http Method: PUT
URL Path: /v1/a/{groupPath}
Request Body Type: application/json
Response Body Type: no response body
Required Permissions: ModifyDeviceGroup
Modify the settings of 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.
Request Body
{
"AutoCreateDeviceQueue": Boolean/null,
"ContactEMail": String/null,
"ContactName": String/null,
"AutoBuzzBeforePrint": Number/null,
"AutoBuzzAfterPrint": Number/null,
"Copies": Number/null,
"AutoClaimBCR": Boolean/null
}
All fields should be omitted or set to null if no change is required to that setting.
| Field | Info |
|---|---|
| AutoCreateDeviceQueue | Boolean: Enable/disable automatic device registration for this Device Group |
| ContactEMail | String: Specify the email address to be contacted in case of issues with this Device Group |
| ContactName | Specify the Name of the person to be contacted in cas of issues with this Device Group |
| AutoBuzzBeforePrint | Number: Specify the default number of times to trigger and external audio buzzer before printing. A value from 0 to 3 can be provided. |
| AutoBuzzAfterPrint | Number: Specify the default number of times to trigger and external audio buzzer after printing. A value from 0 to 3 can be provided. |
| Copies | Number: Specify the default number of copies to print. An integer value from 1 to 10 can be provided. |
| AutoClaimBCR | Boolean: Enable automatic claiming of barcode reader on devices connected to this Device Group. Necessary for receiving barcode scan notifications. |
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 within the specified device group and owned by the authenticated account can be found. |
| 500 | Server side error, such as inaccessible database. Please contact Star if this occurs frequently. |
Usage Example
An example, using curl to change the default number of print job copies to 2 for devices connected to a Device Group with a path name of examplegroup.
curl -X PUT -d'{"Copies" : 2}' --header "Star-Api-Key: 6800ffd6-2367-4c8d-b067-d6a28151276a" https://beta.starprinter.online/v1/a/examplegroup