Skip to content

Commit 1af9ace

Browse files
dnorhojdnorhoj
committed
Merge branch 'dev'
2 parents 8a63f1c + 8cba6ce commit 1af9ace

File tree

4 files changed

+17
-139
lines changed

4 files changed

+17
-139
lines changed

‎source/includes/_account.md‎

Lines changed: 14 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,5 @@
11
# Account
22

3-
## Save autoqueue defaults
4-
5-
```shell
6-
curl https://api.simplyprint.io/{id}/account/SaveAutoQueueDefaults \
7-
-X POST \
8-
-H 'accept: application/json' \
9-
-H 'X-API-KEY: {API_KEY}'
10-
```
11-
12-
> Request body
13-
14-
```json
15-
{
16-
"gcodeAnalysis": true,
17-
"fit": true,
18-
"printerTemps": true,
19-
"filament": true,
20-
"filamentTemps": true
21-
}
22-
```
23-
24-
> Success response
25-
26-
```json
27-
{
28-
"status": true,
29-
"message": null
30-
}
31-
```
32-
33-
<aside class="notice">
34-
This endpoint requires the <b>Print Farm</b> plan.
35-
</aside>
36-
37-
| Required permissions |
38-
| -------------------- |
39-
| `PRINTER_SETTINGS` |
40-
41-
This endpoint saves the auto queue settings for the company.
42-
43-
To restore the default settings, send an empty request body to `POST /{id}/account/SaveAutoQueueDefaults?default=true`.
44-
45-
### Request
46-
47-
`POST /{id}/account/SaveAutoQueueDefaults`
48-
49-
| Parameter | Type | Required | Description |
50-
| --------- | ---- | -------- | ----------- |
51-
| `gcodeAnalysis` | boolean | yes | Whether to only allow gcode files that have been analysed. |
52-
| `fit` | boolean | yes | If true, the model will be scaled to fit the build volume. |
53-
| `printerTemps` | boolean | yes | If true, the printer temperatures will be set. |
54-
| `filament` | boolean | yes | If true, the filament will be set. |
55-
| `filamentTemps` | boolean | yes | If true, the filament temperatures will be set. |
56-
57-
### Response
58-
59-
| Parameter | Type | Description |
60-
| --------- | ---- | ----------- |
61-
| `status` | boolean | True if the request was successful. |
62-
| `message` | string | Error message if `status` is false. |
63-
643
## Create company groups
654

