(Quick Reference) Service: Upsert a route

Description: This web service is used to insert a route object to the database if it does not already exist, or update it.

URL with external_id:


Method: POST

Request content type: application/json


NameDescriptionTypeRequiredExample values
namethe name of the new routeStringYes 
geographicLocationIdthe id of region which the route will be associatedLongNo 

geographicLocationId must be an ID of a leaf region located within the geographical positions’ hierarchical tree
reference must be unique

Success Output

Success case: response.status = 201
  "id": 2,
  "reference": "R-RT-001",
  "name": "fast and furious",
  "geographicLocation": {
    "id": 3,
    "name": "Nice",
    "href": "/api/v1.0/regions/3"
  "organization": "entity1",
  "dateCreated": "2016-10-17T14:05:54Z",
  "lastUpdated": "2016-10-18T09:52:10Z"

Failure Output

Failure case:response.status = 400
  "error": "invalid_param_type",
  "error_description": "The type of parameter geographicLocationId you provided is not valid for this request."
  "error": "missing_param",
  "error_description": "name parameter is missing"
  "error": "not_unique",
  "error_description": "reference already used"
  "error": "save_failed",
  "error_description": "Failed to save instance"

Failure case:response.status = 404
  "error": "not_found",
  "error_description": "The geographic location with the id 999 doesn't exist."

Failure case:response.status = 500
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."