Skip to content

Commit 8cba6ce

Browse files
dnorhojdnorhoj
committed
Incorporated some changes requested by Albert
1 parent 2b9fabb commit 8cba6ce

File tree

3 files changed

+14
-75
lines changed

3 files changed

+14
-75
lines changed

‎source/includes/_account.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Create \
1515
{
1616
"ranks": [
1717
{
18-
"title": "name of group in danish/default",
19-
"title_en": "name of group in english",
20-
"description": "group description in danish/default",
21-
"description_en": "group description in english",
18+
"title": "name of group",
19+
"description": "group description",
2220
"sort_order": 3,
2321
"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}"
2422
}
@@ -34,10 +32,8 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Create \
3432
"message": null,
3533
"data": [
3634
{
37-
"title": "name of group in danish/default",
38-
"title_en": "name of group in english",
39-
"description": "group description in danish/default",
40-
"description_en": "group description in english",
35+
"title": "name of group",
36+
"description": "group description",
4137
"company_id": 2,
4238
"company_type": 2,
4339
"sort_order": 3,
@@ -65,10 +61,8 @@ This endpoint creates a new group in the company.
6561
| Parameter | Type | Required | Description |
6662
| --------- | ---- | -------- | ----------- |
6763
| `ranks` | array | yes | Array of groups to create. |
68-
| `ranks[].title` | string | yes | The name of the group in danish or the name of the group if `title_en` is not set. |
69-
| `ranks[].title_en` | string | no | The name of the group in english. |
70-
| `ranks[].description` | string | no | The description of the group in danish or the description of the group if `description_en` is not set. |
71-
| `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. |
7266
| `ranks[].sort_order` | integer | yes | The sort index of the group. |
7367
| `ranks[].permissions` | string | yes | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). |
7468

@@ -96,10 +90,8 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Update \
9690
"ranks": [
9791
{
9892
"id": 319,
99-
"title": "name of group in danish/default",
100-
"title_en": "name of group in english",
101-
"description": "group description in danish/default",
102-
"description_en": "group description in english",
93+
"title": "TITLE",
94+
"description": "DESCRIPTION",
10395
"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}",
10496
"sort_order": 3,
10597
}
@@ -117,9 +109,7 @@ curl https://api.simplyprint.io/{id}/account/settings/rank/Update \
117109
{
118110
"id": 319,
119111
"title": "NAME",
120-
"title_en": "",
121-
"description": "DESCRIPTIONs",
122-
"description_en": "",
112+
"description": "DESCRIPTION",
123113
"company_id": 2,
124114
"company_type": 2,
125115
"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}",
@@ -148,12 +138,10 @@ This endpoint updates the groups in the company.
148138
| --------- | ---- | -------- | ----------- |
149139
| `ranks` | array | yes | Array of groups to update. |
150140
| `ranks[].id` | integer | yes | The id of the group to update. |
151-
| `ranks[].title` | string | no | The name of the group in danish or the name of the group if `title_en` is not set. |
152-
| `ranks[].title_en` | string | no | The name of the group in english. |
153-
| `ranks[].description` | string | no | The description of the group in danish or the description of the group if `description_en` is not set. |
154-
| `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. |
155143
| `ranks[].permissions` | string | no | JSON string of the permissions of the group. For more information, see [Permissions](#permissions). |
156-
| `ranks[].company_type` | integer | no | The type of the company. |
144+
| `ranks[].sort_order` | integer | no | The sort index of the group. |
157145

158146
### Response
159147

@@ -163,10 +151,8 @@ This endpoint updates the groups in the company.
163151
| `message` | string | Error message if `status` is false. |
164152
| `data` | array | Array of the updated groups. |
165153
| `data[].id` | integer | The id of the group. |
166-
| `data[].title` | string | The name of the group in danish or the name of the group if `title_en` is not set. |
167-
| `data[].title_en` | string | The name of the group in english. |
168-
| `data[].description` | string | The description of the group in danish or the description of the group if `description_en` is not set. |
169-
| `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. |
170156
| `data[].company_id` | integer | The id of the company. |
171157
| `data[].company_type` | integer | The type of the company. |
172158
| `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 |

0 commit comments

Comments
 (0)