Jump to

• Request
• Response

Update a User Profile

put

/api/AAA/UserProfiles/{id}

Updates the configuration of the user profile that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The user profile ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Details of the user profile to update.

Show Source

• AccountStatus: integer
  Indicates whether the user account is enabled (1) or disabled (0). Either omit this parameter, or specify the existing flag setting for the account in the PUT request. Do not update it.
  You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.

  Example: 1
• AuthenticationType: integer
  The authentication type ID. Either omit this parameter, or specify the existing authentication type for the account in the PUT request. Do not update it.
  You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.

  Example: 1
• EmailAddress: string
  The user's email address. If you do not want to update the email address, either omit this parameter, or specify the existing email address for the account in the PUT request.
  You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.

  Example: [e-mail]
• Password: string
  The user's password. Required for Internal authentication only. If you do not want to update the password, either omit this parameter, or use a blank string for the value.

  Example:
• Preferences: array Preferences
  The user's preferences. You must include all existing preferences for the account in the PUT request. Any existing preferences that you do not include will be removed.
  You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.
• Properties: array Properties
  The user's properties. You must include all existing properties for the account in the PUT request.
  Any existing properties that you do not include will be removed. You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.
• RepeatPassword: string
  The user's password, repeated. Required for Internal authentication only. If you do not want to update the password, either omit this parameter, or use a blank string for the value.

  Example:
• Subgroups: string
  The comma-separated list of IDs for subgroups that the account belongs to. You must include all existing subgroups only for the account in the PUT request. Use IDs, not names. Any existing subgroups that you do not include will be removed. Do not use this PUT request to add new subgroups.
  You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user. You can make a PUT request at the /api/AAA/Users endpoint to change a user's subgroups.

  Example: 1,2,3

{
    "properties":{
        "AuthenticationType":{
            "description":"The authentication type ID. Either omit this parameter, or specify the existing authentication type for the account in the PUT request. Do not update it.<br>\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
            "type":"integer",
            "example":1
        },
        "AccountStatus":{
            "description":"Indicates whether the user account is enabled (<b>1</b>) or disabled (<b>0</b>). Either omit this parameter, or specify the existing flag setting for the account in the PUT request. Do not update it.<br>\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
            "type":"integer",
            "example":1
        },
        "EmailAddress":{
            "description":"The user's email address. If you do not want to update the email address, either omit this parameter, or specify the existing email address for the account in the PUT request.<br>\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
            "type":"string",
            "example":"[e-mail]"
        },
        "Password":{
            "description":"The user's password. Required for Internal authentication only. If you do not want to update the password, either omit this parameter, or use a blank string for the value.",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"The user's password, repeated. Required for Internal authentication only. If you do not want to update the password, either omit this parameter, or use a blank string for the value.",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"The user's properties. You must include all existing properties for the account in the PUT request.<br>Any existing properties that you do not include will be removed.\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"The property ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "PropertyName":{
                        "description":"The property name.",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"The description of the property.",
                        "type":"string",
                        "example":"A new property."
                    },
                    "id":{
                        "type":"integer",
                        "example":2
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user's preferences. You must include all existing preferences for the account in the PUT request. Any existing preferences that you do not include will be removed. <br>\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"integer",
                        "example":"5"
                    },
                    "Description":{
                        "description":"The description of the preference.",
                        "type":"string",
                        "example":"Default event list display (default 'Default')"
                    },
                    "Override":{
                        "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                        "type":"integer",
                        "example":"0"
                    }
                }
            }
        },
        "Subgroups":{
            "description":"The comma-separated list of IDs for subgroups that the account belongs to. You must include all existing subgroups only for the account in the PUT request. Use IDs, not names. Any existing subgroups that you do not include will be removed. Do not use this PUT request to add new subgroups.<br>\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user. You can make a PUT request at the <b>/api/AAA/Users</b> endpoint to change a user's subgroups.",
            "type":"string",
            "example":"1,2,3"
        }
    },
    "type":"object",
    "description":"Details of the user profile to update."
}

Nested Schema : Preferences

Type: array

The user's preferences. You must include all existing preferences for the account in the PUT request. Any existing preferences that you do not include will be removed.
You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.

Show Source

• Array of: object items

{
    "description":"The user's preferences. You must include all existing preferences for the account in the PUT request. Any existing preferences that you do not include will be removed. <br>\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"integer",
                "example":"5"
            },
            "Description":{
                "description":"The description of the preference.",
                "type":"string",
                "example":"Default event list display (default 'Default')"
            },
            "Override":{
                "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                "type":"integer",
                "example":"0"
            }
        }
    }
}

Nested Schema : Properties

Type: array

The user's properties. You must include all existing properties for the account in the PUT request.
Any existing properties that you do not include will be removed. You can make a GET request at the /api/AAA/UserProfiles or /api/AAA/Users endpoint to see this information for a user.

Show Source

• Array of: object items

