DesignCategory | Tajima Software Solutions Inc.

With the /DesignCategory endpoints user can manage Design Categories.

GET /api/DesignCategory/GetDesignCategories Get a list of design categories

Request Example

    /api/DesignCategory/GetDesignCategories?language=English&templateCode=tempCode
    language and templateCode parameters are optional

RESPONSE EXAMPLE

    Returns a list of design categories
    [
      {
        "Name": "string",
        "Language": "string",
        "URL": "string",
        "Active": true,
        "Id": "string"
      },
      {...}
    ]

GET /api/DesignCategory/Get Get a design category

Request Example

    /api/DesignCategory/Get?id=designCategoryId&name=designCategoryName
    Use id parameter to get design category by id or
    Use name parameter to get design category by name

RESPONSE EXAMPLE

    Returns a design category
    {
        "Name": "string",
        "Language": "string",
        "URL": "string",
        "Active": true,
        "Id": "string"
    }

POST /api/DesignCategory/Create Create a design category

Model Request Example

    {
      "Name": "string",
      "Language": "string",
      "URL": "string",
      "Active": true
    }

Response Example

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

PUT /api/DesignCategory/Update Update a design category

Request Example

    /api/DesignCategory/Update?id=designCategoryId&name=designCategoryName
    Use id parameter to update a design category by id or
    Use name parameter to update a design category by name

Model Request Example

    {
      "Name": "string",
      "Language": "string",
      "URL": "string",
      "Active": true
    }

Response Example

    If the operation is successful the response will be empty with status code 200
    Otherwise an error with code and message will be returned with status code 409

DELETE /api/DesignCategory/Delete Delete a design category

Request Example

    /api/DesignCategory/Delete?id=designCategoryId&name=designCategoryName
    Use id parameter to delete a design category by id or
    Use name parameter to delete a design category by name

Response Example

    If the operation is successful the response will be empty with status code 200
    Otherwise an error with code and message will be returned with status code 409

GET /api/DesignCategory/GetDesignCategoriesByExtension Get design categories by file extension and location name

Request Example

    /api/DesignCategory/GetDesignCategoriesByExtension?ext=.pv,.pxf&locName=Front

Response Example

A list with the design categories
[
    {
        "Name": "Design Category 1",
        "Language": "string",
        "URL": "string",
        "Active": true,
        "Id": "string"
    },
    {
        "Name": "Design Category 2",
        "Language": "string",
        "URL": "string",
        "Active": true,
        "Id": "string"
    }
]