Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General request format:

POST http://AxxonPSIM_user_login:AxxonPSIM_user_password@IP address:port/firserver/UpdatePerson

Request parameters:

ParameterRequiredParameter description
server_idYes

ID of the Face recognition server in Face PSIM

idYes

ID of the user in GUID format

nameNo

Name

If not specified, the name isn't updated

surnameNo

Surname

If not specified, the surname isn't updated

patronymicNo

Patronymic

If not specified, the patronymic isn't updated

departmentNo

Department

If not specified, the department isn't updated

commentNo

Comment

If not specified, the comment isn't updated

additionalParamsNo

Additional parameters of the Axxon PSIM user from the dbo.OBJ_PERSON table (see Base Axxon PSIM database tables)

Note. Text parameter values must be enclosed in double quotes.

Example:

"additionalParams":
{
"visit_document" : "F183825",

"phone" : "0123456789"

}

If not specified, the additional parameters aren't updated.

Request example:

POST http://1:1@127.0.0.1:10000/firserver/UpdatePerson

Code Block
{ 
    "server_id" : "1",
    "id" : "FB94569E-86A6-EB11-BE5B-B06EBF811A3F",
    "name" :"John",
    "surname" : "Kramer",
    "patronymic" : "Kramer",
    "department" : "Department 2",
    "comment" : "Some comment",
    "additionalParams":
    {
    "visit_document": "F183825",
    "phone": "0123456789"
    }
}

Response headlines:

HeadlineHeadline description
AllowReturns the HTTP method used in request
Content-LengthShows the size of characters in bytes received in the request
Content-TypeReturns the type of received request
ServerSpecifies the server from which the request comes
Access-Control-Request-MethodReturns the HTTP method that can be used in the request
Access-Control-OriginShows if the server response can be accessed by the code that sends a request from this source
DateShows the time of the request

Response example:

Code Block
{
    "Status": "SUCCESS",
    "Result": "FB94569E-86A6-EB11-BE5B-B06EBF811A3F",
    "Description": ""
}

Response parameters:

ParameterParameter description
StatusStatus of the completed request: SUCCESS—successful, if error—see List of possible errors of the Face recognition server
ResultID of the updated user in GUID format
DescriptionRequest description