Skip to main content

Setting Up a Person in HR Using the REST API

How to Change Person Settings in HR via REST API

Written by Petr Pech

For API import, the Person record is used; its description can be found at:

https://{váš server}/c/{id firmy}/osoba/properties

Retrieving Data

To load information about a person, we use the GET method on the following endpoint (analogously .json):

https://{váš server}/c/{id firmy}/osoba.xml

To retrieve data, we can use standard filtering and detail levels.

Sending Data

To send data about a person, we use the POST method on the following endpoint (analogously .json):

https://{váš server}/c/{id firmy}/osoba.xml

Example request body:

<?xml version="1.0"?><winstrom version="1.0">  <osoba>    <platiOd>2021-07-01</platiOd>    <osbCis>PP123456</osbCis>    <prijmeni>Pavelka</prijmeni>    <jmeno>Pavel</jmeno>    <stredisko>code:C</stredisko>  </osoba></winstrom>

The import can only be used to add new person settings with a specified effective date, or to delete selected settings other than the last one. The effective dates of the remaining settings are adjusted accordingly.

To delete a setting, use the POST method together with the delete action. https://{váš server}/c/{id firmy}/osoba.xml

<?xml version="1.0"?><winstrom version="1.0">  <osoba action="delete">    <id>1</id>    <osbCis>PP123456</osbCis>  </osoba></winstrom>

Newly imported person settings can be identified not only by a reference to the person header (https://{váš server}/c/{id firmy}/osoba-hlavicka/properties)

but also by the employee's personal number:

<?xml version="1.0"?><osbCis>PP123456</osbCis>
Did this answer your question?