This command allows the update of user attributes pertinent to each user, a single User Defined Field with each call. There are two modes of the command, to insert and to delete values for the UDF.
SYNTAX
http://www.myserver.com/evj/ExtraView/ev_api.action?
user_id=username
&password=password OR [&access_token=token-value]
&statevar=update_user_attributes
&security_user_id=username
&mode=insert OR [&mode=delete]
&udf_name=udfname
&udf_values=udfvalues
Notes
The optional access_token
parameter allows you to use a valid OAuth2 token obtained with the get_token
command. If you provide the access_token
parameter, then the user_id
and password
parameters should not be provided. This prevents the password being sent in clear text over your network connection.
The security_user_id
parameter holds the user ID of the user whose user attributes that you want to update or delete.
You must provide the mode of either insert
or delete
.
The udf_values
may be multi-valued. In this case, each value is delimited with a semi-colon (;) character.
Examples
Insert two new values Building1 and Building2 to a multi-valued user attribute field named BUILDING. These wil be appended to any existing values:
http://www.myserver.com/evj/ExtraView/ev_api.action?
user_id=username
&password=password OR [&access_token=token-value]
&statevar=update_user_attributes
&security_user_id=username
&mode=insert
&udf_name=BUILDING
&udf_values=Building1;Building2
Delete two existing values, Building2 and Building3 from a multi-valued user attribute field named BUILDING. Other values will remain:
http://www.myserver.com/evj/ExtraView/ev_api.action?
user_id=username
&password=password OR [&access_token=token-value]
&statevar=update_user_attributes
&security_user_id=username
&mode=delete
&udf_name=BUILDING
&udf_values=Building2;Building3
Delete all values from a multi-valued field named BUILDING:
http://www.myserver.com/evj/ExtraView/ev_api.action?
user_id=username
&password=password OR [&access_token=token-value]
&statevar=update_user_attributes
&security_user_id=username
&mode=delete
&udf_name=BUILDING
&udf_values=
Note that the list of udf_values
is blank.