POST api/V3/EmployeeJourney/CreateRoute

Creates a Route Plan

Request Information

URI Parameters

None.

Body Parameters

V3.Route
NameDescriptionTypeAdditional information
Outlets

List of Outlets in the Route

 Collection of string

Required
ErpId

ErpId of the employee

 string

Required
Name

Date After which this plan will be invalid

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "Outlets": [
    "sample string 1",
    "sample string 2"
  ],
  "ErpId": "sample string 1",
  "Name": "sample string 2"
}

application/xml, text/xml

Sample: 
<Route xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <ErpId>sample string 1</ErpId>
  <Name>sample string 2</Name>
  <Outlets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Outlets>
</Route>

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>