POST api/{programid}/Timesheets/GetTimeEntryRecurrence

Get TimeEntry Recurrence by ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

Program Id

string

Required

Body Parameters

Time entry line information

TimeEntryRecurrenceGetParams
NameDescriptionTypeAdditional information
ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1
}

application/xml, text/xml

Sample:
<TimeEntryRecurrenceGetParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Timesheet">
  <ID>1</ID>
</TimeEntryRecurrenceGetParams>

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

Response Information

Resource Description

TimeEntryRecurrence
NameDescriptionTypeAdditional information
ID

integer

None.

ParticipantId

string

None.

ProviderId

string

None.

ServiceCode

string

None.

TimesheetServiceActivities

Collection of TimesheetServiceActivity

None.

DateWorked

date

None.

TimeIn

date

None.

TimeOut

date

None.

RecurrenceType

integer

None.

StartDate

date

None.

EndDate

date

None.

UseEndDate

boolean

None.

EndAfterNumberOfOccurrences

integer

None.

dailyConfig

DailyConfig

None.

weeklyConfig

WeeklyConfig

None.

monthlyConfig

MonthlyConfig

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "ParticipantId": "sample string 2",
  "ProviderId": "sample string 3",
  "ServiceCode": "sample string 4",
  "TimesheetServiceActivities": [
    {
      "TimesheetNo": "sample string 1",
      "ActivityLineNo": 2,
      "LineNo": 3,
      "ServiceActivityNo": "sample string 4",
      "ServiceCode": "sample string 5",
      "ActivityDescription": "sample string 6"
    },
    {
      "TimesheetNo": "sample string 1",
      "ActivityLineNo": 2,
      "LineNo": 3,
      "ServiceActivityNo": "sample string 4",
      "ServiceCode": "sample string 5",
      "ActivityDescription": "sample string 6"
    }
  ],
  "DateWorked": "2024-11-16T09:39:01.8355698+00:00",
  "TimeIn": "2024-11-16T09:39:01.8355698+00:00",
  "TimeOut": "2024-11-16T09:39:01.8355698+00:00",
  "RecurrenceType": 8,
  "StartDate": "2024-11-16T09:39:01.8355698+00:00",
  "EndDate": "2024-11-16T09:39:01.8355698+00:00",
  "UseEndDate": true,
  "EndAfterNumberOfOccurrences": 12,
  "dailyConfig": {
    "EveryNumberOfDays": 1
  },
  "weeklyConfig": {
    "DaysOfWeek": [
      1,
      2
    ],
    "EveryNumberOfWeeks": 1
  },
  "monthlyConfig": {
    "UseDaysOfMonth": true,
    "DaysOfMonth": [
      1,
      2
    ],
    "NthDayOfWeek": 2,
    "DayOfWeek": 3,
    "EveryNumberOfMonths": 4
  }
}

application/xml, text/xml

Sample:
<TimeEntryRecurrence xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Timesheet">
  <DateWorked>2024-11-16T09:39:01.8355698+00:00</DateWorked>
  <EndAfterNumberOfOccurrences>12</EndAfterNumberOfOccurrences>
  <EndDate>2024-11-16T09:39:01.8355698+00:00</EndDate>
  <ID>1</ID>
  <ParticipantId>sample string 2</ParticipantId>
  <ProviderId>sample string 3</ProviderId>
  <RecurrenceType>8</RecurrenceType>
  <ServiceCode>sample string 4</ServiceCode>
  <StartDate>2024-11-16T09:39:01.8355698+00:00</StartDate>
  <TimeIn>2024-11-16T09:39:01.8355698+00:00</TimeIn>
  <TimeOut>2024-11-16T09:39:01.8355698+00:00</TimeOut>
  <TimesheetServiceActivities xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.Timesheets">
    <d2p1:TimesheetServiceActivity>
      <d2p1:ActivityDescription>sample string 6</d2p1:ActivityDescription>
      <d2p1:ActivityLineNo>2</d2p1:ActivityLineNo>
      <d2p1:LineNo>3</d2p1:LineNo>
      <d2p1:ServiceActivityNo>sample string 4</d2p1:ServiceActivityNo>
      <d2p1:ServiceCode>sample string 5</d2p1:ServiceCode>
      <d2p1:TimesheetNo>sample string 1</d2p1:TimesheetNo>
    </d2p1:TimesheetServiceActivity>
    <d2p1:TimesheetServiceActivity>
      <d2p1:ActivityDescription>sample string 6</d2p1:ActivityDescription>
      <d2p1:ActivityLineNo>2</d2p1:ActivityLineNo>
      <d2p1:LineNo>3</d2p1:LineNo>
      <d2p1:ServiceActivityNo>sample string 4</d2p1:ServiceActivityNo>
      <d2p1:ServiceCode>sample string 5</d2p1:ServiceCode>
      <d2p1:TimesheetNo>sample string 1</d2p1:TimesheetNo>
    </d2p1:TimesheetServiceActivity>
  </TimesheetServiceActivities>
  <UseEndDate>true</UseEndDate>
  <dailyConfig>
    <EveryNumberOfDays>1</EveryNumberOfDays>
  </dailyConfig>
  <monthlyConfig>
    <DayOfWeek>3</DayOfWeek>
    <DaysOfMonth xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfMonth>
    <EveryNumberOfMonths>4</EveryNumberOfMonths>
    <NthDayOfWeek>2</NthDayOfWeek>
    <UseDaysOfMonth>true</UseDaysOfMonth>
  </monthlyConfig>
  <weeklyConfig>
    <DaysOfWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfWeek>
    <EveryNumberOfWeeks>1</EveryNumberOfWeeks>
  </weeklyConfig>
</TimeEntryRecurrence>