Important!
The 3D print API is shutting down on January 15, 2017. See our end of life notice for more information.
GET printers¶a>
Lists the printers the currently logged-in member (authorizing 3-legged user) has registered to use.
Resource Information¶
| Method and URI | GET https:/ |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read |
| Data Format | JSON |
Request¶
Headers¶
Name |
Required |
Value Type |
Description |
|---|---|---|---|
| Authorization | yes | string | Must be Bearer <token>, where <token> is obtained via a three- |
Query String Parameters¶
Name |
Required |
Value Type |
Description |
|---|---|---|---|
| limit | no | int | maximum number of printers to return per page
If set to
-1, it will return all printers for a given member. |
| offset | no | int | starting index of the current list of printers |
Response¶
HTTP Status Code Summary¶
Code |
Message |
Meaning |
|---|---|---|
| 200 | OK | Successful |
| 400 | Bad Request | Invalid request. E.g., the request could not be parsed. |
| 401 | Unauthorized | Invalid authorization header. E.g., user is not logged in, or cannot access resource. |
| 404 | Not Found | Endpoint does not exist. |
| 422 | Unprocessable Entity | Semantic errors |
| 429 | Precondition Required | Request rate limit exceeded |
| 500 | Internal Server Error | An unknown error occurred on the server. |
Body Structure (200)¶
A successful response returns a JSON object with the following attributes:
Attribute |
Value Type |
Description |
|---|---|---|
| count | int | the number of printers returned |
| limit | int | maximum number of printers to return |
| offset | int | starting index of the provided list of printers |
| _link_prev | string: URI path and query string | URI for the previous set of results, excluding scheme and hostname |
| _link_next | string: URI path and query string | URI for the next set of results, excluding scheme and hostname |
| _link | string: URI path and query string | URI for the endpoint called, excluding scheme and hostname |
| member_id | string | identifier of the 3-legged end user |
| printers | array: object | the list of printers |
| printers.printer_id | int | identifier of the printer |
| printers.printer_name | string | human-readable name of the printer |
| printers.printer_registered_date | string | date the printer was registered in <month_name> D, YYYY HH:mm:ss
format |
| printers.printer_last_health | string | date the printer last reported its status/health in
<month_name> D, YYYY HH:mm:ss format |
| printers.firmware | string | printer firmware version |
| printers.type_id | string: UUID | printer type identifier, referencing the object detailed in the Field Guide |
| printers.is_primary | bool | whether the member is the primary owner of the printer. The primary owner can send printer-scoped commands to the printer as well as job-scoped commands, and can also register secondary users |
| printers.is_printer_scoped | bool | whether the member can send printer-scoped commmands to the printer (reset the printer, update firmware, stop, and cancel other members’ jobs) |
| printers.is_job_scoped | bool | whether the member can send job-scoped commands to the printer (start, pause, resume, cancel a job) |
Examples¶
Successful Retreival of Registered Printers (200)¶
curl -X 'GET' -H 'Authorization: Bearer tjTVHUJYG2F66EkYZaql2mpjhOzV' -v 'https://developer.api.autodesk.com/ps/v1/print/printers?limit=10'
{
"count": 2,
"limit": 10,
"offset": 0,
"_link_prev": "",
"_link_next": "",
"_link": "/print/printers?limit=10&offset=0",
"member_id": "FPEJMQHAG3NXE",
"printers": [
{
"printer_id": 1469,
"printer_name": "my new printer",
"printer_registered_date": "March 27, 2015 12:22:54",
"printer_last_health": "offline",
"firmware": "1.1.1.1",
"type_id": "7FAF097F-DB2E-45DC-9395-A30210E789AA",
"is_primary": true,
"is_printer_scoped": true,
"is_job_scoped": true
},
{
"printer_id": 1500,
"printer_name": "my friend's printer",
"printer_registered_date": "March 31, 2015 12:22:54",
"printer_last_health": "offline",
"firmware": "1.1.1.1",
"type_id": "7FAF097F-DB2E-45DC-9395-A30210E789AA",
"is_primary": false,
"is_printer_scoped": false,
"is_job_scoped": true
}
]
}
