GET api/SSPSchedule/{employeeNo}/{startDate}

Get a specific SSPSchedule for an employee. The key is the ScheduleName and the StartDate

Request Information

URI Parameters

NameDescriptionTypeAdditional information
employeeNo

Employee Number

string

Required

startDate

Start Date

date

Required

Body Parameters

None.

Response Information

Resource Description

SSPSchedule

SSPScheduleDetail
NameDescriptionTypeAdditional 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.

Response Formats

application/json, text/json

Sample:
{
  "RecordID": 1,
  "ScheduleName": "sample string 2",
  "StartDate": "2024-12-23T06:34:35.1124166+00:00",
  "EndDate": "2024-12-23T06:34:35.1124166+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:34:35.1124166+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:34:35.1124166+00:00</StartDate>
</SSPScheduleDetail>