Commander User Config API
Jan 1 2022 at 12:00 AM
The Commander™ User Config API service is used to manage the dashboard user’s home view as well as the alarm acknowledgement pin code.
APIs within Commander™ User Config API
CommanderUserConfig
API Calls
GetConfig
Permission
SECURITY_USERS_EDIT
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderUserConfig/GetConfig
URL Params
NONE
Data Params
{
“user”:”string”
}
- user: 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
SetConfig
Permission
SECURITY_USERS_EDIT
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderUserConfig/SetConfig
URL Params
NONE
Data Params
{
“config”: {
“user”:”string”,
“DefaultViewId”:”string”,
“UserCode”: “string”,
“IsPinSet”:”bool”
},
“user”:”string”
}
config: UserConfigDto (required)
user: 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
SubscribeToConfigNotifications
Permission
DapiContext Current Username
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderUserConfig/SubscribeToConfigNotifications
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
AuthenticatePin
Permission
NONE
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderConfig/GetCommanderThemes
URL Params
NONE
Data Params
{
“userCode”:”string”,
“pin”:”string”
}
userCode: string (required)
pin: 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
ClearPin
Permission
SECURITY_USERS_EDIT
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderUserConfig/ClearPin
URL Params
NONE
Data Params
{
"user": "string"
}
- user: 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
ChangePin
Permission
SECURITY_USERS_EDIT
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderUserConfig/ChangePin
URL Params
NONE
Data Params
{
“user”:”string”,
“oldPin”:”string”,
“newPin”:”string”
}
user: string (required)
oldPin: string (required)
newPin: 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
SetPin
Permission
SECURITY_USERS_EDIT
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CommanderUserConfig/SetPin
URL Params
NONE
Data Params
{
“user”:”string”,
“pin”:”string”
}
user: string (required)
pin: 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