{
    "description":"The user's properties. You must include all existing properties for the account in the PUT request.<br>Any existing properties that you do not include will be removed.\nYou can make a GET request at the <b>/api/AAA/UserProfiles</b> or <b>/api/AAA/Users</b> endpoint to see this information for a user.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"The property ID.",
                "type":"integer",
                "example":"1"
            },
            "PropertyName":{
                "description":"The property name.",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"The description of the property.",
                "type":"string",
                "example":"A new property."
            },
            "id":{
                "type":"integer",
                "example":2
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The description of the preference.

  Example: Default event list display (default 'Default')
• Override: integer
  Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.

  Example: 0
• PreferenceID: integer
  The preference ID.

  Example: 3
• PreferenceName: string
  The preference name.

  Example: DefaultDisplayID
• PreferenceValue: integer
  The preference value.

  Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"integer",
            "example":"5"
        },
        "Description":{
            "description":"The description of the preference.",
            "type":"string",
            "example":"Default event list display (default 'Default')"
        },
        "Override":{
            "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
            "type":"integer",
            "example":"0"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The description of the property.

  Example: A new property.
• id: integer
  Example: 2
• PropertyID: integer
  The property ID.

  Example: 1
• PropertyName: string
  The property name.

  Example: ResetQuestion
• PropertyValue: string
  The property value.

  Example: resetval

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"The property ID.",
            "type":"integer",
            "example":"1"
        },
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"The description of the property.",
            "type":"string",
            "example":"A new property."
        },
        "id":{
            "type":"integer",
            "example":2
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAAUsersRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAAUsersRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AAAUsersRead
  User details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAAUsersRead"
    }
}

Nested Schema : AAAUsersRead

Type: object

User details.

Show Source

• AccountExpiration: string
  The date and time when the account's password will expire. 0 means it never expires.

  Example: 2025-10-04 12:30:00 or 2025-10-04
• AccountStatus: integer
  A flag to indicate if the user account is enabled (1) or disabled (0).

  Example: 1
• AuthenticationType: object AuthenticationType
  The authentication type instance for the user..
• AuthenticationTypeName: string
  The authentication type instance name.

  Example: Internal
• EmailAddress: string
  The user email address.

  Example: [e-mail]
• FailedLoginCount: integer
  The number of failed logins.

  Example: 0
• FullName: string
  The full name of the user.

  Example: Operator
• LastLoginFailed: integer
  The last failed login attempt.

  Example: 0
• LastLoginSuccess: integer
  The last successful login attempt.

  Example: 0
• Password: string
  The user's password. Required for Internal authentication only.

  Example:
• PasswordExpiration: string
  The value of the PasswordExpiration field can vary depending on the PasswordChange setting and the expiration details provided when setting up the user
  If PasswordChange is set to 'immediate', this field returns 0 to indicate that Force Password Change is set to "At Next Login".
  If PasswordChange is set to 'never', this field returns a future date such as "2038-01-19 01:14:07".
  If PasswordChange is set to 'date', this field returns whatever future date was specified.

  Example: 2025-10-04 12:30:00 or 2025-10-04
• Preferences: array Preferences
  The user preferences.
• Properties: array Properties
  The user's properties.
• RepeatPassword: string
  The user's password, repeated. Required for Internal authentication only.

  Example:
• Subgroups: array Subgroups
  The subgroups that the account belongs to. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.
• SupportUsername: string
  The support user name.

  Example:
• UserGroup: object UserGroup
  The user group.
• UserGroupName: string
  The user group name.

  Example: Administrators
• UserID: integer
  The user ID.

  Example: 1065
• UserName: string
  The user name.

  Example: operator

