POST api/{programid}/TimeEntry/GetMealBreakInfo

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

MealBreakCheckRequest

Name	Type	Additional information
ProgramId	integer	None.
ProviderId	string	None.
ProgramCode	string	None.
StartTime	date	None.
EndTime	date	None.
ParticipantId	string	None.
ServiceCode	string	None.
TimesheetId	string	None.
TimeEntryId	integer	None.
ShiftId	string	None.
ReviewSavedAnswers	boolean	None.
ExcludeCurrentEntry	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ProgramId": 1,
  "ProviderId": "sample string 2",
  "ProgramCode": "sample string 3",
  "StartTime": "2026-10-17T18:33:40.1162856-04:00",
  "EndTime": "2026-10-17T18:33:40.1162856-04:00",
  "ParticipantId": "sample string 4",
  "ServiceCode": "sample string 5",
  "TimesheetId": "sample string 6",
  "TimeEntryId": 1,
  "ShiftId": "sample string 7",
  "ReviewSavedAnswers": true,
  "ExcludeCurrentEntry": true
}

application/xml, text/xml

Sample:

<MealBreakCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO">
  <EndTime>2026-10-17T18:33:40.1162856-04:00</EndTime>
  <ExcludeCurrentEntry>true</ExcludeCurrentEntry>
  <ParticipantId>sample string 4</ParticipantId>
  <ProgramCode>sample string 3</ProgramCode>
  <ProgramId>1</ProgramId>
  <ProviderId>sample string 2</ProviderId>
  <ReviewSavedAnswers>true</ReviewSavedAnswers>
  <ServiceCode>sample string 5</ServiceCode>
  <ShiftId>sample string 7</ShiftId>
  <StartTime>2026-10-17T18:33:40.1162856-04:00</StartTime>
  <TimeEntryId>1</TimeEntryId>
  <TimesheetId>sample string 6</TimesheetId>
</MealBreakCheckRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of MealBreakCheckResponse

