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

View earned PTO balance for a speicific provider for each participant.

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

EarnedPtoBalanceGetParams

Name	Description	Type	Additional information
ProviderId		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProviderId": "sample string 1"
}

application/xml, text/xml

Sample:

<EarnedPtoBalanceGetParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Timesheet">
  <ProviderId>sample string 1</ProviderId>
</EarnedPtoBalanceGetParams>

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 'EarnedPtoBalanceGetParams'.

Response Information

Resource Description

GetEarnedPtoBalanceResult

Name	Description	Type	Additional information
ProviderId		string	None.
EarnedPTOBalances		Collection of EarnedPtoBalance	None.

Response Formats

application/json, text/json

Sample:

{
  "ProviderId": "sample string 1",
  "EarnedPTOBalances": [
    {
      "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"
    },
    {
      "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"
    }
  ]
}

application/xml, text/xml

Sample:

<GetEarnedPtoBalanceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <EarnedPTOBalances>
    <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>
    <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>
  </EarnedPTOBalances>
  <ProviderId>sample string 1</ProviderId>
</GetEarnedPtoBalanceResult>