PWS (Pathfinding Web Services) API Endpoints
Get Route Between Points
Endpoint:
GET /api/v9/pws/clients/{clientIdentifier}/sites/{siteIdentifier}/route
Description:
This is the main endpoint that comprises the wayfinding service. POI-related parameters can be supplied standalone for either start/dest, while the point-based parameters (lat/lon/building/level) have to be supplied together. Building parameters are optional, if not provided building(s) is resolved automatically via checking which building geometry the given geo-coordinates correspond to.
Query Parameters:
# startPointLon - Longitude of the start point POI.
# startPointLat - Latitude of the start point.
# startPointLevel - Level of the start point.
# startPointBuilding - Building identifier for the start point.
# destPointLon - Longitude of the destination point POI.
# destPointLat - Latitude of the destination point.
# destPointLevel - Level of the destination point.
# destPointBuilding - Building identifier for the destination point.
# startPoiFid - Feature ID of the start point.
# destPoiFid - Feature ID of the destination point.
# startPoiEid - Entity ID of the start point.
# destPoiEid - Entity ID of the destination point.
# mode - Accessible, Comfortable or Normal.
Success Response:
{
"directions": {
"features": [
{
"geometry": {
"coordinates": [
-104.83955591,
39.74238537
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"distanceUntilMeters": 10.387759916923965,
"lvl": 1,
"message": "Exit Sample Building",
"sid": "00000000-0000-0000-0000-000000000003",
"timeUntilSeconds": 10.387759916923965,
"transitionInfo": {
"groupId": "8bc0b0aa-7050-41b5-b003-fa969668cc85",
"isAccessible": true,
"isComfortable": true,
"name": "Building Entrance-Exit",
"travelTime": 1,
"typeCode": "building-entrance-exit"
},
"turnAngleRadians": 0,
"type": "ExitBuilding"
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83949931,
39.74234647
],
"type": "Point"
},
"properties": {
"bid": null,
"distanceUntilMeters": 6.494367888744703,
"lvl": null,
"message": "Destination",
"sid": "00000000-0000-0000-0000-000000000003",
"timeUntilSeconds": 7.494367888744703,
"transitionInfo": null,
"turnAngleRadians": 0,
"type": "Destination"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
},
"distanceMeters": 16.882127805668667,
"nodes": {
"features": [
{
"geometry": {
"coordinates": [
-104.83957880,
39.74246923
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83959145,
39.74245188
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83959340,
39.74244866
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83959469,
39.74244507
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83959489,
39.74244060
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83959341,
39.74243440
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83959097,
39.74242916
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83958937,
39.74242665
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83958535,
39.74242134
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83955591,
39.74238537
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-00000000000a",
"lvl": 1,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": {
"groupId": "8bc0b0aa-7050-41b5-b003-fa969668cc85",
"isAccessible": true,
"isComfortable": true,
"name": "Building Entrance-Exit",
"travelTime": 1,
"typeCode": "building-entrance-exit"
}
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83955591,
39.74238537
],
"type": "Point"
},
"properties": {
"bid": null,
"lvl": null,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": {
"groupId": "8bc0b0aa-7050-41b5-b003-fa969668cc85",
"isAccessible": true,
"isComfortable": true,
"name": "Building Entrance-Exit",
"travelTime": 1,
"typeCode": "building-entrance-exit"
}
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83955496,
39.74238473
],
"type": "Point"
},
"properties": {
"bid": null,
"lvl": null,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
-104.83949873,
39.74234699
],
"type": "Point"
},
"properties": {
"bid": null,
"lvl": null,
"sid": "00000000-0000-0000-0000-000000000003",
"transitionInfo": null
},
"type": "Feature"
}
],
"type": "FeatureCollection"
},
"timeSeconds": 17.882127805668667
}
* You can access the possible response codes you may encounter here.
Get Auto-Generated Paths for Building Level
Endpoint:
GET api/v9/pws/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/paths/generate
Description:
This endpoint generates and returns wayfinding network paths for the given level (Auto-Path Generation). It uses map-objects and obstacles content to determine inclusion and exclusion areas, which are fetched automatically from Pointr Cloud draft APIs.
Success Response:
{
"features": [
{
"geometry": {
"coordinates": [
19.27733618,
20.15752597
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-000000000001",
"fid": "f45cdef3-d180-46e7-968c-de11a4a0f752",
"lvl": 1,
"neighbors": [
{
"fid": "151e812d-8faf-456e-be76-6f37a50fac03",
"speed": 1
},
{
"fid": "ffac402f-66ad-4884-8d9b-b8609e6429ba",
"speed": 1
}
],
"sid": "00000000-0000-0000-0000-000000000001",
"typeCode": "path-node"
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
19.27740976,
20.15744080
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-000000000001",
"fid": "0a45970f-bb0f-429d-83e6-a7be00c7a3b2",
"lvl": 1,
"neighbors": [
{
"fid": "ffac402f-66ad-4884-8d9b-b8609e6429ba",
"speed": 1
},
{
"fid": "f0801906-9c12-4b00-7ebd-94c1b1c71cb9",
"speed": 1
}
],
"sid": "00000000-0000-0000-0000-000000000001",
"typeCode": "path-node"
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
19.27749369,
20.15753460
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-000000000001",
"fid": "151e812d-8faf-456e-be76-6f37a50fac03",
"lvl": 1,
"neighbors": [
{
"fid": "f45cdef3-d180-46e7-968c-de11a4a0f752",
"speed": 1
},
{
"fid": "f0801906-9c12-4b00-7ebd-94c1b1c71cb9",
"speed": 1
}
],
"sid": "00000000-0000-0000-0000-000000000001",
"typeCode": "path-node"
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
19.27733080,
20.15745201
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-000000000001",
"fid": "ffac402f-66ad-4884-8d9b-b8609e6429ba",
"lvl": 1,
"neighbors": [
{
"fid": "f45cdef3-d180-46e7-968c-de11a4a0f752",
"speed": 1
},
{
"fid": "0a45970f-bb0f-429d-83e6-a7be00c7a3b2",
"speed": 1
}
],
"sid": "00000000-0000-0000-0000-000000000001",
"typeCode": "path-node"
},
"type": "Feature"
},
{
"geometry": {
"coordinates": [
19.27753854,
20.15747125
],
"type": "Point"
},
"properties": {
"bid": "00000000-0000-0000-0000-000000000001",
"fid": "f0801906-9c12-4b00-7ebd-94c1b1c71cb9",
"lvl": 1,
"neighbors": [
{
"fid": "0a45970f-bb0f-429d-83e6-a7be00c7a3b2",
"speed": 1
},
{
"fid": "151e812d-8faf-456e-be76-6f37a50fac03",
"speed": 1
}
],
"sid": "00000000-0000-0000-0000-000000000001",
"typeCode": "path-node"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
}
* You can access the possible response codes you may encounter here.