POST person/setInfo?Token={Token}

Short info data of the person can be stored to the system. These data can be displayed on hardware units (smart reader). 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

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

PersonSetInfoReq
NameDescriptionTypeAdditional information
PersonId

Unique identification of the person in the system. The full name of the person is displayed in first row of the screen user info of the hardware unit

 string

Required

String length: inclusive between 0 and 100
InfoTime

The time information. The time is displayed in second row of the screen user info of the hardware unit

 date

Data type: DateTime
Infos

Collection of Info

None.

Request Formats

application/json

Sample: 
{"PersonId":"100200300","InfoTime":"\/Date(1729202400000)\/","Infos":[{"Key":"Workhours","Value":"168 hrs"},{"Key":"Holiday","Value":"8 days"},{"Key":"Sickday","Value":"2 days"}]}

application/xml

Sample: 

<Request>
  <PersonId>100200300</PersonId>
  <InfoTime>2024-10-18T00:00:00+02:00</InfoTime>
  <Infos>
    <Info>
      <Key>Workhours</Key>
      <Value>168 hrs</Value>
    </Info>
    <Info>
      <Key>Holiday</Key>
      <Value>8 days</Value>
    </Info>
    <Info>
      <Key>Sickday</Key>
      <Value>2 days</Value>
    </Info>
  </Infos>
</Request>

text/json

Sample: 
{
  "PersonId": "sample string 1",
  "InfoTime": "2024-10-18T13:30:02.4992045+02:00",
  "Infos": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 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>
  <InfoTime>2024-10-18T13:30:02.4992045+02:00</InfoTime>
  <Infos>
    <Info>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Info>
    <Info>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </Info>
  </Infos>
</Request>

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 Info for Person [{0}] stored 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 bad request 1111 Storing info for PersonId [{0}] failed
403 server refuses fo fulfill the request 1102 Application privilege Edit for licensed agenda Persons violated for person [{0}]
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

BaseRespOfPersonSetInfoReq
NameDescriptionTypeAdditional information
Result

RequestResult

None.
Request

PersonSetInfoReq

None.

Response Formats

application/json

Sample: 
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"PersonId":"100200300","InfoTime":"\/Date(1729202400000)\/","Infos":[{"Key":"Workhours","Value":"168 hrs"},{"Key":"Holiday","Value":"8 days"},{"Key":"Sickday","Value":"2 days"}]}}

application/xml

Sample: 

<Response>
  <Result>
    <Message>Processed with result: ExecOK</Message>
    <Code>0</Code>
  </Result>
  <Request>
    <PersonId>100200300</PersonId>
    <InfoTime>2024-10-18T00:00:00+02:00</InfoTime>
    <Infos>
      <Info>
        <Key>Workhours</Key>
        <Value>168 hrs</Value>
      </Info>
      <Info>
        <Key>Holiday</Key>
        <Value>8 days</Value>
      </Info>
      <Info>
        <Key>Sickday</Key>
        <Value>2 days</Value>
      </Info>
    </Infos>
  </Request>
</Response>

text/json

Sample: 
{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Request": {
    "PersonId": "sample string 1",
    "InfoTime": "2024-10-18T13:30:02.4992045+02:00",
    "Infos": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 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>
    <InfoTime>2024-10-18T13:30:02.4992045+02:00</InfoTime>
    <Infos>
      <Info>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Info>
      <Info>
        <Key>sample string 1</Key>
        <Value>sample string 2</Value>
      </Info>
    </Infos>
  </Request>
</Response>