POST api/{programid}/Timesheets/PTO/GetHistory

View PTO History for the selected participant for a provider.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

PtoHistoryGetParams

Name	Type	Additional information
ProgramCode	string	None.
ProviderId	string	None.
ParticipantId	string	None.
FromDate	date	None.
ToDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ProgramCode": "sample string 1",
  "ProviderId": "sample string 2",
  "ParticipantId": "sample string 3",
  "FromDate": "2024-11-16T10:06:56.4509974+00:00",
  "ToDate": "2024-11-16T10:06:56.4509974+00:00"
}

application/xml, text/xml

Sample:

<PtoHistoryGetParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Timesheet">
  <FromDate>2024-11-16T10:06:56.4509974+00:00</FromDate>
  <ParticipantId>sample string 3</ParticipantId>
  <ProgramCode>sample string 1</ProgramCode>
  <ProviderId>sample string 2</ProviderId>
  <ToDate>2024-11-16T10:06:56.4509974+00:00</ToDate>
</PtoHistoryGetParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PtoHistoryGetParams'.

Response Information

Resource Description

GetPtoHistoryResult

Name	Type	Additional information
ProviderId	string	None.
EarnedPTOBalance	EarnedPtoBalance	None.
PtoHistory	PtoHistory	None.

Response Formats

application/json, text/json

Sample:

{
  "ProviderId": "sample string 1",
  "EarnedPTOBalance": {
    "ProviderId": "sample string 1",
    "ParticipantId": "sample string 2",
    "AvailableHours": 3.0,
    "AccruedHours": 4.0,
    "UsedHours": 5.0,
    "FirstName": "sample string 6",
    "LastName": "sample string 7"
  },
  "PtoHistory": {
    "ProviderId": "sample string 1",
    "ParticipantId": "sample string 2",
    "HoursWorked": 3.0,
    "HoursEarned": 4.0,
    "UsedHours": 5.0
  }
}

application/xml, text/xml

Sample:

<GetPtoHistoryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <EarnedPTOBalance>
    <AccruedHours>4</AccruedHours>
    <AvailableHours>3</AvailableHours>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <ParticipantId>sample string 2</ParticipantId>
    <ProviderId>sample string 1</ProviderId>
    <UsedHours>5</UsedHours>
  </EarnedPTOBalance>
  <ProviderId>sample string 1</ProviderId>
  <PtoHistory>
    <HoursEarned>4</HoursEarned>
    <HoursWorked>3</HoursWorked>
    <ParticipantId>sample string 2</ParticipantId>
    <ProviderId>sample string 1</ProviderId>
    <UsedHours>5</UsedHours>
  </PtoHistory>
</GetPtoHistoryResult>