POST api/V3/EmployeeJourney/DeactivateRoutePlan

Deactivates a Route Plan

Request Information

URI Parameters

None.

Body Parameters

V3.RoutePlanDeactivation
NameDescriptionTypeAdditional information
ESMErpId

ErpId of the employee

 string

Required
EndDate

Date After which this plan will be invalid

 date

Required

Request Formats

application/json, text/json

Sample: 
{
  "ESMErpId": "sample string 1",
  "EndDate": "2025-04-04T05:28:30.6780454+00:00"
}

application/xml, text/xml

Sample: 
<RoutePlanDeactivation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <ESMErpId>sample string 1</ESMErpId>
  <EndDate>2025-04-04T05:28:30.6780454+00:00</EndDate>
</RoutePlanDeactivation>

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>