GET person/get?PersonId={PersonId}&Token={Token}
Retrieve personal data for specific person. 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 |
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
{"PersonId":"100200300","Name":"John","Surname":"Doo","OrganizationStructure":"Structure - Company - Office 1","Department":"Department 1","EmployeePosition":"Salesman","Email":"John.Doo@speedy.com","MobilPhoneNumber":null,"PhoneNumber":null,"LoginName":"John.Doo","DegreeInFrontName":"Mgr","DegreeAfterName":"PhD","Sex":0,"IdentifierEntryCode":"693723","IdentifierCard1":"A1B2C3D4E5","IdentifierCard2":"B1C2D3E4F5","Desc":null,"Lock":0,"Identifiers":[{"InternalNrLong":"A1B2C3D4E5","Type":0,"Status":0,"Holder":null,"HolderDefault":0,"TimeLastChange":"\/Date(-62135596800000)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null},{"InternalNrLong":"B1C2D3E4F5","Type":0,"Status":0,"Holder":null,"HolderDefault":0,"TimeLastChange":"\/Date(-62135596800000)\/","RegistrationNr":null,"Technology":0,"Lock":0,"Security":0,"ValidFrom":null,"ValidTo":null,"UdsCollection":null}],"TimeLastChange":"\/Date(1726110790963)\/","UdsCollection":[{"SystemName":"a2s1","Name":"TestUDS_1","Value":"text in column","IsExtern":0,"DataType":"nvarchar(100)"},{"SystemName":"a2s2","Name":"TestUDS_2","Value":"2022-01-26T05:55:22","IsExtern":0,"DataType":"datetime"},{"SystemName":"a2s3","Name":"TestUDS_3","Value":"1","IsExtern":0,"DataType":"bit"}]}
application/xml
<Response> <PersonId>100200300</PersonId> <Name>John</Name> <Surname>Doo</Surname> <OrganizationStructure>Structure - Company - Office 1</OrganizationStructure> <Email>John.Doo@speedy.com</Email> <LoginName>John.Doo</LoginName> <Lock>0</Lock> <Identifiers> <Identifier> <InternalNrLong>A1B2C3D4E5</InternalNrLong> <Type>0</Type> <Status>0</Status> <HolderDefault>0</HolderDefault> <TimeLastChange>0001-01-01T00:00:00</TimeLastChange> <Technology>0</Technology> <Lock>0</Lock> <Security>0</Security> </Identifier> <Identifier> <InternalNrLong>B1C2D3E4F5</InternalNrLong> <Type>0</Type> <Status>0</Status> <HolderDefault>0</HolderDefault> <TimeLastChange>0001-01-01T00:00:00</TimeLastChange> <Technology>0</Technology> <Lock>0</Lock> <Security>0</Security> </Identifier> </Identifiers> <TimeLastChange>2024-09-12T03:13:10.9634466Z</TimeLastChange> <UdsCollection> <UdsOut> <SystemName>a2s1</SystemName> <Name>TestUDS_1</Name> <Value>text in column</Value> <IsExtern>0</IsExtern> <DataType>nvarchar(100)</DataType> </UdsOut> <UdsOut> <SystemName>a2s2</SystemName> <Name>TestUDS_2</Name> <Value>2022-01-26T05:55:22</Value> <IsExtern>0</IsExtern> <DataType>datetime</DataType> </UdsOut> <UdsOut> <SystemName>a2s3</SystemName> <Name>TestUDS_3</Name> <Value>1</Value> <IsExtern>0</IsExtern> <DataType>bit</DataType> </UdsOut> </UdsCollection> </Response>
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" } ] }
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>