POST api/{programid}/TimeEntry/GetMealBreakInfo

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

string

Required

Body Parameters

MealBreakCheckRequest
NameDescriptionTypeAdditional information
ProgramId

integer

None.

ProviderId

string

None.

ProgramCode

string

None.

StartTime

date

None.

EndTime

date

None.

ParticipantId

string

None.

ServiceCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ProgramId": 1,
  "ProviderId": "sample string 2",
  "ProgramCode": "sample string 3",
  "StartTime": "2026-07-13T11:10:13.4015192-04:00",
  "EndTime": "2026-07-13T11:10:13.4015192-04:00",
  "ParticipantId": "sample string 4",
  "ServiceCode": "sample string 5"
}

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-07-13T11:10:13.4015192-04:00</EndTime>
  <ParticipantId>sample string 4</ParticipantId>
  <ProgramCode>sample string 3</ProgramCode>
  <ProgramId>1</ProgramId>
  <ProviderId>sample string 2</ProviderId>
  <ServiceCode>sample string 5</ServiceCode>
  <StartTime>2026-07-13T11:10:13.4015192-04:00</StartTime>
</MealBreakCheckRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of MealBreakCheckResponse
NameDescriptionTypeAdditional information
TimeEntryId

integer

None.

ShiftId

string

None.

ShiftDate

date

None.

HasOnDutyAgreement

boolean

None.

MealBreaks

Collection of MealBreakQuestion

None.

UnpaidBreakCount

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TimeEntryId": 1,
    "ShiftId": "sample string 2",
    "ShiftDate": "2026-07-13T11:10:13.4171748-04:00",
    "HasOnDutyAgreement": true,
    "MealBreaks": [
      {
        "BreakId": "sample string 1"
      },
      {
        "BreakId": "sample string 1"
      }
    ],
    "UnpaidBreakCount": 4
  },
  {
    "TimeEntryId": 1,
    "ShiftId": "sample string 2",
    "ShiftDate": "2026-07-13T11:10:13.4171748-04:00",
    "HasOnDutyAgreement": true,
    "MealBreaks": [
      {
        "BreakId": "sample string 1"
      },
      {
        "BreakId": "sample string 1"
      }
    ],
    "UnpaidBreakCount": 4
  }
]

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>
    <MealBreaks>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
      </MealBreakQuestion>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
      </MealBreakQuestion>
    </MealBreaks>
    <ShiftDate>2026-07-13T11:10:13.4171748-04:00</ShiftDate>
    <ShiftId>sample string 2</ShiftId>
    <TimeEntryId>1</TimeEntryId>
    <UnpaidBreakCount>4</UnpaidBreakCount>
  </MealBreakCheckResponse>
  <MealBreakCheckResponse>
    <HasOnDutyAgreement>true</HasOnDutyAgreement>
    <MealBreaks>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
      </MealBreakQuestion>
      <MealBreakQuestion>
        <BreakId>sample string 1</BreakId>
      </MealBreakQuestion>
    </MealBreaks>
    <ShiftDate>2026-07-13T11:10:13.4171748-04:00</ShiftDate>
    <ShiftId>sample string 2</ShiftId>
    <TimeEntryId>1</TimeEntryId>
    <UnpaidBreakCount>4</UnpaidBreakCount>
  </MealBreakCheckResponse>
</ArrayOfMealBreakCheckResponse>