GET person/getInfo?PersonId={PersonId}&Token={Token}
Retrieve short info data of the person, which are currently stored in the system. Application privilege "View" for licensed agenda "Persons" required. Data may also be restricted by record permission "View" of agenda "Persons"
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PersonId |
Unique identification of the person in the system |
string |
Required String length: inclusive between 0 and 100 |
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
None.
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
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 | 1101 | Application privilege View for licensed agenda Persons violated for person [{0}] |
404 required resource does not exist on the server | 1100 | PersonId [{0}] not found |
404 required resource does not exist on the server | 1112 | PersonId [{0}] info 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
PersonGetInfoRespName | Description | Type | Additional information |
---|---|---|---|
Infos | Collection of Info |
None. |
Response Formats
application/json
Sample:
{"Infos":[{"Key":"Workhours","Value":"168 hrs"},{"Key":"Holiday","Value":"8 days"},{"Key":"Sickday","Value":"2 days"}]}
application/xml
Sample:
<Response> <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> </Response>
text/json
Sample:
{ "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"> <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> </Response>