Print Job API v3¶

This is the API that was used by sendshapes and is written in Perl.

GET /api3/api_get_print_order_for_token¶

This retrieves information about a print order based on the provided token

Query Parameters:
	token – Required. The token to query against

Example request

GET /api3/api_get_print_order_for_token?token=17a1c2157dd7327c148bc7b54c3a24b0 HTTP/1.1

Example response

{"data":
 {"copies": 1,
   "print_order_id": 4464,
   "print_order_status_id": 1,
   "print_order_status_name": "new",
   "project_name": "tmph5bkfl",
   "receiver_email": "test3@eli.com",
   "receiver_id": 187,
   "stl_filename": "3d9cd99f-25c7-5ff6-da19-ca8afaa9a81c.stl",
   "stl_id": 4500,
   "token": "17a1c2157dd7327c148bc7b54c3a24b0"
},
"status": {"code": "ok"}
}

GET /api3/api_list_printers_by_uuid¶

This gets a list of information about printers based on the node UUID provided

Query Parameters:
	node_uuid – Required. The node uuid to query against

Example request

GET /api3/api_list_printers_by_uuid?node_uuid=a05f2154-8a04-48b0-bd49-6007165936c1 HTTP/1.1

Example response

{"data": {
    "printers": [{"name": "Replicator 2",
                  "node_id": "338",
                  "printer_id": "799",
                  "printer_model_id": "2",
                  "printer_status_id": "2"}]
},
"status": {"code": "ok"}}

GET /api3/api_list_sys_supported_printers¶

Get a list of all of the supported printers in the platform

Example request

GET /api3/api_get_client_version HTTP/1.1

Example response

{"data": {
    "printers": [{"printer_maker_id": "1",
                  "printer_maker_name": "Ultimaker",
                  "printer_model_id": "1",
                  "printer_model_name": "Ultimaker Original"},
                ...snip...
                 {"printer_maker_id": "8",
                  "printer_maker_name": "Stratasys",
                  "printer_model_id": "13",
                  "printer_model_name": "Series 1"}]
},

GET /api3/api_add_node_to_receiver¶

Example request

GET /api3/api_add_node_to_receiver?receiver_email=test3%40eli.com&node_uuid=a05f2154-8a04-48b0-bd49-6007165936c1 HTTP/1.1

Example response

"status": {"code": "ok"}": {"code": "error",
     "description": "System error",
     "extended_description": "node already exists\n"}}

GET /api3/api_list_available_ports¶

Example request

GET /api3/api_list_available_ports?node_uuid=a05f2154-8a04-48b0-bd49-6007165936c1 HTTP/1.1

Example response

{"data": {"ports_available": "/dev/tty.usbmodem1411,simulated"}, "status": {"code": "ok"}}

GET /api3/api_get_client_version¶

Example request

GET /api3/api_get_client_version HTTP/1.1

{"data": {"var_value": "2.0.0"}, "status": {"code": "ok"}}

GET /api3/api_add_printer_to_node_id¶

Example request

GET /api3/api_add_printer_to_node_id?printer_model_id=15&node_uuid=a05f2154-8a04-48b0-bd49-6007165936c1&printer_name=Creatr+%28single+nozzle%29 HTTP/1.1

Example response

{"data": {"printer_id": "801", "printer_model_id": "15"}, "status": {"code": "ok"}}

GET /api3/api_get_printer_status¶

Example request

GET /api3/api_get_printer_status?printer_id=810 HTTP/1.1

Example response

{"data": {"status": "ready"}, "status": {"code": "ok"}}

GET /api3/api_get_printer_info¶

Example request

GET /api3/api_get_printer_info?printer_id=810 HTTP/1.1

Example response

{"data": {
       "dt_created": None,
       "name": "Replicator 2",
       "printer_id": "810",
       "printer_maker": "MakerBot",
       "printer_model_bed_size": "285,153,155",
       "printer_model_description": None,
       "printer_model_driver_name": "makerbot_1.01",
       "printer_model_filament_diameter": "1.75",
       "printer_model_heated_bed": "0",
       "printer_model_id": "2",
       "printer_model_name": "Replicator 2",
       "printer_model_nozzle_diameter": "0.4",
       "printer_status": "ONLINE"
}, "status": {"code": "ok"}}

GET /api3/api_reset_print_order¶

Example request

GET /api3/api_reset_print_order?token=482417c8635ac4f792cae4b41b7dd5d5 HTTP/1.1

Example response

{"data": {"print_order_id": "4491"}, "status": {"code": "ok"}}

GET /api3/api_assign_print_order_to_printer¶

Example request

GET /api3/api_assign_print_order_to_printer?slicer_id=1&printer_id=810&print_order_id=4491 HTTP/1.1

Example response

{"data": {}, "status": {"code": "ok"}}

GET /api3/api_create_slicing_parameter_set¶

Example request

GET /api3/api_create_slicing_parameter_set?layer_quality=low&printer_model_id=2&material=pla&slicer_type=makerbot&slicer_id=2 HTTP/1.1
GET /api3/api_create_slicing_parameter_set?slicer_id=2&printer_model_id=2&slicer_type=makerbot HTTP/1.1

Example response

{"data": {"slicing_id": "11662"}, "status": {"code": "ok"}}

GET /api3/api_assign_receiver_slicing_parameters_to_print_order¶

Example request

GET /api3/api_assign_receiver_slicing_parameters_to_print_order?slicing_id=11662&print_order_id=4491 HTTP/1.1

Example response

{"data": {"print_order_id": "4491", "slicing_id": "11662"}, "status": {"code": "ok"}}

GET /api3/api_get_partner_info¶

Example request

GET /api3/api_get_partner_info?token=482417c8635ac4f792cae4b41b7dd5d5 HTTP/1.1

Example response

{"data": {"css": "css_example", "partner_name": "TestPartner"}, "status": {"code": "ok"}}

GET /api3/api_enter_settings¶

Set settings for a printer. Name is optional. Not sure about the others

Example request

GET /api3/api_enter_printer_settings&name=foo&port=/dev/ttyusb12&baud_rate=1200

GET /api3/api_remove_printer¶

Remove a printer.

Example request

GET /api3/api_remove_printer&printer_id=1234

GET /api3/api_get_gcode_job_info¶

Get information about a gcode job

Example request

GET /api3/api_get_gcode_job_info&gcode_job_id=1234

GET /api3/api_receiver_acknowleges_end_of_printing_job¶

Indicates the final status of a print

Example request

GET /api3/api_receiver_acknowledges_end_of_printing_job?printing_job_id=123&status=1

GET /api3/api_add_print_report_message¶

Adds feedback information on a print job

Example request

GET /api3/api_add_print_report_message?printing_job_id=123&message=foobard

GET /api3/api_get_printing_job_info¶

Get information about a printing job that is in progress

Example request

GET /api3/api_get_printing_job_info?printing_job_id=123