Specification

In addition to the documentation on this page, you can also download a spec file describing the API:

Resources

Person

Get all persons

A GET request is used to retrieve all persons.

Curl request
$ curl 'http://localhost:8080/api/person/pkid110' -i -X GET \
    -H 'Accept: application/vnd.hal+json'
HTTP request
GET /api/person/pkid110 HTTP/1.1
Accept: application/vnd.hal+json
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.hal+json
Content-Length: 333

{"_links":{"self":{"href":"http://localhost:8080/api/person/pkid110"},"related":{"href":"http://localhost:8080/api/person/hr/pkid110","name":"hr","title":"hr data"}},"active":null,"costCenter":null,"department":null,"email":null,"firstname":null,"identification":"pkid110","lastname":null,"phoneNumber":null,"phoneNumberMobile":null}
HTTPie request
$ http GET 'http://localhost:8080/api/person/pkid110' \
    'Accept:application/vnd.hal+json'
Relation Description

self

the page’s self link

related

the person’s hr data link
Path parameters
Table 1. /api/person/{pkId}
Parameter Description

pkId

the person’s pk id
Request body
Response body
{"_links":{"self":{"href":"http://localhost:8080/api/person/pkid110"},"related":{"href":"http://localhost:8080/api/person/hr/pkid110","name":"hr","title":"hr data"}},"active":null,"costCenter":null,"department":null,"email":null,"firstname":null,"identification":"pkid110","lastname":null,"phoneNumber":null,"phoneNumberMobile":null}
Response fields
Path Type Description

identification

String

the employee’s pk id

firstname

Null

the employee’s first name

lastname

Null

the employee’s last name

email

Null

the employee’s email

phoneNumber

Null

the employee’s phone number

phoneNumberMobile

Null

the employee’s mobile phone number

costCenter

Null

the employee’s cost center

department

Null

the employee’s department

active

Null

the employee’s active state

Get one person

A GET request is used to retrieve one person by id.

Curl request
$ curl 'http://localhost:8080/api/person/pkid110' -i -X GET \
    -H 'Accept: application/vnd.hal+json'
HTTP request
GET /api/person/pkid110 HTTP/1.1
Accept: application/vnd.hal+json
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.hal+json
Content-Length: 333

{"_links":{"self":{"href":"http://localhost:8080/api/person/pkid110"},"related":{"href":"http://localhost:8080/api/person/hr/pkid110","name":"hr","title":"hr data"}},"active":null,"costCenter":null,"department":null,"email":null,"firstname":null,"identification":"pkid110","lastname":null,"phoneNumber":null,"phoneNumberMobile":null}
HTTPie request
$ http GET 'http://localhost:8080/api/person/pkid110' \
    'Accept:application/vnd.hal+json'
Links
Relation Description

self

the page’s self link

related

the person’s hr data link
Path parameters
Table 1. /api/person/{pkId}
Parameter Description

pkId

the person’s pk id
Request body
Response body
{"_links":{"self":{"href":"http://localhost:8080/api/person/pkid110"},"related":{"href":"http://localhost:8080/api/person/hr/pkid110","name":"hr","title":"hr data"}},"active":null,"costCenter":null,"department":null,"email":null,"firstname":null,"identification":"pkid110","lastname":null,"phoneNumber":null,"phoneNumberMobile":null}
Response fields
Path Type Description

identification

String

the employee’s pk id

firstname

Null

the employee’s first name

lastname

Null

the employee’s last name

email

Null

the employee’s email

phoneNumber

Null

the employee’s phone number

phoneNumberMobile

Null

the employee’s mobile phone number

costCenter

Null

the employee’s cost center

department

Null

the employee’s department

active

Null

the employee’s active state

HR

Get one person’s HR data

A 'GET' request is used to retrieve one person’s HR data by id

Curl request

$ curl 'http://localhost:8080/api/person/hr/pkid110' -i -X GET \
    -H 'Accept: application/vnd.hal+json'

HTTP request

GET /api/person/hr/pkid110 HTTP/1.1
Accept: application/vnd.hal+json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/vnd.hal+json
Content-Length: 810

{"_links":{"self":{"href":"http://localhost:8080/api/person/hr/pkid110"}},"address":{"city":null,"country":null,"postcode":null,"street":null},"area":{"code":"10","name":"area 1"},"businessUnit":{"code":"1100","name":"business unit"},"company":{"code":"0020","name":"company 20"},"costCenterCode":null,"countryCode":null,"dateOfBirth":null,"department":{"code":null,"name":null},"employeeClass":null,"firstname":null,"functionCodeName":null,"group":{"code":null,"name":null},"hireDate":null,"lastname":null,"locationName":null,"logaCompany":null,"logaPnr":null,"managementLevel":null,"manager":null,"managerPkId":null,"nationalId":null,"nationality":null,"pkId":"pkid110","sapPnr":null,"secondTitle":null,"subteam":{"code":null,"name":null},"team":{"code":null,"name":null},"terminationDate":null,"title":null}

HTTPie request

$ http GET 'http://localhost:8080/api/person/hr/pkid110' \
    'Accept:application/vnd.hal+json'
Relation Description

self

the page’s self link

Path parameters

Table 1. /api/person/hr/{pkId}
Parameter Description

pkId

the person’s pk id

Request body

Response body

{"_links":{"self":{"href":"http://localhost:8080/api/person/hr/pkid110"}},"address":{"city":null,"country":null,"postcode":null,"street":null},"area":{"code":"10","name":"area 1"},"businessUnit":{"code":"1100","name":"business unit"},"company":{"code":"0020","name":"company 20"},"costCenterCode":null,"countryCode":null,"dateOfBirth":null,"department":{"code":null,"name":null},"employeeClass":null,"firstname":null,"functionCodeName":null,"group":{"code":null,"name":null},"hireDate":null,"lastname":null,"locationName":null,"logaCompany":null,"logaPnr":null,"managementLevel":null,"manager":null,"managerPkId":null,"nationalId":null,"nationality":null,"pkId":"pkid110","sapPnr":null,"secondTitle":null,"subteam":{"code":null,"name":null},"team":{"code":null,"name":null},"terminationDate":null,"title":null}

Response fields

Path Type Description

pkId

String

the person’s pk id

sapPnr

Null

the person’s SAP personal number

address

Object

the person’s living address (country, city, postcode, street)

countryCode

Null

the person’s country code

dateOfBirth

Null

the person’s date of birth

costCenterCode

Null

the person’s cost center code

employeeClass

Null

the person’s employee class

firstname

Null

the person’s first name

lastname

Null

the person’s last name

title

Null

the person’s title

secondTitle

Null

the person’s second title

hireDate

Null

the person’s hire date

terminationDate

Null

the person’s termination date

functionCodeName

Null

the person’s function code name

managementLevel

Null

the person’s management level

nationalId

Null

the person’s national id

nationality

Null

the person’s nationality

manager

Null

the person’s manager

managerPkId

Null

the person’s manager - pk id

locationName

Null

the person’s location name

area

Object

the person’s area

businessUnit

Object

the person’s business unit

company

Object

the person’s company

department

Object

the person’s department

group

Object

the person’s group

team

Object

the person’s team

subteam

Object

the person’s sub-team

logaCompany

Null

the person’s loga company

logaPnr

Null

the person’s loga personal number