addOnvifUser.lua
[INDEX]

ABSTRACT

Add Onvif user

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

Username

User name to add

Test value:

Password

User's password

Test value:

Name
STRING

User's friend name (If blank or not provided, it will be same as Username)

Test value:

Role
STRING

User role (If blank or not provided, it will be 'user')

administrator

Administrator

operator

Operator

user

Normal user

Test value:

RETURNS

Return a JSON style result. The JSON format is:

{
/*OBJECT*/

"Result":
NUMBER

200 means OK, other error code meanings are similar to HTTP Response.

"Status":
"STRING"

Status message. Responsing result status of API executive, if there errors, it will describe reasons.

"Data": {
/*OBJECT*/

"Reason":
"STRING"

If the 'Result' is 405, 'Reason' show the reason why add user fail:

reserved

The user name is reserved (e.g. 'admin' is not allowed)

invalid

Invalid user name

exist

The user name is already exist

full

Too many users added

}
}

NOTES

Security attention:

Call this API require HTTP authorization. The username and password are same as web login.

OTHER NOTES

For API calling test, the default authorization username is 'admin' and password is 'admin' ( 'Authorization' field of HTTP request header is:"Basic YWRtaW46YWRtaW4=" ). You can change it bellow:

Authorization:

Device HTTP API, v1.0