API Docs | DesignCategory | Tajima Software Solutions Inc.

With the /designCategory endpoints user can manage Design Categories.

GET /api/DesignCategory/GetDesignCategories Get design categories information
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",
        "CompanyId": 0,
        "Id": 0
      }
    ]
POST /api/DesignCategory/CreateDesignCategory Create a design category
Model Request Example 
    {
      "Name": "string",
      "Language": "string", //- Optional 
      "URL": "string" //- Optional 
    }
Response Example 
    If the operation is successful the response will be empty 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?Name=DesignCategoryName
    Name parameter is required in order to identify the Design Category to update
Model Request Example
    {
      "Name": "string",
      "Language": "string", //- Optional 
      "URL": "string" //- Optional 
    }
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 /DesignCategory/Delete Remove a design category
Request Example 
    /api/DesignCategory/Delete?Name=DesignCategoryName
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 the design categories by file extension and location name
Request Example 
    /api/DesignCategory/GetDesignCategoriesByExtension?ext=.pxf,.pcf&locName=Front&orderTypes=embroidery-template,embroidery-free-form&language=English

    Parameters
        "ext": ".pxf,.pcf", // Required, Possible values: ".pxf,.pcf" for embroidery types, ".pv,.png,.jpg,.jpeg" for print types
        "locName": "Front", // Optional, The Location name
        "orderTypes": "embroidery-template,embroidery-free-form", // Optional, Possible values: "embroidery-template,embroidery-free-form,embroidery-design" for embroidery types, "print-template,print-free-form,print-design" for print types
        "language": "English" // Optional
Response Example 
A list of design categories
[
    {
        "Name": "Design Category 1",
        "Language": "English",
        "URL": null,
        "CompanyId": 17,
        "Id": 8
    },
    {
        "Name": "Design Category 2",
        "Language": "English",
        "URL": null,
        "CompanyId": 17,
        "Id": 5
    }
]