ColorProfiles | Tajima Software Solutions Inc.

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

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

Request Example

    /api/ColorProfiles/List

RESPONSE EXAMPLE

    [
        {
            "Id": "string"
            "Name": "string",
            "Enabled": false,
            "ColorProfilePrinters": [
                {
                    "Id": "string"
                    "PrinterId": "string",
                    "printerName": "string",
                    "Type": null,
                    "FilePath": "string",
                    "SubfolderPath": "string",
                    "ColorProfileID": "string",
                },
                {...}
            ]
        },
        {...}
    ]

GET /api/ColorProfiles/Get Get a ColorProfile

Request Example

    /api/ColorProfiles/Get?id=ColorProfileId&name=ColorProfileName
    Use id parameter to get ColorProfile by id or
    Use name parameter to get ColorProfile by name

RESPONSE EXAMPLE

    If found, a ColorProfile is returned with status code 200. Otherwise an error with code and message is returned with status code 404  
    {
        "Id": "string"
        "Name": "string",
        "Enabled": false,
        "ColorProfilePrinters": [
            {
                "Id": "string"
                "PrinterId": "string",
                "printerName": "string",
                "Type": null,
                "FilePath": "string",
                "SubfolderPath": "string",
                "ColorProfileID": "string",
            },
            {...}
        ]
    }

POST /api/ColorProfiles/Create Create a ColorProfile

Model Request Example

    {
            "Name": "string",
            "Enabled": true,    // true or false
            "ConfiguredBrothers": [  //optional
                { 
                    "Id" : "string",  // input Id or printerName
                    "printerName": "string",  
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ],
            "ConfiguredKornits": [ //optional
                { 
                    "Id" : "string",  // input Id or printerName
                    "printerName": "string",
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ],
            "ConfiguredEpsons": [ //optional
                { 
                    "Id" : "string",  //  input Id or printerName
                    "printerName": "string",
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ],
            "ConfiguredMavericks": [ //optional
                { 
                    "Id" : "string",  //  input Id or printerName
                    "printerName": "string",
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ]
    }

Response Example

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

PUT /api/ColorProfiles/Update Update a ColorProfile

Request Example

    /api/ColorProfiles/Update?id=ColorProfileId&name=ColorProfileName
    Use id parameter to identify the ColorProfile to update by id or
    Use name parameter to identify the ColorProfile to update by name

Model Request Example

    All fields are updated
    {
            "Name": "string",
            "Enabled": true,    // true or false
            "ConfiguredBrothers": [  //optional
                { 
                    "Id" : "string",  // input Id or printerName
                    "printerName": "string",  
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ],
            "ConfiguredKornits": [ //optional
                { 
                    "Id" : "string",  // input Id or printerName
                    "printerName": "string",
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ],
            "ConfiguredEpsons": [ //optional
                { 
                    "Id" : "string",  //  input Id or printerName
                    "printerName": "string",
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "string"
                }
            ],
            "ConfiguredMavericks": [ //optional
                { 
                    "Id" : "string",  //  input Id or printerName
                    "printerName": "string",
                    "Type": "string",
                    "FilePath": "string",
                    "SubfolderPath": "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/ColorProfiles/Delete Delete a ColorProfile

Request Example

/api/ColorProfiles/Delete?id=ColorProfileId&name=ColorProfileName
Use id parameter to identify the ColorProfile to update by id or
Use name parameter to identify the ColorProfile 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