GET api/V3/Employee/{EmployeeERPId}/GetBeatPlan

Get the BeatPlan of the employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EmployeeERPId

EmployeeId of the Employee

 string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of V3.EmployeeBeatPlan
NameDescriptionTypeAdditional information
StartDate

Date when the beat plan starts from. Format yyyy-mm-dd e.g. 2014-04-21

 date

None.
Duration

Duration of the beat plan. e.g. 14 for a 14 days plan.

 integer

None.
Items

Beat plan items.

 Collection of V3.EmployeeBeatPlanItem

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "StartDate": "2025-04-04T05:22:19.0982444+00:00",
    "Duration": 2,
    "Items": [
      {
        "Day": 1,
        "Beat": "sample string 2"
      },
      {
        "Day": 1,
        "Beat": "sample string 2"
      }
    ]
  },
  {
    "StartDate": "2025-04-04T05:22:19.0982444+00:00",
    "Duration": 2,
    "Items": [
      {
        "Day": 1,
        "Beat": "sample string 2"
      },
      {
        "Day": 1,
        "Beat": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfEmployeeBeatPlans xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <EmployeeBeatPlans>
    <Duration>2</Duration>
    <Items>
      <EmployeeBeatPlanItems>
        <Beat>sample string 2</Beat>
        <Day>1</Day>
      </EmployeeBeatPlanItems>
      <EmployeeBeatPlanItems>
        <Beat>sample string 2</Beat>
        <Day>1</Day>
      </EmployeeBeatPlanItems>
    </Items>
    <StartDate>2025-04-04T05:22:19.0982444+00:00</StartDate>
  </EmployeeBeatPlans>
  <EmployeeBeatPlans>
    <Duration>2</Duration>
    <Items>
      <EmployeeBeatPlanItems>
        <Beat>sample string 2</Beat>
        <Day>1</Day>
      </EmployeeBeatPlanItems>
      <EmployeeBeatPlanItems>
        <Beat>sample string 2</Beat>
        <Day>1</Day>
      </EmployeeBeatPlanItems>
    </Items>
    <StartDate>2025-04-04T05:22:19.0982444+00:00</StartDate>
  </EmployeeBeatPlans>
</ArrayOfEmployeeBeatPlans>