API Docs | ColourTypes | Tajima Software Solutions Inc.

With the /colourTypes endpoint user can manage the database Colour Types

GET /api/ColourTypes/GetAll Get all colour types
Request Example 
    /api/ColourTypes/GetAll
Response Example 
Response Example
a list of colour types is returned
    [
      {
        "Id": 0,
        "Name": "string",
        "PricingSKU": "string",
        "CompanyId": 0        
      }
    ]
POST /api/ColourTypes/Create Create a colour type
Model Request Example 
    {
        "Name": "string",
        "PricingSKU": "string" //- Optional 
    }
Response Example 
If the operation is successful an empty response will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409
PATCH /api/ColourTypes/Update Update a colour type
Request Example
    /api/ColourTypes/Update?Name=name
            Name is required in order to identify the colourtype to update
Model Request Example
            Only provided attributes are updated
            Please have in mind that if a new name is provided, related colours are updated too
    {
        "Name": "string",
        "PricingSKU": "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/ColourTypes/Delete Delete a colour type
Request Example 
/api/Colours/Delete?Name=example
Name is required in order to identify the colour type to delete
Please have in mind that related colours are updated with no type
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