POST api/{programid}/Timesheets/RecentEarningsSnapshot

Retrieves Recent Earnings Snapshot data for Time Entries Dashboard

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required

Body Parameters

RecentEarningsSnapshotFiltersDTO

Name	Type	Additional information
ServiceCodes	Collection of string	None.
ParticipantIDs	Collection of string	None.
ProviderIDs	Collection of string	None.
PayPeriods	Collection of PayPeriod	None.
Flags	Collection of Flag	None.
WorkedDateRange	WorkedDateRange	None.
ExternalReferenceId	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "ServiceCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "ParticipantIDs": [
    "sample string 1",
    "sample string 2"
  ],
  "ProviderIDs": [
    "sample string 1",
    "sample string 2"
  ],
  "PayPeriods": [
    {
      "PayPeriodStart": "2024-11-16T04:59:23.7707226-05:00",
      "PayPeriodEnd": "2024-11-16T04:59:23.7707226-05:00"
    },
    {
      "PayPeriodStart": "2024-11-16T04:59:23.7707226-05:00",
      "PayPeriodEnd": "2024-11-16T04:59:23.7707226-05:00"
    }
  ],
  "Flags": [
    {
      "FlagName": "sample string 1",
      "FlagValue": "sample string 2"
    },
    {
      "FlagName": "sample string 1",
      "FlagValue": "sample string 2"
    }
  ],
  "WorkedDateRange": {
    "WorkedBeginDate": "2024-11-16T04:59:23.7707226-05:00",
    "WorkedEndDate": "2024-11-16T04:59:23.7707226-05:00"
  },
  "ExternalReferenceId": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<RecentEarningsSnapshotFiltersDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <ExternalReferenceId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExternalReferenceId>
  <Flags>
    <Flag>
      <FlagName>sample string 1</FlagName>
      <FlagValue>sample string 2</FlagValue>
    </Flag>
    <Flag>
      <FlagName>sample string 1</FlagName>
      <FlagValue>sample string 2</FlagValue>
    </Flag>
  </Flags>
  <ParticipantIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ParticipantIDs>
  <PayPeriods>
    <PayPeriod>
      <PayPeriodEnd>2024-11-16T04:59:23.7707226-05:00</PayPeriodEnd>
      <PayPeriodStart>2024-11-16T04:59:23.7707226-05:00</PayPeriodStart>
    </PayPeriod>
    <PayPeriod>
      <PayPeriodEnd>2024-11-16T04:59:23.7707226-05:00</PayPeriodEnd>
      <PayPeriodStart>2024-11-16T04:59:23.7707226-05:00</PayPeriodStart>
    </PayPeriod>
  </PayPeriods>
  <ProviderIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ProviderIDs>
  <ServiceCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ServiceCodes>
  <WorkedDateRange>
    <WorkedBeginDate>2024-11-16T04:59:23.7707226-05:00</WorkedBeginDate>
    <WorkedEndDate>2024-11-16T04:59:23.7707226-05:00</WorkedEndDate>
  </WorkedDateRange>
</RecentEarningsSnapshotFiltersDTO>

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

Response Information

Resource Description

RecentEarningsSnapshotSearchResultDTO

Name	Type	Additional information
TotalSubmitted	decimal number	None.
TotalApproved	decimal number	None.
TotalInProcess	decimal number	None.
TotalPaid	decimal number	None.
TotalPotentialEarnings	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalSubmitted": 1.0,
  "TotalApproved": 2.0,
  "TotalInProcess": 3.0,
  "TotalPaid": 4.0,
  "TotalPotentialEarnings": 5.0
}

application/xml, text/xml

Sample:

<RecentEarningsSnapshotSearchResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <TotalApproved>2</TotalApproved>
  <TotalInProcess>3</TotalInProcess>
  <TotalPaid>4</TotalPaid>
  <TotalPotentialEarnings>5</TotalPotentialEarnings>
  <TotalSubmitted>1</TotalSubmitted>
</RecentEarningsSnapshotSearchResultDTO>