Commander Endpoint Data API

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/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

Permission

VALIDATE USER

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/SubscribeToHistoricMovementData

URL Params

NONE

Data Params

 {
sessionId: text
}

• sessionId: text (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

The Subscribe and Unsubscribe calls cannot be used via REST. As they use SignalR context

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/UnSubscribeFromHistoricMovementData

URL Params

NONE

Data Params

 {
sessionId: text
}

• sessionId: text (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

The Subscribe and Unsubscribe calls cannot be used via REST. As they use SignalR context

Permission

ENTITIES_VIEWS_VIEW on viewId

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/GetHistoricDataForTileEndpoints

URL Params

NONE

Data Params

{
	"viewId": "string",
	"sessionId": "string",
	"requestId": "string",
	"tileId": int,
	"endpointIds": ["string", "string"],
	"startDate": "DateTime",
	"endDate": "DateTime",
	"rowLimit": int
}

• viewId: string (required)

• sessionId: string (required)

• requestId: string (required)

• tileId: int (required)

• endpointIds: List (required)

• startDate: DateTime

• endDate: DateTime

• rowLimit: 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

Permission

ENTITIES_VIEWS_VIEW

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/GetMovementData

URL Params

NONE

Data Params

 {
	viewId: string
	sessionId: string
	requestId: string
	taggedEntityId: string
    blueprint: Dictionary<string, List<MovementBlueprintPropertyFilter>>
	boundary: GeoBoundary
	StartDate: DateTime?
	EndDate: DateTime?

}

• viewId: string (required)

• sessionId: string (required)

• requestId: string (required)

• taggedEntityId: string (required)

• blueprint: Dictionary<string, List> (required)

• boundary: GeoBoundary (required)

• StartDate: DateTime?

• EndDate: DateTime?

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

Permission

ENTITIES.VIEWS:VIEW on viewId

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetEndpointMovementData

URL Params

NONE

Data Params

 {
	viewId: string
	sessionId: string
	requestId: string
	entityId: string
    blueprint: Dictionary<string, List<MovementBlueprintPropertyFilter>>
	boundary: GeoBoundary
	StartDate: DateTime?
	EndDate: DateTime?

}

• viewId: string (required)

• sessionId: string (required)

• requestId: string (required)

• entityId: string (required)

• blueprint: Dictionary<string, List> (required)

• boundary: GeoBoundary (required)

• StartDate: DateTime?

• EndDate: DateTime?

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

Permission

ENTITIES.VIEWS:VIEW on viewId

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/SubscribeToHistoricTileData

URL Params

NONE

Data Params

 {
	sessionId: string
}

• sessionId: 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

The Subscribe and Unsubscribe calls cannot be used via REST. As they use SignalR context

Permission

ENTITIES.VIEWS:VIEW on viewId

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/UnsubscribeFromHistoricTileData

URL Params

NONE

Data Params

 {
	sessionId: string
}

• sessionId: 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

The Subscribe and Unsubscribe calls cannot be used via REST. As they use SignalR context

Permission

ENTITIES.VIEWS:VIEW on viewId

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/GetAggregatedHistoricalDataForTileEndpoints

URL Params

NONE

Data Params

 {
	viewId : string
	tileId: string
	dateFrom: DateTime
	dateTo: DateTime
	aggregateType: AggregateType
	interval: TimeSpan
	maxRenderedPoints: int

}

• viewId : string (required)

• tileId: string (required)

• dateFrom: DateTime (required)

• dateTo: DateTime (required)

• aggregateType: AggregateType (required)

• interval: TimeSpan (required)

• maxRenderedPoints: 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

Permission

ENTITIES_VIEWS_VIEW on viewID

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/CommanderEndpointData/GetHistoricalEndpointDataForTiles

URL Params

None

Data Params

{
    "viewId ": "string",
    "tileId":"string",
    "dateFrom":"DateTime",
    "dateTo": "DateTime",
    "maxRenderedPoints": 1,
    "endpointIds": ["string"]
}

• viewId : string

• tileId: string

• dateFrom: DateTime?

• dateTo: DateTime?

• maxRenderedPoints: int?

• endpointIds: string[]?

Success Response

{
    "result": {
        "00000000-0000-0000-0000-000000000000": {
            "2021-11-22T07:48:54.79Z":false
        }
    },
    "messageType": "OK",
    "state":null,
    "sourceMessageID": "00000000-0000-0000-0000-000000000000"
}

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

DateFrom, DateTo, maxRenderedPoints and endpointIds are optional parameters.

When DateFrom and DateTo is omitted, you will simply get the most recent data up to the maxRenderedPoints parameter.

When maxRenderedPoints is omitted, it will default to 200.