Update specified Category Items.

Query Parameters

ParameterTypeRequiredNotes
CatNointegerTrue
reqAddifnotfoundbooleanTrueAccepts an integer value.

Parameters

ParameterTypeRequiredNotes
Key string True Denotes how the item will be indexed: CatItemID or ExternalID
KeyVal string True The actual index of the item: CatItemID or ExternalID
ExternalID integer False Must be unique
Name string False
ShowToEmployee boolean False Accepts an integer value.
Color string False Set the override color. Accepts a properly-formatted 6-digit hexadecimal color
Active boolean False Accepts an integer value.
StartTime datetime True* Only required if updating TimeOfDay
EndTime datetime True* Only required if updating TimeOfDay

Example Query

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

Sample JSON Input

  [
	{
	 "Key": "CatItemID",
	 "KeyVal": "25",
	 "Name": "Test1",
	 "Color": "00FF00",
	 "Active": "1",
	 "ShowToEmployee": "1"
	}
]  

JSON Response

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

Resource Information

Response Format JSON
Request Type POST