Print Welcome Page
Http Method: PUT
URL Path: /v1/a/{groupPath}/d/{appId}/welcome
Request Body Type: no request body
Response Body Type: no response body
Required Permissions: PrintToDevice
Re-generate the Welcome document for this device, and add it to the print job queue.
Request
Path Parameters
groupPath
The {groupPath} parameter provides the path identifier of the Device Group being accessed. This Device Group must be owned by the account authenticated by the calling API Key.
appId
The {appId} parameter provides the Application Access ID of the device being printed to.
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 re-print the welcome message on a device with Application Access ID e9042f5f from a group with a path name of examplegroup.
curl -X PUT --header "Star-Api-Key: 6800ffd6-2367-4c8d-b067-d6a28151276a" https://beta.starprinter.online/v1/a/examplegroup/d/e9042f5f/welcome