Name	Type	Additional information
TimeEntryId	integer	None.
ShiftId	string	None.
ShiftDate	date	None.
HasOnDutyAgreement	boolean	None.
MealBreaks	Collection of MealBreakQuestion	None.
UnpaidBreakCount	integer	None.
RestBreakCount	integer	None.
IsAmendmentReview	boolean	None.
ReviewedTimesheetId	string	None.
ReviewedLineId2	integer	None.
SavedRestBreakTaken	boolean	None.
SavedRestBreakCount	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "TimeEntryId": 1,
    "ShiftId": "sample string 2",
    "ShiftDate": "2026-10-17T18:33:40.1162856-04:00",
    "HasOnDutyAgreement": true,
    "MealBreaks": [
      {
        "BreakId": "sample string 1",
        "CanWaive": true,
        "SavedTookABreak": true,
        "SavedIsWaived": true,
        "SavedBreakStart": "2026-10-17T18:33:40.1162856-04:00",
        "SavedBreakEnd": "2026-10-17T18:33:40.1162856-04:00"
      },
      {
        "BreakId": "sample string 1",
        "CanWaive": true,
        "SavedTookABreak": true,
        "SavedIsWaived": true,
        "SavedBreakStart": "2026-10-17T18:33:40.1162856-04:00",
        "SavedBreakEnd": "2026-10-17T18:33:40.1162856-04:00"
      }
    ],
    "UnpaidBreakCount": 4,
    "RestBreakCount": 1,
    "IsAmendmentReview": true,
    "ReviewedTimesheetId": "sample string 6",
    "ReviewedLineId2": 1,
    "SavedRestBreakTaken": true,
    "SavedRestBreakCount": 1
  },
  {
    "TimeEntryId": 1,
    "ShiftId": "sample string 2",
    "ShiftDate": "2026-10-17T18:33:40.1162856-04:00",
    "HasOnDutyAgreement": true,
    "MealBreaks": [
      {
        "BreakId": "sample string 1",
        "CanWaive": true,
        "SavedTookABreak": true,
        "SavedIsWaived": true,
        "SavedBreakStart": "2026-10-17T18:33:40.1162856-04:00",
        "SavedBreakEnd": "2026-10-17T18:33:40.1162856-04:00"
      },
      {
        "BreakId": "sample string 1",
        "CanWaive": true,
        "SavedTookABreak": true,
        "SavedIsWaived": true,
        "SavedBreakStart": "2026-10-17T18:33:40.1162856-04:00",
        "SavedBreakEnd": "2026-10-17T18:33:40.1162856-04:00"
      }
    ],
    "UnpaidBreakCount": 4,
    "RestBreakCount": 1,
    "IsAmendmentReview": true,
    "ReviewedTimesheetId": "sample string 6",
    "ReviewedLineId2": 1,
    "SavedRestBreakTaken": true,
    "SavedRestBreakCount": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfMealBreakCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO">
  <MealBreakCheckResponse>
    <HasOnDutyAgreement>true</HasOnDutyAgreement>
    <IsAmendmentReview>true</IsAmendmentReview>
    <MealBreaks>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
        <CanWaive>true</CanWaive>
        <SavedBreakEnd>2026-10-17T18:33:40.1162856-04:00</SavedBreakEnd>
        <SavedBreakStart>2026-10-17T18:33:40.1162856-04:00</SavedBreakStart>
        <SavedIsWaived>true</SavedIsWaived>
        <SavedTookABreak>true</SavedTookABreak>
      </MealBreakQuestion>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
        <CanWaive>true</CanWaive>
        <SavedBreakEnd>2026-10-17T18:33:40.1162856-04:00</SavedBreakEnd>
        <SavedBreakStart>2026-10-17T18:33:40.1162856-04:00</SavedBreakStart>
        <SavedIsWaived>true</SavedIsWaived>
        <SavedTookABreak>true</SavedTookABreak>
      </MealBreakQuestion>
    </MealBreaks>
    <RestBreakCount>1</RestBreakCount>
    <ReviewedLineId2>1</ReviewedLineId2>
    <ReviewedTimesheetId>sample string 6</ReviewedTimesheetId>
    <SavedRestBreakCount>1</SavedRestBreakCount>
    <SavedRestBreakTaken>true</SavedRestBreakTaken>
    <ShiftDate>2026-10-17T18:33:40.1162856-04:00</ShiftDate>
    <ShiftId>sample string 2</ShiftId>
    <TimeEntryId>1</TimeEntryId>
    <UnpaidBreakCount>4</UnpaidBreakCount>
  </MealBreakCheckResponse>
  <MealBreakCheckResponse>
    <HasOnDutyAgreement>true</HasOnDutyAgreement>
    <IsAmendmentReview>true</IsAmendmentReview>
    <MealBreaks>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
        <CanWaive>true</CanWaive>
        <SavedBreakEnd>2026-10-17T18:33:40.1162856-04:00</SavedBreakEnd>
        <SavedBreakStart>2026-10-17T18:33:40.1162856-04:00</SavedBreakStart>
        <SavedIsWaived>true</SavedIsWaived>
        <SavedTookABreak>true</SavedTookABreak>
      </MealBreakQuestion>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
        <CanWaive>true</CanWaive>
        <SavedBreakEnd>2026-10-17T18:33:40.1162856-04:00</SavedBreakEnd>
        <SavedBreakStart>2026-10-17T18:33:40.1162856-04:00</SavedBreakStart>
        <SavedIsWaived>true</SavedIsWaived>
        <SavedTookABreak>true</SavedTookABreak>
      </MealBreakQuestion>
    </MealBreaks>
    <RestBreakCount>1</RestBreakCount>
    <ReviewedLineId2>1</ReviewedLineId2>
    <ReviewedTimesheetId>sample string 6</ReviewedTimesheetId>
    <SavedRestBreakCount>1</SavedRestBreakCount>
    <SavedRestBreakTaken>true</SavedRestBreakTaken>
    <ShiftDate>2026-10-17T18:33:40.1162856-04:00</ShiftDate>
    <ShiftId>sample string 2</ShiftId>
    <TimeEntryId>1</TimeEntryId>
    <UnpaidBreakCount>4</UnpaidBreakCount>
  </MealBreakCheckResponse>
</ArrayOfMealBreakCheckResponse>