With the /ProgramRules endpoint user can manage ProgramRules from the database.
GET
/api/ProgramRules/List
Get a list of all ProgramRules
Request Example
/api/ProgramRules/List
RESPONSE EXAMPLE
[
{
"Id": "stirng"
"EmblemCode": "stirng",
"FontId": "font21",
"Lines": Number,
"MinimumLetters": Number,
"MaximumLetters": Number,
"Recipe": "stirng",
"LineSpacing": Number,
"SpecialRules": ture/false,
"Height": Number,
"LetterWidth": Number,
"StemStitch": Number
},
{...}
]
GET
/api/ProgramRules/Get
Get a programRules
Request Example
/api/ProgramRules/Get?id=programRulesId&name=programRulesName
RESPONSE EXAMPLE
If found, a programRules is returned with status code 200. Otherwise an error with code and message is returned with status code 404
{
"Id": "stirng"
"EmblemCode": "stirng",
"FontId": "stirng",
"Lines": Number,
"MinimumLetters": Number,
"MaximumLetters": Number,
"Recipe": "stirng",
"LineSpacing": Number,
"SpecialRules": ture/false,
"Height": Number,
"LetterWidth": Number,
"StemStitch": Number
}
POST
/api/ProgramRules/Create
Create a programRules
Model Request Example
{
"Id": "stirng"
"EmblemCode": "stirng",
"FontId": "stirng",
"Lines": Number,
"MinimumLetters": Number,
"MaximumLetters": Number,
"Recipe": "stirng",
"LineSpacing": Number,
"SpecialRules": ture/false,
"Height": Number,
"LetterWidth": Number,
"StemStitch": Number
}
Response Example
If the operation is successful a programRules will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409
PUT
/api/ProgramRules/Update
Update a programRules
Request Example
/api/ProgramRules/Update?id=programRulesId
Model Request Example
All fields are updated
{
"EmblemCode": "stirng",
"FontId": "stirng",
"Lines": Number,
"MinimumLetters": Number,
"MaximumLetters": Number,
"Recipe": "stirng",
"LineSpacing": Number,
"SpecialRules": ture/false,
"Height": Number,
"LetterWidth": Number,
"StemStitch": Number
}
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/ProgramRules/Delete
Delete a programRules
Request Example
/api/ProgramRules/Delete?id=programRulesId
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