665
```shell
@@ -76,10 +15,8 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Create \
7615
{
7716
"ranks": [
7817
{
79-
"title": "name of group in danish/default",
80-
"title_en": "name of group in english",
81-
"description": "group description in danish/default",
82-
"description_en": "group description in english",
18+
"title": "name of group",
19+
"description": "group description",
8320
"sort_order": 3,
8421
"permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}"
8522
}
@@ -95,10 +32,8 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Create \
9532
"message": null,
9633
"data": [
9734
{
98-
"title": "name of group in danish/default",
99-
"title_en": "name of group in english",
100-
"description": "group description in danish/default",
101-
"description_en": "group description in english",
35+
"title": "name of group",
36+
"description": "group description",
10237
"company_id": 2,
10338
"company_type": 2,
10439
"sort_order": 3,
@@ -126,10 +61,8 @@ This endpoint creates a new group in the company.
12661
| Parameter | Type | Required | Description |
12762
| --------- | ---- | -------- | ----------- |
12863
| `ranks` | array | yes | Array of groups to create. |
129-
| `ranks[].title` | string | yes | The name of the group in danish or the name of the group if `title_en` is not set. |
130-
| `ranks[].title_en` | string | no | The name of the group in english. |
131-
| `ranks[].description` | string | no | The description of the group in danish or the description of the group if `description_en` is not set. |
132-
| `ranks[].description_en` | string | no | The description of the group in english. |
64+
| `ranks[].title` | string | yes | The name of the group. |
65+
| `ranks[].description` | string | no | The description of the group. |
13366
| `ranks[].sort_order` | integer | yes | The sort index of the group. |
13467
| `ranks[].permissions` | string | yes | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). |
13568

@@ -157,10 +90,8 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Update \
15790
"ranks": [
15891
{
15992
"id": 319,
160-
"title": "name of group in danish/default",
161-
"title_en": "name of group in english",
162-
"description": "group description in danish/default",
163-
"description_en": "group description in english",
93+
"title": "TITLE",
94+
"description": "DESCRIPTION",
16495
"permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}",
16596
"sort_order": 3,
16697
}
@@ -178,9 +109,7 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Update \
178109
{
179110
"id": 319,
180111
"title": "NAME",
181-
"title_en": "",
182-
"description": "DESCRIPTIONs",
183-
"description_en": "",
112+
"description": "DESCRIPTION",
184113
"company_id": 2,
185114
"company_type": 2,
186115
"permissions": "{\"view_news\":true,\"org_admin\":true,\"panel_printing\":true,\"printer_restart\":true,\"printer_edit\":true,\"bed_leveling\":true,\"gcode_profiles\":true,\"printer_settings\":true,\"filament_settings\":true,\"change_filament\":true,\"create_filament\":true,\"see_filament_tab\":true,\"view_users\":true,\"change_user_rank\":true,\"manual_user_email_confirm\":true,\"invite_users\":true,\"delete_user\":true,\"org_user_registration_settings\":true,\"org_hub_settings\":true,\"org_rank_management\":true,\"org_view_statistics\":true,\"refill_quota\":true,\"custom_slicer_profiles\":true,\"org_profiles\":true,\"all_slicer_modes\":true,\"queue_remove_all\":true,\"org_api\":true,\"create_org_folder\":true,\"cancel_others\":true,\"see_who_printed\":true,\"max_print_size\":[],\"default_slicer_mode\":2}",
@@ -209,12 +138,10 @@ This endpoint updates the groups in the company.
209138
| --------- | ---- | -------- | ----------- |
210139
| `ranks` | array | yes | Array of groups to update. |
211140
| `ranks[].id` | integer | yes | The id of the group to update. |
212-
| `ranks[].title` | string | no | The name of the group in danish or the name of the group if `title_en` is not set. |
213-
| `ranks[].title_en` | string | no | The name of the group in english. |
214-
| `ranks[].description` | string | no | The description of the group in danish or the description of the group if `description_en` is not set. |
215-
| `ranks[].description_en` | string | no | The description of the group in english. |
141+
| `ranks[].title` | string | no | The name of the group. |
142+
| `ranks[].description` | string | no | The description of the group. |
216143
| `ranks[].permissions` | string | no | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). |
217-
| `ranks[].company_type` | integer | no | The type of the company. |
144+
| `ranks[].sort_order` | integer | no | The sort index of the group. |
218145

219146
### Response
220147

@@ -224,10 +151,8 @@ This endpoint updates the groups in the company.
224151
| `message` | string | Error message if `status` is false. |
225152
| `data` | array | Array of the updated groups. |
226153
| `data[].id` | integer | The id of the group. |
227-
| `data[].title` | string | The name of the group in danish or the name of the group if `title_en` is not set. |
228-
| `data[].title_en` | string | The name of the group in english. |
229-
| `data[].description` | string | The description of the group in danish or the description of the group if `description_en` is not set. |
230-
| `data[].description_en` | string | The description of the group in english. |
154+
| `data[].title` | string | The name of the group. |
155+
| `data[].description` | string | The description of the group. |
231156
| `data[].company_id` | integer | The id of the company. |
232157
| `data[].company_type` | integer | The type of the company. |
233158
| `data[].permissions` | string | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). |

‎source/includes/_printers.md‎

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -39,43 +39,6 @@ This endpoint can be used to delete a printer from the database, or to disconnec
3939
| `status` | boolean | True if the request was successful. |
4040
| `message` | string | Error message if `status` is false. |
4141

42-
## Check if OctoPrint plugin is installed
43-
44-
```shell
45-
curl https://api.simplyprint.io/{id}/printers/HasPlugin?pid=1234&plugin=PrintTimeGenius \
46-
-H 'accept: application/json' \
47-
-H 'X-API-KEY: {API_KEY}'
48-
```
49-
50-
> Success response
51-
52-
```json
53-
{
54-
"status": true,
55-
"message": null,
56-
"has": true
57-
}
58-
```
59-
60-
This endpoint can be used to check if a printer has a plugin installed. The plugins are checked by ... ? TODO
61-
62-
### Request
63-
64-
`GET /{id}/printers/HasPlugin`
65-
66-
| Parameter | Type | Required | Description |
67-
| --------- | ---- | -------- | ----------- |
68-
| `pid` | integer | yes | The ID of the printer to check. |
69-
| `plugin` | string | yes | The name of the plugin key to check. |
70-
71-
### Response
72-
73-
| Field | Type | Description |
74-
| ----- | ---- | ----------- |
75-
| `status` | boolean | True if the request was successful. |
76-
| `message` | string | Error message if `status` is false. |
77-
| `has` | boolean | True if the printer has the plugin. |
78-
7942
## Clear print bed
8043

8144
```shell

‎source/includes/_queue.md‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,11 @@ This endpoint adds a file to the queue. The file can either be a file on the fil
3636

3737
`POST /{id}/queue/AddItem`
3838

39-
You must specify either a filesystem id or a file to upload.
40-
41-
#### Parameters
42-
4339
| Parameter | Type | Required | Description |
4440
| --------- | ---- | -------- | ----------- |
4541
| `filesystem` | string | no | The filesystem id of the file to add to the queue. |
4642
| `amount` | integer | no | The amount of prints to add to the queue.<br>**Default: 1** |
4743

48-
#### File upload
49-
50-
| File | Type | Required | Description |
51-
| --------- | ---- | -------- | ----------- |
52-
| `file` | stl/3mf/obj/gcode/gco/nc/npg | no | The file to add to the queue.<br>**Max file size: 100MB (bigger files must be uploaded to the filesystem first)** |
53-
5444
### Response
5545

5646
| Parameter | Type | Description |

‎source/index.html.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ toc_footers:
99
- <a href='https://help.simplyprint.io' target='_blank'>Need help?</a>
1010

1111
includes:
12-
- files
12+
- printers
1313
- filament
14-
- account
14+
- files
1515
- queue
16-
- printers
16+
- account
1717
- permissions
1818
- errors
1919

0 commit comments

Comments
 (0)