POST person/lock?Token={Token}

All identifiers of the person can be lock or unlock in the system. Application privilege "Edit" for licensed agenda "Persons" required. Application privilege "Edit" for agenda item "Access blocking" of licensed agenda "Persons" required. Functionality may also be restricted by record permission "Edit" or "Access Edit" of agenda "Person".

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional 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

PersonLockReq
NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system

 string

Required

String length: inclusive between 0 and 100
Lock

The person can be lock or unlock by using this. The meaning: 1 - lock person(all identifiers of the person are disabled; 0 - unlock person(all identifiers are enabled))

 integer

Required

Range: inclusive between 0 and 1

Request Formats

application/json

Sample: 
{"PersonId":"100200300","Lock":1}

application/xml

Sample: 

<Request>
  <PersonId>100200300</PersonId>
  <Lock>1</Lock>
</Request>

text/json

Sample: 
{
  "PersonId": "sample string 1",
  "Lock": 2
}

text/xml

Sample: 
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PersonId>sample string 1</PersonId>
  <Lock>2</Lock>
</Request>

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Processed with result: ExecOK
202 accepted 0 Processed with results: All identifier states remain unchanged
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 1102 Application privilege Edit for licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 1102 Application privilege View for of agenda item Access blocking of licensed agenda Persons violated for person [{0}]
403 server refuses fo fulfill the request 2132 Record permission Edit or Access Edit of agenda Persons 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
404 required resource does not exist on the server 1100 PersonId [{0}] not found
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

BaseRespOfPersonLockReq
NameDescriptionTypeAdditional information
Result

RequestResult

None.
Request

PersonLockReq

None.

Response Formats

application/json

Sample: 
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"PersonId":"100200300","Lock":1}}

application/xml

Sample: 

<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <PersonId>100200300</PersonId>
    <Lock>1</Lock>
  </Request>
</Response>

text/json

Sample: 
{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "PersonId": "sample string 1",
    "Lock": 2
  }
}

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>
    <PersonId>sample string 1</PersonId>
    <Lock>2</Lock>
  </Request>
</Response>