{
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1065"
        },
        "UserName":{
            "description":"The user name.",
            "type":"string",
            "example":"operator"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Operator"
        },
        "EmailAddress":{
            "description":"The user email address.",
            "type":"string",
            "example":"[e-mail]"
        },
        "LastLoginSuccess":{
            "description":"The last successful login attempt.",
            "type":"integer",
            "example":"0"
        },
        "LastLoginFailed":{
            "description":"The last failed login attempt.",
            "type":"integer",
            "example":"0"
        },
        "PasswordExpiration":{
            "description":"The value of the PasswordExpiration field can vary depending on the PasswordChange setting and the expiration details provided when setting up the user <br>If PasswordChange is set to 'immediate', this field returns 0 to indicate that Force Password Change is set to \"At Next Login\". <br>If PasswordChange is set to 'never', this field returns a future date such as \"2038-01-19 01:14:07\". <br>If PasswordChange is set to 'date', this field returns whatever future date was specified.",
            "type":"string",
            "example":"2025-10-04 12:30:00 or 2025-10-04"
        },
        "AccountExpiration":{
            "description":"The date and time when the account's password will expire. <b>0</b> means it never expires.",
            "type":"string",
            "example":"2025-10-04 12:30:00 or 2025-10-04"
        },
        "FailedLoginCount":{
            "description":"The number of failed logins.",
            "type":"integer",
            "example":"0"
        },
        "AuthenticationType":{
            "description":"The authentication type instance for the user..",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The unique identifier for the authentication type instance.",
                    "type":"integer"
                },
                "name":{
                    "description":"The name for the authentication type instance.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Internal"
            }
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled (<b>1</b>) or disabled (<b>0</b>).",
            "type":"integer",
            "example":"1"
        },
        "SupportUsername":{
            "description":"The support user name.",
            "type":"string",
            "example":""
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Administrators"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type instance name.",
            "type":"string",
            "example":"Internal"
        },
        "UserGroup":{
            "description":"The user group.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.",
                    "type":"integer"
                },
                "name":{
                    "description":"The user group name.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Administrators"
            }
        },
        "Subgroups":{
            "description":"The subgroups that the account belongs to. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "UserGroupID":{
                        "description":"The subgroup ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "UserGroupName":{
                        "description":"The subgroup name.",
                        "type":"string",
                        "example":"Operators"
                    }
                }
            }
        },
        "Password":{
            "description":"The user's password. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"The user's password, repeated. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"The user's properties.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"The property ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "PropertyName":{
                        "description":"The property name.",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"The description associated with the property.",
                        "type":"string",
                        "example":"Reserved for future use"
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"string",
                        "example":"5"
                    },
                    "Description":{
                        "description":"The preference description.",
                        "type":"string",
                        "example":"Default event list display (default 'Default')"
                    },
                    "Override":{
                        "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                        "type":"integer",
                        "example":0
                    }
                }
            }
        }
    },
    "description":"User details."
}

Nested Schema : AuthenticationType

Type: object

The authentication type instance for the user..

Show Source

• id: integer
  The unique identifier for the authentication type instance.
• name: string
  The name for the authentication type instance.

{
    "description":"The authentication type instance for the user..",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the authentication type instance.",
            "type":"integer"
        },
        "name":{
            "description":"The name for the authentication type instance.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Internal"
    }
}

Example:

{
    "id":"1",
    "name":"Internal"
}

Nested Schema : Preferences

Type: array

The user preferences.

Show Source

• Array of: object items

{
    "description":"The user preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"string",
                "example":"5"
            },
            "Description":{
                "description":"The preference description.",
                "type":"string",
                "example":"Default event list display (default 'Default')"
            },
            "Override":{
                "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                "type":"integer",
                "example":0
            }
        }
    }
}

Nested Schema : Properties

Type: array

The user's properties.

Show Source

• Array of: object items

{
    "description":"The user's properties.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"The property ID.",
                "type":"integer",
                "example":"1"
            },
            "PropertyName":{
                "description":"The property name.",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"The description associated with the property.",
                "type":"string",
                "example":"Reserved for future use"
            }
        }
    }
}

Nested Schema : Subgroups

Type: array

The subgroups that the account belongs to. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.

Show Source

• Array of: object items

{
    "description":"The subgroups that the account belongs to. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "UserGroupID":{
                "description":"The subgroup ID.",
                "type":"integer",
                "example":"1"
            },
            "UserGroupName":{
                "description":"The subgroup name.",
                "type":"string",
                "example":"Operators"
            }
        }
    }
}

Nested Schema : UserGroup

Type: object

The user group.

Show Source

• id: integer
  The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.
• name: string
  The user group name.

{
    "description":"The user group.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.",
            "type":"integer"
        },
        "name":{
            "description":"The user group name.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Administrators"
    }
}

Example:

{
    "id":"1",
    "name":"Administrators"
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The preference description.

  Example: Default event list display (default 'Default')
• Override: integer
  Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.

  Example: 0
• PreferenceID: integer
  The preference ID.

  Example: 3
• PreferenceName: string
  The preference name.

  Example: DefaultDisplayID
• PreferenceValue: string
  The preference value.

  Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"string",
            "example":"5"
        },
        "Description":{
            "description":"The preference description.",
            "type":"string",
            "example":"Default event list display (default 'Default')"
        },
        "Override":{
            "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The description associated with the property.

  Example: Reserved for future use
• PropertyID: integer
  The property ID.

  Example: 1
• PropertyName: string
  The property name.

  Example: ResetQuestion
• PropertyValue: string
  The property value.

  Example: resetval

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"The property ID.",
            "type":"integer",
            "example":"1"
        },
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"The description associated with the property.",
            "type":"string",
            "example":"Reserved for future use"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• UserGroupID: integer
  The subgroup ID.

  Example: 1
• UserGroupName: string
  The subgroup name.

  Example: Operators

{
    "type":"object",
    "properties":{
        "UserGroupID":{
            "description":"The subgroup ID.",
            "type":"integer",
            "example":"1"
        },
        "UserGroupName":{
            "description":"The subgroup name.",
            "type":"string",
            "example":"Operators"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top