EngravingFrames | Tajima Software Solutions Inc.

With the /EngravingFrames endpoint user can manage EngravingFrames from the database.

GET /api/EngravingFrames/List Get a list of all EngravingFrames

Request Example

    /api/EngravingFrames/List

RESPONSE EXAMPLE

    [
        {
            "Id": "string",
            "ProductCode": "string",
            "Name": "string",
            "XOriginOffset": 1.0,
            "YOriginOffset": 1.0,
            "OrderType": "string",
            "LocationItems": [
                {
                    "LocationName": "string",
                    "XPosition": Number,
                    "YPosition": Number,
                    "Width": Number,
                    "Height": Number
                }
            ],
            "Mode": "string",
            "Diameter": Number            
        },
        {...}
    ]

GET /api/EngravingFrames/Get Get a EngravingFrames

Request Example

    /api/EngravingFrames/Get?id=EngravingFramesId

RESPONSE EXAMPLE

    If found, a EngravingFrames is returned with status code 200. Otherwise an error with code and message is returned with status code 404  
    {
        "Id": "string",
        "ProductCode": "string",
        "Name": "string",
        "XOriginOffset": 1.0,
        "YOriginOffset": 1.0,
        "OrderType": "string",
        "LocationItems": [
            {
                "LocationName": "string",
                "XPosition": Number,
                "YPosition": Number,
                "Width": Number,
                "Height": Number
            }
        ],
        "Mode": "string",
        "Diameter": Number            
    }

POST /api/EngravingFrames/Create Create a EngravingFrames

Model Request Example

    {
        "ProductCode": "string",
        "Name": "string",
        "XOriginOffset": Number,    (optional)  
        "YOriginOffset": Number,    (optional)  
        "OrderType": "string",
        "LocationItems": [
            {
                "LocationName": "string",
                "XPosition": Number,
                "YPosition": Number,
                "Width": Number,    (optional)
                "Height": Number    (optional)
            }
        ],
        "Mode": "string",
        "Diameter": Number  (required if the mode is Cylindrical)
    }

Response Example

If the operation is successful a EngravingFrames will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409

PUT /api/EngravingFrames/Update Update a EngravingFrames

Request Example

    /api/EngravingFrames/Update?id=EngravingFramesId

Model Request Example

    {
        "ProductCode": "string",
        "Name": "string",
        "XOriginOffset": Number,    (optional)  
        "YOriginOffset": Number,    (optional)  
        "OrderType": "string",
        "LocationItems": [
            {
                "LocationName": "string",
                "XPosition": Number,
                "YPosition": Number,
                "Width": Number,    (optional)
                "Height": Number    (optional)
            }
        ],
        "Mode": "string",
        "Diameter": Number  (required if the mode is Cylindrical)
    }

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/EngravingFrames/Delete Delete a EngravingFrames

Request Example

/api/EngravingFrames/Delete?id=EngravingFramesId

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