Platens | Tajima Software Solutions Inc.

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

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

Request Example

    /api/Platens/List

Response Example

    [
        {
            "Id": "string",
            "Name": "string",
            "Width": 0.0,
            "Height": 0.0,
            "BrotherValue": "string",
            "EpsonPlatenSizeID": "string"
        },
        {...}
    ]

GET /api/Platens/Get Get a Platen

Request Example

    /api/Platens/Get?id=platenId&name=platenName
    Use id parameter to get Platen by id or
    Use name parameter to get Platen by name

Response Example

    If found, a Platen is returned with status code 200. Otherwise an error with code and message is returned with status code 404  
    {
        "Id": "string",
        "Name": "string",
        "Width": 0.0,
        "Height": 0.0,
        "BrotherValue": "string",
        "EpsonPlatenSizeID": "string"
    }

POST /api/Platens/Create Create a Platen

Model Request Example

    {
        "Name": "string",
        "Prefix": "string",
        "PlatenType": "string",
        "FolderPath": "string"
    }

Response Example

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

PUT /api/Platens/Update Update a Platen

Request Example

    /api/Platens/Update?id=PlatenId&name=PlatenName
    Use id parameter to identify the Platen to update by id or
    Use name parameter to identify the Platen to update by name

Model Request Example

    All fields are updated
    {
        "Name": "string",
        "Prefix": "string",
        "PlatenType": "string",
        "FolderPath": "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/Platens/Delete Delete a Platen

Request Example

/api/Platens/Delete?id=PlatenId&name=PlatenName
Use id parameter to identify the Platen to update by id or
Use name parameter to identify the Platen to delete by 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