Skip to content

Commit b222a93

Browse files
committed
Document get filament types endpoint
1 parent f68db93 commit b222a93

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

source/includes/_filament.md

+71
Original file line numberDiff line numberDiff line change
@@ -366,3 +366,74 @@ This endpoint unassigns a filament from a printer by filament id.
366366
|-----------|---------|-------------------------------------|
367367
| `status` | boolean | True if the request was successful. |
368368
| `message` | string | Error message if `status` is false. |
369+
370+
## Get Filament Types
371+
372+
```shell
373+
curl https://api.simplyprint.io/{id}/filament/type/Get \
374+
-H 'accept: application/json' \
375+
-H 'X-API-KEY: {API_KEY}'
376+
```
377+
378+
> Success response
379+
380+
```json
381+
{
382+
"status": true,
383+
"message": null,
384+
"data": [
385+
{
386+
"id": 6030,
387+
"org_id": 2,
388+
"filament_type_name": "PLA",
389+
"width": 1.75,
390+
"nozzle_temp": 200,
391+
"bed_temp": 60,
392+
"print_speed": 70,
393+
"finish_rate_factor": 0.5,
394+
"min_speed": 15,
395+
"density": 1.24,
396+
"priority": 0,
397+
"deleted": 1,
398+
"cost": null,
399+
"allowed_nozzle_temp_margin": 10,
400+
"allowed_bed_temp_margin": 10
401+
},
402+
{
403+
"id": 10548,
404+
"org_id": 2,
405+
"filament_type_name": "PolyMide PA6-CF",
406+
"width": 1.75,
407+
"nozzle_temp": 210,
408+
"bed_temp": 60,
409+
"print_speed": 60,
410+
"finish_rate_factor": 0.5,
411+
"min_speed": 15,
412+
"density": 1.24,
413+
"priority": 0,
414+
"deleted": 0,
415+
"cost": 1,
416+
"allowed_nozzle_temp_margin": 10,
417+
"allowed_bed_temp_margin": 10
418+
}
419+
]
420+
}
421+
```
422+
423+
This endpoint returns a list of filament types available.
424+
425+
| Required permissions |
426+
|----------------------|
427+
| `see_filament_tab` |
428+
429+
### Request
430+
431+
`GET /{id}/filament/type/Get`
432+
433+
### Response
434+
435+
| Parameter | Type | Description |
436+
|-----------|---------|-------------------------------------|
437+
| `status` | boolean | True if the request was successful. |
438+
| `message` | string | Error message if `status` is false. |
439+
| `data` | array | Array of filament types. |

0 commit comments

Comments
 (0)