Point Of Interest API

Jan 1 2022 at 12:00 AM

Prerequisites
APIs within Point Of Interest API
1. PointOfInterest
  1. API Calls

PointOfInterest exposes a CRUD API to manage various points of interest. Note that a point of interest is NOT an entity. This collection of points is then used by a moving entity (such as a mobile generator) in order to return the name of the closest point of interest to it’s current location, within a specified radius. A point of interest consists of:

A unique identifier
A point of interest name
The point of interest’s coordinates, which contains:
- Longitude coordinate
- Latitude coordinate
Metadata
- Collection of Key-Value pairs

Prerequisites

To use the PointOfInterest API you will need to construct the various packets containing point of interest information (Unique identifier, name, GPS Coordinates and optional metadata). PointOfInterest has notable dependencies on Security API, DAPI Abstractions and EndpointFunctions.Geospatial.Abstractions.

APIs within Point Of Interest API

PointOfInterest

API Calls

Add

Permission

point_of_interest:modify.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/Add

URL Params

None

Data Params

{
"point":
    {
        "objectKey" : "string",
        "name": "string",
        "coordinate": {
            "lat": "double",
            "lon": "double"
        },
        "metadata": 
        { 
            "string": "string", 
            "string": "string" 
        }
    }
}

point: PointOfInterestEntryDto (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response . See response and accessiblity information for more.

Notes

None

Update

Permission

point_of_interest:modify. See response and accessiblity information for more.

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/Update

URL Params

None

Data Params

{
"point":
    {
        "objectKey" : "string",
        "name": "string",
        "coordinate": {
            "lat": "double",
            "lon": "double"
        },
        "metadata": 
        { 
            "string": "string", 
            "string": "string" 
        }
    }
}

point: PointOfInterestEntryDto (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response . See response and accessiblity information for more.

Notes

None

BulkUpdateOrCreate

POST

Permission

point_of_interest:modify

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/BulkUpdateOrCreate

URL Params

None

Data Params

{
    "points": 
    [
        {
            "objectKey" : "string",
            "Name":"string",
            "Coordinate":
            {
                "Longitude":"double",
                "Latitude":"double"
            },
            "metadata": 
            { 
                "string": "string", 
                "string": "string" 
            }
        },
        {
            "objectKey" : "string",
            "Name":"string",
            "Coordinate":
            {
                "Longitude":"double",
                "Latitude":"double"
            },
            "metadata": 
            { 
                "string": "string", 
                "string": "string" 
            }
        }
    ]
}

points: IEnumerable<PointOfInterestEntryDto> (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Delete

Permission

point_of_interest:modify

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/Delete

URL Params

None

Data Params

{
    "objectKey" : "string"
}

objectKey: string (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response . See response and accessiblity information for more.

Notes

None

GetNearestPointId

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetNearestPointId

URL Params

None

Data Params

{
    "coordinate" : 
    {
        "lat" : "double",
        "lon" : "double"
    },
    "maxDistance" : "double"
}

coordinate: GeoBasicCoordinate (Required)
maxDistance: double (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetNearestPointNameFromId

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetNearestPointNameFromId

URL Params

None

Data Params

{
    "coordinate": 
    {
        "lat": "double",
        "lon": "double"
    },
    "maxDistance":"double"
}

coordinate: GeoBasicCoordinate (Required)
maxDistance: double (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetAllPoiNearby

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetAllPoiNearby

URL Params

None

Data Params

{
    "coordinate" :
    {  
        "longitude": "double",
        "latitude": "double"
    },   
    "maxDistance": "double"
}

coordinate: GeoBasicCoordinate (Required)
maxDistance: double (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetAll

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetAll

URL Params

None

Data Params

{
    "pagingOptions": 
    {  
        "limit" : "integer",
        "skip" : "integer"
    }
}

pagingOptions: PagingOptions (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetDistanceToPoint

GET

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetDistanceToPoint

URL Params

None

Data Params

{
    "objectKey" : "string",
    "coordinate": 
    {
        "lat": "double",
        "lon": "double"
    }
}

objectKey: string (Required)
coordinate: GeoBasicCoordinate (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetDistanceToPointName

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetDistanceToPointName

URL Params

None

Data Params

{
    "pointOfInterestName" : "string",
    "coordinate" : 
    {
        "lat": "double",
        "lon": "double"
    }
}

pointOfInterestName: string (Required)
coordinate: GeoBasicCoordinate (Required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

GetMetadata

Permission

point_of_interest:get

Accessible

Tenant only. See response and accessiblity information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/PointOfInterest/GetMetadata

URL Params

None

Data Params

{ 
    "objectKey" : "string",
    "metadata": 
    [ 
        "string", 
        "string" 
    ] 
}

objectKey: string (Required)
metadata: the individual keys for the metadata value to retrieve (Optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response . See response and accessiblity information for more.

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.

Notes

None

Point Of Interest API

Prerequisites

APIs within Point Of Interest API

PointOfInterest

API Calls

Continue reading

Community

Questions

Website