Mileage - Create new route

API Url

Used for creating a new mileage route.

POST
http://localhost:16010/ProMarkREST/rest/Mileage/employees/{emp_id}/routes

Permissions: user

Path parameters

FieldTypeDescription
emp_idString

Employee ID.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    routesObject[]

Collection of routes

      distanceNumber

Distance of a route

      fromString

Starting position of a route.

      nameString

A name for the route

      toString

Ending position of a route.

      viaoptionalString

Alternate route.

Request example:

{
"request": {
"data": {
"routes": [
{
"name": "KICKOFF",
"from": "Bucharest",
"to": "Copenhagen",
"distance" : 2137
}
]
}
}
}

Success 200

FieldTypeDescription
    routesObject[]

Collection of routes

      distanceNumber

Distance of a route

      fromString

Starting position of a route.

      idNumber

Unique id for a route

      nameString

A name for the route

      toString

Ending position of a route.

      viaoptionalString

Alternate route.

responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"routes": [
{
"id": 123424,
"name": "KICKOFF"
"from": "Bucharest",
"to": "Copenhagen",
"distance" : 2137
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

{
"response": {
"errorCode": 33
"errorMessage": "Route already exists"
}
}