POST person/cleanInfo?Token={Token}

Remove info data of the person from the system. Application privilege "Edit" for licensed agenda "Persons" required. Functionality may also be restricted by record permission "Edit" of agenda "Person".

Request Information

Authorization

Authorization by token required

Availability

Method can be used

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

PersonCleanInfoReq

Name	Description	Type	Additional information
PersonId	Unique identification of the person in the system. All records of the "personal info" will be removed from the system	string	Required String length: inclusive between 0 and 100

Name

Description

Type

Additional information

PersonId

Unique identification of the person in the system. All records of the "personal info" will be removed from the system

string

Required

String length: inclusive between 0 and 100

Request Formats

application/json

Sample:

{"PersonId":"100200300"}

application/xml

Sample:


<Request>
  <PersonId>100200300</PersonId>
</Request>

text/json

Sample:

{
  "PersonId": "sample string 1"
}

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>
</Request>

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Info for Person [{0}] cleaned successfully
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 bad request	1111	Cleaning info for PersonId [{0}] failed
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

Resource Description

BaseRespOfPersonCleanInfoReq

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

Response Formats

application/json

Sample:

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

application/xml

Sample:


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

text/json

Sample:

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

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>
  </Request>
</Response>