With the /ProductDesigns endpoint user can manage ProductDesigns from the database.
GET
/api/ProductDesigns/List
Get a list of all ProductDesigns
Request Example
/api/ProductDesigns/List
RESPONSE EXAMPLE
[
{
"Id": "string",
"Name": "string",
"Code": "string",
"Color": "string",
"DesignName": "string",
"ColorTheme": "string",
"ColorThemeItems": [
{
"OriginalColor": "string",
"ReplaceColor": "string",
"Num": Number
},
{...}
],
},
{...}
]
GET
/api/ProductDesigns/Get
Get a ProductDesign
Request Example
/api/ProductDesigns/Get?id=ProductDesignId&code=ProductDesignCode
Use id parameter to get ProductDesign by id or
Use code parameter to get ProductDesign by code
RESPONSE EXAMPLE
If found, a ProductDesign is returned with status code 200. Otherwise an error with code and message is returned with status code 404
{
"Id": "string",
"Name": "string",
"Code": "string",
"Color": "string",
"DesignName": "string",
"ColorTheme": "string",
"ColorThemeItems": [
{
"OriginalColor": "string",
"ReplaceColor": "string",
"Num": Number
},
{...}
]
}
POST
/api/ProductDesigns/Create
Create a ProductDesign
Model Request Example
{
"Name": "string",
"Code": "string",
"Color": "string",
"DesignName": "string",
"ColorTheme": "string",
"ColorThemeItems": [
{
"OriginalColor": "string",
"ReplaceColor": "string",
"Num": Number
},
{...}
],
}
Response Example
If the operation is successful a ProductDesign will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409
PUT
/api/ProductDesigns/Update
Update a ProductDesign
Request Example
/api/ProductDesigns/Update?id=ProductDesignId&Code=ProductDesignCode
Use id parameter to identify the ProductDesign to update by id or
Use code parameter to identify the ProductDesign to update by code
Model Request Example
All fields are updated
{
"Name": "string",
"Prefix": "string",
"ProductDesignType": "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/ProductDesigns/Delete
Delete a ProductDesign
Request Example
/api/ProductDesigns/Delete?id=ProductDesignId&code=ProductDesignCode
Use id parameter to identify the ProductDesign to update by id or
Use code parameter to identify the ProductDesign to delete by code
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