With the /EngravingMachines endpoint user can manage engraving machines from the database.
GET
/api/EngravingMachines/List
Get a list of all engraving machines
Request Example
/api/EngravingMachines/List
RESPONSE EXAMPLE
[
{
"PrinterDriverName": "string",
"MachineType": "string",
"MachineModel": "string",
"MaxPlateHeight": 10.0,
"MaxPlateWidth": 10.0,
"LaserBeamAdjustmentX": 0.0,
"LaserBeamAdjustmentY": 0.0,
"MachineOffsetX": 0.0,
"MachineOffsetY": 0.0,
"FolderPath": "string",
"UCBoard": null,
"MaximumPower": 100,
"HeadType": "string",
"BoardType": "string",
"AutoFocus": "string",
"FileUnits": 0,
"AddPower": "0",
"AddSpeed": "0",
"TrotecDeviceNo": "string",
"Id": "string"
},
{...}
]
GET
/api/EngravingMachines/Get
Get an engraving machine
Request Example
/api/EngravingMachines/Get?id=engravingMachineId&name=printerDriverName
Use id parameter to get engraving machine by id or
Use name parameter to get engraving machine by printer driver name
RESPONSE EXAMPLE
If found, an engraving machine is returned with status code 200. Otherwise an error with code and message is returned with status code 404
{
"PrinterDriverName": "string",
"MachineType": "string",
"MachineModel": "string",
"MaxPlateHeight": 10.0,
"MaxPlateWidth": 10.0,
"LaserBeamAdjustmentX": 0.0,
"LaserBeamAdjustmentY": 0.0,
"MachineOffsetX": 0.0,
"MachineOffsetY": 0.0,
"FolderPath": "string",
"UCBoard": null,
"MaximumPower": 100,
"HeadType": "string",
"BoardType": "string",
"AutoFocus": "string",
"FileUnits": 0,
"AddPower": "0",
"AddSpeed": "0",
"TrotecDeviceNo": "string",
"Id": "string"
}
POST
/api/EngravingMachines/Create
Create an engraving machine
Model Request Example
{
"PrinterDriverName": "string",
"MachineType": "string",
"MachineModel": "string",
"MaxPlateHeight": 10.0,
"MaxPlateWidth": 10.0,
"LaserBeamAdjustmentX": 0.0,
"LaserBeamAdjustmentY": 0.0,
"MachineOffsetX": 0.0,
"MachineOffsetY": 0.0,
"FolderPath": "string",
"UCBoard": null,
"MaximumPower": 100,
"HeadType": "string",
"BoardType": "string",
"AutoFocus": "string",
"FileUnits": 0,
"AddPower": "0",
"AddSpeed": "0",
"TrotecDeviceNo": "string",
"Id": "string"
}
Response Example
If the operation is successful an engraving machine will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409
PUT
/api/EngravingMachines/Update
Update an engraving machine
Request Example
/api/EngravingMachines/Update?id=engravingMachineId&name=printerDriverName
Use id parameter to identify the engraving machine to update by id or
Use name parameter to identify the engraving machine to update by printer driver name
Model Request Example
All fields are updated
{
"PrinterDriverName": "string",
"MachineType": "string",
"MachineModel": "string",
"MaxPlateHeight": 10.0,
"MaxPlateWidth": 10.0,
"LaserBeamAdjustmentX": 0.0,
"LaserBeamAdjustmentY": 0.0,
"MachineOffsetX": 0.0,
"MachineOffsetY": 0.0,
"FolderPath": "string",
"UCBoard": null,
"MaximumPower": 100,
"HeadType": "string",
"BoardType": "string",
"AutoFocus": "string",
"FileUnits": 0,
"AddPower": "0",
"AddSpeed": "0",
"TrotecDeviceNo": "string",
"Id": "string"
}
Response Example
If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409
DELETE
/api/EngravingMachines/Delete
Delete an engraving machine
Request Example
/api/EngravingMachines/Delete?id=engravingMachineId&name=printerDriverName
Use id parameter to identify the engraving machine to update by id or
Use name parameter to identify the engraving machine to delete by printer driver name
Response Example
If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409
GET
/api/EngravingMachines/GetMachineModelsList
Get a list of engraving machine models
Request Example
/api/EngravingMachines/GetMachineModelsList?machineType=engravingMachineType
RESPONSE EXAMPLE
A list of engraving machine models is returned with status code 200.
[
"IS200",
"IS200_IQ",
"IS400",
"IS400G",
"IS400_IQ",
"IS400PNS",
"IS600",
"IS700",
"IS800",
"IS900_IQ",
"IS6000",
"IS6000_IQ",
"IS7000",
"IS7000_IQ",
"IS8000",
"IS8000_IQ",
"IS6000XP",
"IS7000XP",
"IS8000XP",
"M10",
"M20",
"M20_IQ",
"M20PX",
"M20JEWEL",
"M20JEWEL_IQ",
"M20JEWEL2",
"M20_V3",
"M20XL",
"M20XL_IQ",
"M20XL_V3",
"M40",
"M40_IQ",
"M40G",
"M40G_IQ",
"M40VOL_IQ",
"TAGCUBE"
]
GET
/api/EngravingMachines/GetMachineType
Get an engraving machine type
Request Example
/api/EngravingMachines/GetMachineType?printerDriverName=printerDriverName
RESPONSE EXAMPLE
If found, an engraving machine type is returned with status code 200. Otherwise an error with code and message is returned with status code 404
"engraving machine type"