A new category can be added only if the maximum number of categories has not been reached.

Parameters

ParameterTypeRequiredNotes
SingularName string True Name of the Category
PluralName string False Plural name of the category
MultItems boolean False Allow the ability to attach multiple items to this category. Accepts an integer value.
QualEmployees boolean False Allow employees to be qualified for specific items in this category. Accepts an integer value.
AddOnFly boolean False Allow the ability to add new items in this category while editing or adding Time Blocks in a Time Block Editor. Accepts an integer value.
RankEmployees boolean False Allow the ability to rank employees based on their suitability for specific items in this category. Accepts an integer value.
DontShowInWeeklyView boolean False Disallow the items in this category to be shown in Time Blocks when in weekly view. Accepts an integer value.
DontShowInMonthlyView boolean False Disallow the items in this category to be shown in Time Blocks when in monthly view. Accepts an integer value.
Payroll boolean False Allow employee pay rates to be tracked per item in this category. Accepts an integer value.
DisableCategory boolean False Allow notes to be stored on each of item of this category. Accepts an integer value.
ShowInCrossSection boolean False Allow this category to be seen from the cross-section toolbar. Accepts an integer value.
AllowNotes boolean False Allow notes to be stored on each of item of this category. Accepts an integer value.

Example Query

POST https://api.workschedule.net/WS.exe?Module=API&SessionID=123&SP=12345678&Method=addCategories

Sample JSON Input

  [
	{
	 "SingularName": "Tester",
	 "Payroll": "1",
	 "AllowNotes": "1",
	 "AddOnFly": "0"
	}
]  

JSON Response

  {
 "ErrorMessage": "Success",
 "ItemResponses": [
  {
   "ErrorMessage": "Success",
   "ItemNo": "1",
   "ErrorCode": "0"
  }],
 "Items": [],
 "ErrorCode": "0"
}  

Resource Information

Response Format JSON
Request Type POST