POST api/v1/employee?domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}

Saves a new employee. Mandatory data on the employee input is: Ssn a valid norwegian national identity number (fødselsnummer), Employee Name value that differs from null, empty, or consists only of white-space characters. Unique UserName max 20 characters long. Named "Brukernavn" in Gerica. New in 9.1.4.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
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

The employee to save

NewEmployee
NameDescriptionTypeAdditional information
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.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Ssn": "sample string 2",
  "Name": "sample string 3",
  "UserName": "sample string 4",
  "GeographicalLevel": "sample string 5",
  "Address": {
    "StreetAddress": "sample string 1",
    "ZipCode": "sample string 2",
    "City": "sample string 3"
  },
  "Country": 6,
  "Nationality": 7,
  "Language": 8,
  "CommunicationList": [
    {
      "CommunicationType": "Telefon",
      "Value": "sample string 1",
      "Comment": "sample string 2",
      "Various": "sample string 3"
    },
    {
      "CommunicationType": "Telefon",
      "Value": "sample string 1",
      "Comment": "sample string 2",
      "Various": "sample string 3"
    }
  ],
  "Initials": "sample string 9"
}

application/xml, text/xml

Sample:
<NewEmployee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1">
  <Address>
    <City>sample string 3</City>
    <StreetAddress>sample string 1</StreetAddress>
    <ZipCode>sample string 2</ZipCode>
  </Address>
  <CommunicationList>
    <CommunicationEmployee>
      <Comment>sample string 2</Comment>
      <CommunicationType>Telefon</CommunicationType>
      <Value>sample string 1</Value>
      <Various>sample string 3</Various>
    </CommunicationEmployee>
    <CommunicationEmployee>
      <Comment>sample string 2</Comment>
      <CommunicationType>Telefon</CommunicationType>
      <Value>sample string 1</Value>
      <Various>sample string 3</Various>
    </CommunicationEmployee>
  </CommunicationList>
  <Country>6</Country>
  <GeographicalLevel>sample string 5</GeographicalLevel>
  <Id>1</Id>
  <Initials>sample string 9</Initials>
  <Language>8</Language>
  <Name>sample string 3</Name>
  <Nationality>7</Nationality>
  <Ssn>sample string 2</Ssn>
  <UserName>sample string 4</UserName>
</NewEmployee>

Response Information

Resource Description

Saves a new employee. Mandatory data on the employee input is: Ssn a valid norwegian national identity number (fødselsnummer), Employee Name value that differs from null, empty, or consists only of white-space characters. Unique UserName max 20 characters long. Named "Brukernavn" in Gerica. New in 9.1.4.

NewEmployeeId
NameDescriptionTypeAdditional information
EmployeeId

Gerica EPJ internal id for employee.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EmployeeId": "sample string 1"
}

application/xml, text/xml

Sample:
<NewEmployeeId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1">
  <EmployeeId>sample string 1</EmployeeId>
</NewEmployeeId>