Skip to content

Path Operations API Endpoints

Update Site Paths

Endpoint:

POST api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/paths

Description:

It deletes all existing paths for the given site 'siteIdentifier', then inserts the new data provided in the request payload.

Validations
  • Request body must be in geojson format and conform to schema rules. (Click here to view schema rules)
  • TypeCode should be type of "Paths".
  • Fid is required and must be unique.
  • Sid is required.
  • Bid is required.
  • Lvl is required.
  • SiteIdentifier given from url must match sid.

Requests:

{
    "type": "FeatureCollection",
    "features": [
    {
        "type": "Feature",
        "properties": {
        "neighbors": [
            {
            "fid": "94abf645-9baa-4783-86c9-95c25dee06a2",
            "speed": 1
            }
        ],
        "transitionNeighbors": [
            {
            "fid": "64ba261d-5294-4928-bfed-683ac020da05"
            }
        ],
        "transitionGroupId": "ac3833d5-fa50-4cfc-8f44-8093bcd6e9a1",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "267f8d1f-6e2f-4d46-9ea8-c63886a860da"
        },
        "geometry": {
        "type": "Point",
        "coordinates": [-104.8390169, 39.74310121]
        }
    },
    {
        "type": "Feature",
        "properties": {
        "neighbors": [
            {
            "fid": "0c73d430-fa26-4732-8673-8ee9684d8854",
            "speed": 1
            }
        ],
        "transitionNeighbors": [
            {
            "fid": "e5d5523c-683f-44ba-93d5-f130de0fb1e0"
            }
        ],
        "transitionGroupId": "46a57074-f276-483b-af5f-a9621e3b8143",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "93dcde0f-2c5c-499a-97c2-389769fca16b"
        },
        "geometry": {
        "type": "Point",
        "coordinates": [-104.83979418, 39.74242685]
        }
    }
    ]
}

Success Response:

{
  "message": "Paths for site '{siteIdentifier}' were successfully processed."
}

Notes:

  • If you want to add an outdoor path, you should add "isOutdoor": true in properties, also properties should not contain "bid" and "lvl".


* You can access the possible response codes you may encounter here.

Delete Site Paths

Endpoint:

DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/paths

Description:
Deletes all features classified as path of the selected site.

Success Response:

{
  "message": "Paths for site '{siteIdentifier}' were successfully deleted."
}


* You can access the possible response codes you may encounter here.

Get Draft Site Paths

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/paths

Description:
Returns all draft features classified as path of the selected site.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "94abf645-9baa-4783-86c9-95c25dee06a2",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "64ba261d-5294-4928-bfed-683ac020da05"
          }
        ],
        "transitionGroupId": "ac3833d5-fa50-4cfc-8f44-8093bcd6e9a1",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "267f8d1f-6e2f-4d46-9ea8-c63886a860da"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.8390169, 39.74310121]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "0c73d430-fa26-4732-8673-8ee9684d8854",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "e5d5523c-683f-44ba-93d5-f130de0fb1e0"
          }
        ],
        "transitionGroupId": "46a57074-f276-483b-af5f-a9621e3b8143",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "93dcde0f-2c5c-499a-97c2-389769fca16b"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.83979418, 39.74242685]
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.

Get Draft Building Paths

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/paths

Description:
Returns all draft features classified as path of the selected building.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "94abf645-9baa-4783-86c9-95c25dee06a2",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "64ba261d-5294-4928-bfed-683ac020da05"
          }
        ],
        "transitionGroupId": "ac3833d5-fa50-4cfc-8f44-8093bcd6e9a1",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "267f8d1f-6e2f-4d46-9ea8-c63886a860da"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.8390169, 39.74310121]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "0c73d430-fa26-4732-8673-8ee9684d8854",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "e5d5523c-683f-44ba-93d5-f130de0fb1e0"
          }
        ],
        "transitionGroupId": "46a57074-f276-483b-af5f-a9621e3b8143",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "93dcde0f-2c5c-499a-97c2-389769fca16b"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.83979418, 39.74242685]
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.

Get Draft Level Paths

Endpoint:

GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/paths

Description:
Returns all draft features classified as path of the selected level.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "94abf645-9baa-4783-86c9-95c25dee06a2",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "64ba261d-5294-4928-bfed-683ac020da05"
          }
        ],
        "transitionGroupId": "ac3833d5-fa50-4cfc-8f44-8093bcd6e9a1",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "267f8d1f-6e2f-4d46-9ea8-c63886a860da"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.8390169, 39.74310121]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "0c73d430-fa26-4732-8673-8ee9684d8854",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "e5d5523c-683f-44ba-93d5-f130de0fb1e0"
          }
        ],
        "transitionGroupId": "46a57074-f276-483b-af5f-a9621e3b8143",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "93dcde0f-2c5c-499a-97c2-389769fca16b"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.83979418, 39.74242685]
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.

Get Published Site Paths

Endpoint:

GET api/v9/content/published/clients/{clientIdentifier}/sites/{siteIdentifier}/paths

Description:
Returns published features classified as path of the selected site.

Success Response:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "94abf645-9baa-4783-86c9-95c25dee06a2",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "64ba261d-5294-4928-bfed-683ac020da05"
          }
        ],
        "transitionGroupId": "ac3833d5-fa50-4cfc-8f44-8093bcd6e9a1",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "267f8d1f-6e2f-4d46-9ea8-c63886a860da"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.8390169, 39.74310121]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "neighbors": [
          {
            "fid": "0c73d430-fa26-4732-8673-8ee9684d8854",
            "speed": 1
          }
        ],
        "transitionNeighbors": [
          {
            "fid": "e5d5523c-683f-44ba-93d5-f130de0fb1e0"
          }
        ],
        "transitionGroupId": "46a57074-f276-483b-af5f-a9621e3b8143",
        "typeCode": "custom-transition",
        "travelTime": 10,
        "isAccessible": true,
        "isComfortable": true,
        "name": "corridor",
        "eid": "eid",
        "sid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "bid": "94abf645-9baa-4783-86c9-95c25dee06a2",
        "lvl": 1,
        "fid": "93dcde0f-2c5c-499a-97c2-389769fca16b"
      },
      "geometry": {
        "type": "Point",
        "coordinates": [-104.83979418, 39.74242685]
      }
    }
  ]
}


* You can access the possible response codes you may encounter here.