diff --git a/source/includes/_custom_fields.md b/source/includes/_custom_fields.md index 6e82e326518..d63e5cbb066 100644 --- a/source/includes/_custom_fields.md +++ b/source/includes/_custom_fields.md @@ -10,6 +10,10 @@ Custom Fields allow you to add your own data-fields inside SimplyPrint. ## List custom fields + + `POST /{id}/custom_fields/Get` > Example request @@ -87,6 +91,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/Get \ ## Create or update a custom field + + `POST /{id}/custom_fields/Save` > Example request @@ -139,6 +147,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/Save \ ## Enable or disable a custom field + + `POST /{id}/custom_fields/SetEnabled` > Example request @@ -176,6 +188,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/SetEnabled \ ## Delete custom fields + + `GET /{id}/custom_fields/Delete` > Example request @@ -219,6 +235,10 @@ curl https://api.simplyprint.io/{id}custom_fields/Delete?ids=123,124,125 \ ## Custom field submission + + `POST /{id}/custom_fields/SubmitValues` > Example request @@ -251,6 +271,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/SubmitValues \ ## Custom field submission value + + The value of a custom field when submitted via the API is an object with a key corresponding to the field type. See the examples to the right for the different field types. diff --git a/source/includes/_printers.md b/source/includes/_printers.md index cbd6c832931..b2f07f30d9c 100644 --- a/source/includes/_printers.md +++ b/source/includes/_printers.md @@ -606,6 +606,10 @@ you want to change the printer that is connected to a pi. ## List one-click printers + + ```shell curl https://api.simplyprint.io/{id}/printers/OneClickPrint?pIds=1234,1235 \ -H 'accept: application/json' \ @@ -659,7 +663,7 @@ curl https://api.simplyprint.io/{id}/printers/OneClickPrint?pIds=1234,1235 \ ## AutoPrint enable / disable ```shell @@ -698,10 +702,14 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/SetEnabled \ ## AutoPrint check state + + ```shell curl https://api.simplyprint.io/{id}/printers/autoprint/CheckState \ -H 'accept: application/json' \ - -H 'X-API-KEY: {API_KEY}' \ + -H 'X-API-KEY: {API_KEY}' ``` > Success response @@ -741,6 +749,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/CheckState \ ## AutoPrint get settings + + ```shell curl https://api.simplyprint.io/{id}/printers/autoprint/GetAutoPrintSettings \ -H 'accept: application/json' \ @@ -787,6 +799,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/GetAutoPrintSettings \ ## AutoPrint save settings + + ```shell curl https://api.simplyprint.io/{id}/printers/autoprint/SaveAutoPrintSettings \ -X POST \ @@ -836,6 +852,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/SaveAutoPrintSettings \ ## AutoPrint get gcode templates + + ```shell curl https://api.simplyprint.io/{id}/printers/autoprint/GetGcodeTemplates \ -H 'accept: application/json' \ @@ -887,6 +907,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/GetGcodeTemplates \ ## AutoPrint set cleared beds amount + + ```shell curl https://api.simplyprint.io/{id}/printers/autoprint/SetClearedBedsAmount \ -X POST \ diff --git a/source/includes/_queue.md b/source/includes/_queue.md index 4ebcbc53872..6c2e4587259 100644 --- a/source/includes/_queue.md +++ b/source/includes/_queue.md @@ -691,6 +691,10 @@ This endpoint empties the queue. ## Revive item + + ```shell curl https://api.simplyprint.io/{id}/queue/ReviveItem?job=1234 \ -H 'accept: application/json' \ diff --git a/source/includes/_schools.md b/source/includes/_schools.md index dc886279118..22103fa6d49 100644 --- a/source/includes/_schools.md +++ b/source/includes/_schools.md @@ -2,6 +2,10 @@ ## List classes + + `GET /{id}/account/settings/school/classes/GetClasses` > Example request @@ -75,6 +79,10 @@ curl https://api.simplyprint.io/{id}/account/settings/school/classes/GetClasses ## Create or update a class + + `POST /{id}/account/settings/school/classes/SaveClass` > Example Request diff --git a/source/includes/_users.md b/source/includes/_users.md index 244418dc76a..e259b0b7850 100644 --- a/source/includes/_users.md +++ b/source/includes/_users.md @@ -43,7 +43,10 @@ curl https://api.simplyprint.io/{id}/users/GetPaginatedUsers \ "total_prints": 68, "rank": 185, "teacher": false, - "classes": [1234, 5678] + "classes": [ + 1234, + 5678 + ] } ], "page_amount": 1 @@ -357,6 +360,10 @@ This endpoint deletes a user from the company. Use this endpoint with caution. ## Set Teacher + + `POST /{id}/users/SetIsTeacher` > Example request diff --git a/source/includes/_webhooks.md b/source/includes/_webhooks.md index 4cc8b2bb124..fca95a22908 100644 --- a/source/includes/_webhooks.md +++ b/source/includes/_webhooks.md @@ -9,6 +9,10 @@ When one of those events is triggered, we'll send an HTTP POST payload to the we ## List webhooks + + `GET /{id}/webhooks/Get` > Example request @@ -65,6 +69,10 @@ curl "https://api.simplyprint.io/{id}/webhooks/Get" \ ## Create or update a webhook + + `POST /{id}/webhooks/Create` > Example request @@ -123,6 +131,10 @@ https://api.simplyprint.io/{id}/webhooks/Create \ ## Delete a webhook + + `POST /{id}/webhooks/Delete` > Example request @@ -160,6 +172,10 @@ https://api.simplyprint.io/{id}/webhooks/Delete \ ## Enable or disable a webhook + + `POST /{id}/webhooks/SetEnabled` > Example request @@ -198,6 +214,10 @@ https://api.simplyprint.io/{id}/webhooks/SetEnabled \ ## Manually trigger webhook + + The event type will be `test`. `POST /{id}/webhooks/TriggerTestWebhook`