POST api/V3/EmployeeJourney/CreateRoutePlan

Creates a Route Plan

Request Information

URI Parameters

None.

Body Parameters

V3.RoutePlan
NameDescriptionTypeAdditional information
ESMErpId

ErpId of the employee

 string

Required
StartDate

Date when the Route Plan is calculated from. Format yyyy-mm-dd e.g. 2018-01-21

 date

Required
EffectiveDate

Date when the Route Plan is Effected from. Format yyyy-mm-dd e.g. 2018-01-21

 date

Required
EndDate

Date After which this plan will be invalid (Optional)

 date

None.
RoutePlanDay

Details of Days and week defined in Route Plan

 Collection of RoutePlanItem

Required

Request Formats

application/json, text/json

Sample: 
{
  "ESMErpId": "sample string 1",
  "StartDate": "2025-04-04T05:17:58.8950911+00:00",
  "EffectiveDate": "2025-04-04T05:17:58.8950911+00:00",
  "EndDate": "2025-04-04T05:17:58.8950911+00:00",
  "RoutePlanDay": [
    {
      "RouteErpId": "sample string 1",
      "WeekNumber": 2,
      "DayNumber": 3,
      "Type": "sample string 4",
      "Reason": "sample string 5",
      "JWFieldUserErpID": "sample string 6"
    },
    {
      "RouteErpId": "sample string 1",
      "WeekNumber": 2,
      "DayNumber": 3,
      "Type": "sample string 4",
      "Reason": "sample string 5",
      "JWFieldUserErpID": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample: 
<RoutePlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <ESMErpId>sample string 1</ESMErpId>
  <EffectiveDate>2025-04-04T05:17:58.8950911+00:00</EffectiveDate>
  <EndDate>2025-04-04T05:17:58.8950911+00:00</EndDate>
  <RoutePlanDay>
    <RoutePlanItem>
      <DayNumber>3</DayNumber>
      <JWFieldUserErpID>sample string 6</JWFieldUserErpID>
      <Reason>sample string 5</Reason>
      <RouteErpId>sample string 1</RouteErpId>
      <Type>sample string 4</Type>
      <WeekNumber>2</WeekNumber>
    </RoutePlanItem>
    <RoutePlanItem>
      <DayNumber>3</DayNumber>
      <JWFieldUserErpID>sample string 6</JWFieldUserErpID>
      <Reason>sample string 5</Reason>
      <RouteErpId>sample string 1</RouteErpId>
      <Type>sample string 4</Type>
      <WeekNumber>2</WeekNumber>
    </RoutePlanItem>
  </RoutePlanDay>
  <StartDate>2025-04-04T05:17:58.8950911+00:00</StartDate>
</RoutePlan>

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>