PUT api/SSPSchedule/{employeeNo}

Add a SSP schedule to an Employee

Request Information

URI Parameters

Name	Description	Type	Additional information
employeeNo	Employee Number	string	Required

Body Parameters

In request Body: Employee SSP schedule detail

SSPScheduleDetail

Name	Description	Type	Additional information
RecordID		integer	None.
ScheduleName		string	None.
StartDate	OPTIONAL - The start date of the SSP schedule	date	Required
EndDate	OPTIONAL - The end date of the SSP schedule	date	None.
OverrideSchedule		boolean	None.
MultiWeek		boolean	None.
SSPScheduleWeeks		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:30:23.6881722+00:00",
  "EndDate": "2024-12-23T06:30:23.6881722+00:00",
  "OverrideSchedule": true,
  "MultiWeek": true,
  "SSPScheduleWeeks": [
    {
      "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:

<SSPScheduleDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
  <EndDate>2024-12-23T06:30:23.6881722+00:00</EndDate>
  <MultiWeek>true</MultiWeek>
  <OverrideSchedule>true</OverrideSchedule>
  <RecordID>1</RecordID>
  <SSPScheduleWeeks 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>
  </SSPScheduleWeeks>
  <ScheduleName>sample string 2</ScheduleName>
  <StartDate>2024-12-23T06:30:23.6881722+00:00</StartDate>
</SSPScheduleDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

ResultWithMessage

Name	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>