Create a User Property
post
/api/AAA/UserProperties
Creates a new user property.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
PropertyDescription: string
The property description.Example:
Reserved for future use
-
PropertyName: string
The property name.Example:
ResetQuestion
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : AAAUserPropertiesRead
Type:
Show Source
object
-
Description: string
The property description.Example:
Reserved for future use
-
PropertyID: integer
The property ID.Example:
1
-
PropertyName: string
The property name.Example:
ResetQuestion
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object