GeoLocation Service

Jan 1 2022 at 12:00 AM

APIs within GeoLocation Service
1. GeoLocation
  1. API Calls

The GeoLocation API service is a configured data cube service to provide site information within a geolocation boundary in a timely fashion based on the service Configured Blueprint. The data can be received on request or in notifications that the user is subscribed to.

APIs within GeoLocation Service

GeoLocation

API Calls

GetVersion

Permission

No permission check

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/GetVersion

URL Params

None

Data Params

None

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

GetConfiguration

Permission

Access to the necessary view required.

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/GetConfiguration

URL Params

None

Data Params

{
    "viewId" : "string"
}

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

GetLocationData

Permission

Access to the necessary view required.

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/GetLocationData

URL Params

None

Data Params

{
    "viewId": "string",
    "boundary": {
        "NorthEast": {
            "Longitude": "double",
            "Latitude": "double",
            "Altitude": "double"
        },
        "SouthWest": {
            "Longitude": "double",
            "Latitude": "double",
            "Altitude": "double"
        }
    }
    "filter": {
        {"Field":"string",
        "Value":object,
        "Type":"BlueprintProperty,
        IsAlias:true}
    }
}

viewId: string
boundary: GeoBoundary
filter: List

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

RequestLocationData

Permission

Access to the necessary view required.

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/RequestLocationData

URL Params

None

Data Params

Example:
{
    "sessionId": "string",
    "viewId": "string",
    "boundary": {
        "NorthEast": {
            "Longitude": "double",
            "Latitude": "double",
            "Altitude": "double"
        },
        "SouthWest": {
            "Longitude": "double",
            "Latitude": "double",
            "Altitude": "double"
        }
    },
    "filter": 
        {
            "Field":"string",
            "Value":object,
            "Type":"BlueprintProperty",
            "IsAlias":true
        },
    "requestId": "string",
    "sitePacketSize": 10
}

viewId: string
sessionId: string
boundary: GeoBoundary
filter: List
requestId: string
SitePacketSize: Int?

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

SubscribeToGeoLocationData

Permission

Access to the necessary view required.

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/SubscribeToGeolocationData

URL Params

None

Data Params

Example:
{
    "sessionId": "text",
    "viewId": "view that requires data"
}

sessionId: string
viewId: string

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

UnsubscribeFromGeolocationData

Permission

No permission check

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/UnsubscribeFromGeolocationData

URL Params

None

Data Params

Example:
{
    "sessionId": "text"
}

sessionId: string

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

RefreshData

Permission

Administrator

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/RefreshData

URL Params

None

Data Params

None

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

RequestLocationValues

Permission

Access to the necessary view required.

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/RequestLocationValues

URL Params

None

Data Params

Example:
{
    "sessionId": "string",
    "viewId": "string",
    "boundary": {
        "NorthEast": {
            "Longitude": "double",
            "Latitude": "double",
            "Altitude": "double"
        },
        "SouthWest": {
            "Longitude": "double",
            "Latitude": "double",
            "Altitude": "double"
        }
    },
    "filter": 
    {
        "Field":"string",
        "Type":"BlueprintProperty" 
    },
    "requestId": "string",
    "sitePacketSize": 10
}

viewId: string
sessionId: string
boundary: GeoBoundary
filter: List
requestId: string (optional)
SitePacketSize: Int? (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

SubscribeToGeolocationValues

Permission

Access to the necessary view required.

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/SubscribeToGeolocationValues

URL Params

None

Data Params

Example:
{
    "sessionId": "text",
    "viewId": "view that requires data"
}

sessionId: string
viewId: string

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

UnsubscribeFromGeolocationValues

Permission

No permission check

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/GeoLocation/UnsubscribeFromGeolocationValues

URL Params

None

Data Params

Example
{
    "sessionId": "text"
}

sessionId: string

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

GeoLocation Service

APIs within GeoLocation Service

GeoLocation

API Calls

Continue reading

Community

Questions

Website