Commander Config API

Jan 1 2022 at 12:00 AM

APIs within the Commander Config API
1. CommanderConfig
  1. API Calls

The Commander™ Config API service is used to manage the dashboard configuration settings e.g. Commander themes, live-stream and mapbox configuration.

APIs within the Commander Config API

CommanderConfig

API Calls

SubscribeToThemesChange

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_THEME_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SubscribeToThemeChanges

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

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

UnSubscribeFromThemeChanges

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/UnSubscribeFromThemeChanges

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

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

GetActiveCommanderTheme

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_THEME_GET

Accessible

All

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/GetActiveCommanderTheme

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

GetCommanderThemes

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_THEME_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/GetCommanderThemes

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

SetCommanderThemes

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_THEME_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SetCommanderThemes

URL Params

NONE

Data Params

{
    “themes”: {
        “enabled”:”bool”,
        “activeThemeName”:”string”,
        “themes”:”Dictionary<string, CommanderTheme>”
    }
}

themes: CommanderThemes (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

SetActiveCommanderTheme

Permission

COMMANDERCONFIG_THEME_SET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SetActiveCommanderTheme

URL Params

NONE

Data Params

{
  “themesName”: "string"
}

themeName: 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

GetLivestreamVideoConfig

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_LIVESTREAMVIDEO_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/GetLivestreamVideoConfig

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

SetLivestreamVideoConfig

Permission

COMMANDERCONFIG_LIVESTREAMVIDEO_SET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SetLivestreamVideoConfig

URL Params

NONE

Data Params

{
  “config”:{
    “AuthCode”:”string”,
    “StreamServerUrl”:”string”,
    “WebSocketServerUrl”:”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

SubscribeToLivestreamVideoConfigChanges

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_LIVESTREAMVIDEO_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SubscribeToLivestreamVideoConfigChanges

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

UnSubscribeFromLivestreamVideoConfigChanges

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/UnSubscribeFromLivestreamVideoConfigChanges

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

GetMapboxConfig

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_MAPBOX_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/GetMapboxConfig

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

SetMapboxConfig

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_MAPBOX_GET - VARIABLES NOT IN USE ; COMMANDERCONFIG_MAPBOX_SET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SetMapboxConfig

URL Params

NONE

Data Params

{
  “config”: {
    “key”:”string”,
    “CustomStyle”:”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

SubscribeToMapboxConfigChanges

Permission

ENTITIES_VIEWS_VIEW ; COMMANDERCONFIG_MAPBOX_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SubscribeToMapboxConfigChanges

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

UnSubscribeFromMapboxConfigChanges

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/UnSubscribeFromMapboxConfigChanges

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

GetDynamicConfig

Permission

COMMANDERCONFIG_DYNAMICCONFIG_GET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/GetDynamicConfig

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

SetDynamicConfig

Permission

COMMANDERCONFIG_DYNAMICCONFIG_SET

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/SetDynamicConfig

URL Params

NONE

Data Params

{
  “config”: {
    “TaggedEntitiesLimiter”:int,
    “MaxTileCountVariance”:int,
    “MaxViewTileCount”:int,
    “DataFilterPacketSize”: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

Commander Config API

APIs within the Commander Config API

CommanderConfig

API Calls

Continue reading

Community

Questions

Website