POST api/WorkSchedule/Update/{employeeNo}
Update a WorkSchedule for an Employee. The key for updates is the Start Date
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
employeeNo |
Employee Number |
string |
Required |
Body Parameters
In request Body: Employee Work Schedule Details
WorkScheduleDetailName | Description | Type | Additional information |
---|---|---|---|
RecordID | integer |
None. |
|
ScheduleName | string |
None. |
|
StartDate |
OPTIONAL - The start date of the work schedule |
date |
Required |
EndDate |
OPTIONAL - The end date of the work schedule |
date |
None. |
OverrideSchedule | boolean |
None. |
|
Hourly | boolean |
None. |
|
MultiWeek | boolean |
None. |
|
WorkScheduleWeeks | Collection of Dictionary of string [key] and decimal number [value] |
None. |
Request Formats
application/json, text/json
Sample:
{ "RecordID": 1, "ScheduleName": "sample string 2", "StartDate": "2024-12-23T06:56:48.048398+00:00", "EndDate": "2024-12-23T06:56:48.048398+00:00", "OverrideSchedule": true, "Hourly": true, "MultiWeek": true, "WorkScheduleWeeks": [ { "sample string 1": 2.0, "sample string 3": 4.0 }, { "sample string 1": 2.0, "sample string 3": 4.0 } ] }
application/xml, text/xml
Sample:
<WorkScheduleDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models"> <EndDate>2024-12-23T06:56:48.048398+00:00</EndDate> <Hourly>true</Hourly> <MultiWeek>true</MultiWeek> <OverrideSchedule>true</OverrideSchedule> <RecordID>1</RecordID> <ScheduleName>sample string 2</ScheduleName> <StartDate>2024-12-23T06:56:48.048398+00:00</StartDate> <WorkScheduleWeeks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:ArrayOfKeyValueOfstringdecimal> <d2p1:KeyValueOfstringdecimal> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>2</d2p1:Value> </d2p1:KeyValueOfstringdecimal> <d2p1:KeyValueOfstringdecimal> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>4</d2p1:Value> </d2p1:KeyValueOfstringdecimal> </d2p1:ArrayOfKeyValueOfstringdecimal> <d2p1:ArrayOfKeyValueOfstringdecimal> <d2p1:KeyValueOfstringdecimal> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>2</d2p1:Value> </d2p1:KeyValueOfstringdecimal> <d2p1:KeyValueOfstringdecimal> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>4</d2p1:Value> </d2p1:KeyValueOfstringdecimal> </d2p1:ArrayOfKeyValueOfstringdecimal> </WorkScheduleWeeks> </WorkScheduleDetail>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result
ResultWithMessageName | Description | Type | Additional information |
---|---|---|---|
result |
'OK', 'Error' |
string |
None. |
message |
Returns if result is Error |
string |
None. |
returnValue | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "result": "OK" } { "result": "Error", "message": "Unable to save: the..." }
application/xml, text/xml
Sample:
<ResultWithMessage> <result>OK</result> </ResultWithMessage> <ResultWithMessage> <result>Error</result> <message>Unable to save: the...</message> </ResultWithMessage>