POST api/{programid}/Timesheets/GetUnpaidLeave

Call to get Unpaid Leave data

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	The Program ID	string	Required

Body Parameters

The Consumer No

GetUnpaidLeaveFilterDTO

Name	Type	Additional information
ParticipantID	string	None.
ProviderID	string	None.
EmployerId	string	None.
ProviderCity	string	None.
PayControlCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ParticipantID": "sample string 1",
  "ProviderID": "sample string 2",
  "EmployerId": "sample string 3",
  "ProviderCity": "sample string 4",
  "PayControlCode": "sample string 5"
}

application/xml, text/xml

Sample:

<GetUnpaidLeaveFilterDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <EmployerId>sample string 3</EmployerId>
  <ParticipantID>sample string 1</ParticipantID>
  <PayControlCode>sample string 5</PayControlCode>
  <ProviderCity>sample string 4</ProviderCity>
  <ProviderID>sample string 2</ProviderID>
</GetUnpaidLeaveFilterDTO>

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

Response Information

Resource Description

A List UnpaidLeave Objects

Collection of UnpaidLeave

Name	Type	Additional information
Consumer	string	None.
Provider	string	None.
Eligibility	string	None.
Carryover	decimal number	None.
Accrued	decimal number	None.
Used	decimal number	None.
Balance	decimal number	None.
Available	decimal number	None.
Employer	string	None.
HoursWorkedPerDay	decimal number	None.
Cap	decimal number	None.
EffectiveDate	date	None.
CalculatedCap	decimal number	None.
AdjustedCap	decimal number	None.
CalculatedUsageCap	decimal number	None.
AdjustedUsageCap	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Consumer": "sample string 1",
    "Provider": "sample string 2",
    "Eligibility": "sample string 3",
    "Carryover": 4.0,
    "Accrued": 5.0,
    "Used": 6.0,
    "Balance": 7.0,
    "Available": 8.0,
    "Employer": "sample string 9",
    "HoursWorkedPerDay": 10.0,
    "Cap": 11.0,
    "EffectiveDate": "2025-09-09T22:44:23.4366404-04:00",
    "CalculatedCap": 13.0,
    "AdjustedCap": 14.0,
    "CalculatedUsageCap": 15.0,
    "AdjustedUsageCap": 16.0
  },
  {
    "Consumer": "sample string 1",
    "Provider": "sample string 2",
    "Eligibility": "sample string 3",
    "Carryover": 4.0,
    "Accrued": 5.0,
    "Used": 6.0,
    "Balance": 7.0,
    "Available": 8.0,
    "Employer": "sample string 9",
    "HoursWorkedPerDay": 10.0,
    "Cap": 11.0,
    "EffectiveDate": "2025-09-09T22:44:23.4366404-04:00",
    "CalculatedCap": 13.0,
    "AdjustedCap": 14.0,
    "CalculatedUsageCap": 15.0,
    "AdjustedUsageCap": 16.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfUnpaidLeave xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <UnpaidLeave>
    <Accrued>5</Accrued>
    <AdjustedCap>14</AdjustedCap>
    <AdjustedUsageCap>16</AdjustedUsageCap>
    <Available>8</Available>
    <Balance>7</Balance>
    <CalculatedCap>13</CalculatedCap>
    <CalculatedUsageCap>15</CalculatedUsageCap>
    <Cap>11</Cap>
    <Carryover>4</Carryover>
    <Consumer>sample string 1</Consumer>
    <EffectiveDate>2025-09-09T22:44:23.4366404-04:00</EffectiveDate>
    <Eligibility>sample string 3</Eligibility>
    <Employer>sample string 9</Employer>
    <HoursWorkedPerDay>10</HoursWorkedPerDay>
    <Provider>sample string 2</Provider>
    <Used>6</Used>
  </UnpaidLeave>
  <UnpaidLeave>
    <Accrued>5</Accrued>
    <AdjustedCap>14</AdjustedCap>
    <AdjustedUsageCap>16</AdjustedUsageCap>
    <Available>8</Available>
    <Balance>7</Balance>
    <CalculatedCap>13</CalculatedCap>
    <CalculatedUsageCap>15</CalculatedUsageCap>
    <Cap>11</Cap>
    <Carryover>4</Carryover>
    <Consumer>sample string 1</Consumer>
    <EffectiveDate>2025-09-09T22:44:23.4366404-04:00</EffectiveDate>
    <Eligibility>sample string 3</Eligibility>
    <Employer>sample string 9</Employer>
    <HoursWorkedPerDay>10</HoursWorkedPerDay>
    <Provider>sample string 2</Provider>
    <Used>6</Used>
  </UnpaidLeave>
</ArrayOfUnpaidLeave>