POST person/getByFP?Token={Token}
Retrieve personal data for specific person. Application privilege "View" for licensed agenda "Persons" required. Application privilege "View" for agenda item "Fingerprints" of 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 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
PersonGetByFPReqName | Description | Type | Additional information |
---|---|---|---|
TemplateSuprema |
Suprema finger print template |
string |
None. |
TemplateISO |
ISO finger print template |
string |
None. |
Request Formats
application/json, text/json
{ "TemplateSuprema": "sample string 1", "TemplateISO": "sample string 2" }
application/xml, text/xml
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TemplateSuprema>sample string 1</TemplateSuprema> <TemplateISO>sample string 2</TemplateISO> </Request>
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}] |
403 server refuses fo fulfill the request | 2124 | Application privilege View for of agenda item Fingerprints of licensed agenda Persons violated for person [{0}] |
403 server refuses fo fulfill the request | 2126 | Record permission View of agenda Persons violated for [{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
PersonGetRespName | Description | Type | Additional information |
---|---|---|---|
PersonId |
Unique identification of the person in the system |
string |
None. |
Name |
The name of the person |
string |
None. |
Surname |
The surname of the person |
string |
None. |
OrganizationStructure |
The involvement of the person in the organization structure |
string |
None. |
Department |
Department. For Aktion CLOUD only |
string |
None. |
EmployeePosition |
Employee position |
string |
None. |
Email address of the person |
string |
None. |
|
MobilPhoneNumber |
Mobile phone number of the person |
string |
None. |
PhoneNumber |
Phone number of the person |
string |
None. |
LoginName |
Login name of the person. For Aktion.NEXT only |
string |
None. |
DegreeInFrontName |
Academic degree in front of the name |
string |
None. |
DegreeAfterName |
Academic degree after the name |
string |
None. |
Sex |
Sex of the person. {The meaning is: 0 - undefined; 1 - male; 2 - female } |
integer |
None. |
IdentifierEntryCode |
Entry code of the person |
string |
None. |
IdentifierCard1 |
First card identifier of the person (Default identifier for person) |
string |
None. |
IdentifierCard2 |
Another card identifier of the person. Aktion.NEXT only |
string |
None. |
Desc |
The description of the person |
string |
None. |
Lock |
The access lock flag of the person identifiers {The meaning is: 0 - at least one identifier of the person is not locked; 1 - all identifiers of the person are locked } |
integer |
None. |
Identifiers |
A list of all person identifiers |
Collection of Identifier |
None. |
TimeLastChange |
The last change time of the data record. Can be used to check manual modification of data record |
date |
None. |
UdsCollection |
The collection of available user defined columns of the agenda in the system:
|
Collection of UdsOut |
None. |
Response Formats
application/json, text/json
{ "PersonId": "sample string 1", "Lock": 18, "Identifiers": [ { "InternalNrLong": "sample string 1", "Holder": "sample string 4", "HolderDefault": 5, "RegistrationNr": "sample string 7", "Technology": 8, "Lock": 9, "Security": 10, "ValidFrom": "sample string 11", "ValidTo": "sample string 12", "UdsCollection": [ { "SystemName": "sample string 1", "Name": "sample string 2", "Value": "sample string 3", "IsExtern": 4, "DataType": "sample string 5" }, { "SystemName": "sample string 1", "Name": "sample string 2", "Value": "sample string 3", "IsExtern": 4, "DataType": "sample string 5" } ] }, { "InternalNrLong": "sample string 1", "Holder": "sample string 4", "HolderDefault": 5, "RegistrationNr": "sample string 7", "Technology": 8, "Lock": 9, "Security": 10, "ValidFrom": "sample string 11", "ValidTo": "sample string 12", "UdsCollection": [ { "SystemName": "sample string 1", "Name": "sample string 2", "Value": "sample string 3", "IsExtern": 4, "DataType": "sample string 5" }, { "SystemName": "sample string 1", "Name": "sample string 2", "Value": "sample string 3", "IsExtern": 4, "DataType": "sample string 5" } ] } ], "UdsCollection": [ { "SystemName": "sample string 1", "Name": "sample string 2", "Value": "sample string 3", "IsExtern": 4, "DataType": "sample string 5" }, { "SystemName": "sample string 1", "Name": "sample string 2", "Value": "sample string 3", "IsExtern": 4, "DataType": "sample string 5" } ] }
application/xml, text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PersonId>sample string 1</PersonId> <Lock>18</Lock> <Identifiers> <Identifier> <InternalNrLong>sample string 1</InternalNrLong> <Holder>sample string 4</Holder> <HolderDefault>5</HolderDefault> <RegistrationNr>sample string 7</RegistrationNr> <Technology>8</Technology> <Lock>9</Lock> <Security>10</Security> <ValidFrom>sample string 11</ValidFrom> <ValidTo>sample string 12</ValidTo> <UdsCollection> <UdsOut> <SystemName>sample string 1</SystemName> <Name>sample string 2</Name> <Value>sample string 3</Value> <IsExtern>4</IsExtern> <DataType>sample string 5</DataType> </UdsOut> <UdsOut> <SystemName>sample string 1</SystemName> <Name>sample string 2</Name> <Value>sample string 3</Value> <IsExtern>4</IsExtern> <DataType>sample string 5</DataType> </UdsOut> </UdsCollection> </Identifier> <Identifier> <InternalNrLong>sample string 1</InternalNrLong> <Holder>sample string 4</Holder> <HolderDefault>5</HolderDefault> <RegistrationNr>sample string 7</RegistrationNr> <Technology>8</Technology> <Lock>9</Lock> <Security>10</Security> <ValidFrom>sample string 11</ValidFrom> <ValidTo>sample string 12</ValidTo> <UdsCollection> <UdsOut> <SystemName>sample string 1</SystemName> <Name>sample string 2</Name> <Value>sample string 3</Value> <IsExtern>4</IsExtern> <DataType>sample string 5</DataType> </UdsOut> <UdsOut> <SystemName>sample string 1</SystemName> <Name>sample string 2</Name> <Value>sample string 3</Value> <IsExtern>4</IsExtern> <DataType>sample string 5</DataType> </UdsOut> </UdsCollection> </Identifier> </Identifiers> <UdsCollection> <UdsOut> <SystemName>sample string 1</SystemName> <Name>sample string 2</Name> <Value>sample string 3</Value> <IsExtern>4</IsExtern> <DataType>sample string 5</DataType> </UdsOut> <UdsOut> <SystemName>sample string 1</SystemName> <Name>sample string 2</Name> <Value>sample string 3</Value> <IsExtern>4</IsExtern> <DataType>sample string 5</DataType> </UdsOut> </UdsCollection> </Response>