POST api/V3/Employee/{EmployeeERPId}/AddBeatPlan

Upload the beat plan for the employee

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EmployeeERPId

EmployeeId of the Employee

 string

Required

Body Parameters

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 EmployeeBeatPlanItem

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<EmployeeBeatPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models">
  <Duration>2</Duration>
  <Items>
    <EmployeeBeatPlanItem>
      <Beat>sample string 2</Beat>
      <Day>1</Day>
    </EmployeeBeatPlanItem>
    <EmployeeBeatPlanItem>
      <Beat>sample string 2</Beat>
      <Day>1</Day>
    </EmployeeBeatPlanItem>
  </Items>
  <StartDate>2025-04-04T05:24:41.1235497+00:00</StartDate>
</EmployeeBeatPlan>

Response Information

Resource Description

ApiResponseMessage
NameDescriptionTypeAdditional information
ERPId

ERPID of the Requested insertion/updation

 string

None.
Message

Error Message for the indicated ERPID

 string

None.
ResponseStatus

Status of the action requested from Api

 ResponseStatus

None.
GUID

GUID of the database Entry with respect to the ERP Id Provided

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ERPId": "sample string 1",
  "Message": "sample string 2",
  "ResponseStatus": "Failure",
  "GUID": "sample string 3"
}

application/xml, text/xml

Sample: 
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <ERPId>sample string 1</ERPId>
  <GUID>sample string 3</GUID>
  <Message>sample string 2</Message>
  <ResponseStatus>Failure</ResponseStatus>
</ApiResponseMessage>