GET api/v1/employee/{id}?domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}
Gets an employee by the social security number or Gerica internal id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The social security number (DDMMYYXXXXX, e.g. 11118793456) or internal employee Id in EPJ |
string |
Required |
domain |
The domain ID. This is the name of the municipality's meta domain that the API is reading writing data to. |
string |
Required |
key |
The API license key. |
string |
Required |
provider_unit |
Not in use |
string |
None. |
roles |
Not in use |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Gets an employee by the social security number or Gerica internal id
EmployeeName | Description | Type | Additional information |
---|---|---|---|
Inactive |
If true the user needs to be activated before it can be used |
boolean |
None. |
Id |
Employee's ID in EJP |
integer |
None. |
Ssn |
Employee national identity number/fødselsnummer, 11 digits. |
string |
None. |
Name |
Employee Name (format: last, first) |
string |
None. |
UserName |
User name. This needs to be unique in the employee table (as domainusername in Gerica). Designed to match user name in federation system (e.g. Active directory). New in 9.1.12: Max 100 characters (increased from 20). |
string |
None. |
GeographicalLevel |
Geographical user level |
string |
None. |
Address |
Address |
Address |
None. |
Country |
Country code indicating the country. Uses phone number prefix codes as number. Default value is 47 (Norway) |
integer |
None. |
Nationality |
Country code indicating the nationality. Default value is 47 (Norway) |
integer |
None. |
Language |
Country code indicating the language. Default value is 47 (Norway) |
integer |
None. |
CommunicationList |
List of communication info like: Email addresses, phone numbers etc. |
Collection of CommunicationEmployee |
None. |
Initials |
Employees initials. Maps to shortname in Gerica database. For historical reasons, all employees should have a unique value in the initials field. Max 20 characters. |
string |
None. |
Response Formats
application/json, text/json
{ "Inactive": false, "Id": 1, "Ssn": "19127868177", "Name": "Line Danser", "UserName": "LD", "GeographicalLevel": "1", "Address": { "StreetAddress": "Test veien 1", "ZipCode": "1820", "City": "Testby" }, "Country": 47, "Nationality": 47, "Language": 0, "CommunicationList": [ { "CommunicationType": "Mobil", "Value": "91776400", "Comment": "Flink ansatt", "Various": "Må ikke ringes etter kl 18" } ], "Initials": null }
application/xml, text/xml
<Employee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1"> <Address> <City>Testby</City> <StreetAddress>Test veien 1</StreetAddress> <ZipCode>1820</ZipCode> </Address> <CommunicationList> <CommunicationEmployee> <Comment>Flink ansatt</Comment> <CommunicationType>Mobil</CommunicationType> <Value>91776400</Value> <Various>Må ikke ringes etter kl 18</Various> </CommunicationEmployee> </CommunicationList> <Country>47</Country> <GeographicalLevel>1</GeographicalLevel> <Id>1</Id> <Initials i:nil="true" /> <Language>0</Language> <Name>Line Danser</Name> <Nationality>47</Nationality> <Ssn>19127868177</Ssn> <UserName>LD</UserName> <Inactive>false</Inactive> </Employee>