Update specified TimesOfDay

Query Parameters

ParameterTypeRequiredNotes
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
StartTime time True
EndTime time True
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.

Example Query

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

Sample JSON Input

  [
 {
  "Key": "CatItemID",
  "KeyVal": "1",
  "StartTime": "9:00 AM",
  "EndTime": "11:00 AM",
  "Name": "Morning",
  "Active": "1",
  "ShowToEmployee": "1",
  "Color": "FFFF00"
 },
 {
  "Key": "CatItemID",
  "KeyVal": "1",
  "StartTime": "5:00 PMM",
  "EndTime": "11:00 PM",
  "Name": "Evening",
  "Active": "1",
  "ShowToEmployee": "1",
  "Color": "000000"
 }
]  

JSON Response

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

Resource Information

Response Format JSON
Request Type POST