POST user/update?Token={Token}

User data can be changed in the system. Privilege "Edit" of licensed agenda "Users" required. Functionality may also be restricted by record permission "Edit" of agenda "User"

Request Information

Authorization

Authorization by token required

Availability

Method disabled by configuration

URI Parameters

Name	Description	Type	Additional information
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Body Parameters

UserUpdateReq

Name	Description	Type	Additional information
UserName	Name of the user in the system	string	String length: inclusive between 0 and 100
ValidFrom	The user is valid from	date	Data type: Date
ValidTo	The user is valid to	date	Data type: Date
Lock	User lock flag. The value "0" means unlocked and value "1" means locked.	integer	Range: inclusive between 0 and 1
PersonID	Person ID assigned to the user	string	String length: inclusive between 0 and 100
LoginName	Unique identification of the user in the system	string	None.

Request Formats

application/json

Sample:

{"LoginName":"John.Doo","UserName":"John Doo","ValidFrom":"\/Date(1546326000000)\/","ValidTo":"\/Date(1609484400000)\/","Lock":0,"PersonID":null}

application/xml

Sample:


<Request>
  <LoginName>John.Doo</LoginName>
  <UserName>John Doo</UserName>
  <ValidFrom>2019-01-01T08:00:00</ValidFrom>
  <ValidTo>2021-01-01T08:00:00</ValidTo>
  <Lock>0</Lock>
</Request>

text/json

Sample:

{
  "LoginName": "sample string 1",
  "UserName": "sample string 1",
  "ValidFrom": "2024-11-21T13:17:50.9034171+01:00",
  "ValidTo": "2024-11-21T13:17:50.9034171+01:00",
  "Lock": 2,
  "PersonID": "sample string 3"
}

text/xml

Sample:

<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LoginName>sample string 1</LoginName>
  <UserName>sample string 1</UserName>
  <ValidFrom>2024-11-21T13:17:50.9034171+01:00</ValidFrom>
  <ValidTo>2024-11-21T13:17:50.9034171+01:00</ValidTo>
  <Lock>2</Lock>
  <PersonID>sample string 3</PersonID>
</Request>

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Processed with result: ExecOK
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1408	Privilege View of agenda Users violated for [LoginName {0}]
403 server refuses fo fulfill the request	1413	Record permission Edit of agenda User violated for [{0}]
403 server refuses fo fulfill the request	1	Db operation failed, agenda missing priviliges
403 server refuses fo fulfill the request	2	Db operation failed, record missing priviliges
403 server refuses fo fulfill the request	3	Db operation failed, Record duplicity
403 server refuses fo fulfill the request	4	Db operation failed, already changed by another user
403 server refuses fo fulfill the request	5	Db operation failed, already deleted by another user
403 server refuses fo fulfill the request	6	Db operation failed, database data consistence violation
403 server refuses fo fulfill the request	7	Db operation failed, operation can not be executed because another problems occured
403 server refuses fo fulfill the request	8	Db operation failed, licence violation
403 server refuses fo fulfill the request	0	Processed with results: User [{0}] remains unchanged
404 required resource does not exist on the server	1400	User for [LoginName {0}, ID_Firma {1}] not found or it could be a system user
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error		Server exception description

Resource Description

BaseRespOfUserUpdateReq

Name	Description	Type	Additional information
Result		RequestResult	None.
Request		UserUpdateReq	None.

Response Formats

application/json

Sample:

{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"LoginName":"John.Doo","UserName":"John Doo","ValidFrom":"\/Date(1546326000000)\/","ValidTo":"\/Date(1609484400000)\/","Lock":0,"PersonID":null}}

application/xml

Sample:


<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <LoginName>John.Doo</LoginName>
    <UserName>John Doo</UserName>
    <ValidFrom>2019-01-01T08:00:00</ValidFrom>
    <ValidTo>2021-01-01T08:00:00</ValidTo>
    <Lock>0</Lock>
  </Request>
</Response>

text/json

Sample:

{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "LoginName": "sample string 1",
    "UserName": "sample string 1",
    "ValidFrom": "2024-11-21T13:17:50.9034171+01:00",
    "ValidTo": "2024-11-21T13:17:50.9034171+01:00",
    "Lock": 2,
    "PersonID": "sample string 3"
  }
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Message>sample string 1</Message>
    <Code>2</Code>
    <ModelStateErr>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </ModelStateErr>
  </Result>
  <Request>
    <LoginName>sample string 1</LoginName>
    <UserName>sample string 1</UserName>
    <ValidFrom>2024-11-21T13:17:50.9034171+01:00</ValidFrom>
    <ValidTo>2024-11-21T13:17:50.9034171+01:00</ValidTo>
    <Lock>2</Lock>
    <PersonID>sample string 3</PersonID>
  </Request>
</Response>