om een gepersonaliseerde navigatie te krijgen.
om een gepersonaliseerde navigatie te krijgen.
- Als nieuw markeren
- Als gelezen markeren
- Bladwijzer
- Abonneren
- Printervriendelijke pagina
- Ongepaste inhoud melden
IAM API - Endpoints
- 0 Antwoorden
- 0 kudos
- 5200 Weergaven
- Swagger documentation
- Endpoints
- Companies
- Employees
- Employments
- Jobprofiles
- Organization Units
- Persons
- Valuelists
- User
Swagger documentation
The following swagger page gives an overview of the endpoints:
Endpoints
Companies
GET companies
The endpoint GET companies gives a list of company versions of the tenant.
GET https://api.youserve.nl/iam/v1.0/companies
Retrieve 1 company by adding the id of the company:
GET https://api.youserve.nl/iam/v1.0/companies/<id>
Retrieve only records which that have changed within the provided date-time (UTC) range:
GET https://api.youserve.nl/iam/v1.0/companies?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z. Format: YYYY-MM-DDTHH:MM:SS.sssZ
Data mapping
|
Property |
Description |
Example |
HR Core Business |
|
|---|---|---|---|---|
|
id |
identifier of the company |
|
|
mutkey |
|
shortName |
short name of the company |
|
|
company code |
|
fullName |
full name of the company |
|
|
company name |
|
validFrom |
The date from which the record is valid |
2020-04-01 |
N/A |
Peildatum |
|
validUntil |
The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. |
9999-12-31 2020-05-01 |
N/A |
N/A |
Employees
GET employees
The endpoint GET employees gives a list of employees with the personal and employment details of an employee.
GET https://api.youserve.nl/iam/v1.0/employees
The employee endpoint supports the following query string parameters
| Parameter | Description | |
|
<id> |
Retrieve 1 employee by adding the id of the employee. https://api.youserve.nl/iam/v1.0/employees/<id> Important note: Only the time slices valid today will be returned. If an employee has a start date in the future, this employee will not be delivered using getById. |
|
|
personCode |
Returns a list of employee records filtered by personId https://api.youserve.nl/iam/v1.0/employees ?personCode=191166 |
|
|
personId |
Returns a list of employee records filtered by personId https://api.youserve.nl/iam/v1.0/employees ?personId=191166 |
|
|
company |
Returns a list of all employee records filtered by company https://api.youserve.nl/iam/v1.0/employees?company=1010A |
|
| organizationUnit |
Returns a list of all employee records filtered by organizationUnit id https://api.youserve.nl/iam/v1.0/employees?organizationUnit=13612345 |
|
| from and to |
Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/iam/v1.0/employees?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format: |
|
| isActive |
Allows to filter out inactive records, returns all records that have been “deactivated“ either due to:
https://api.youserve.nl/iam/v1.0/employees?isActive=false |
|
| validFrom |
Returns a list of employee records filtered based on the validFrom and validUntil
https://api.youserve.nl/iam/v1.0/employees?validFrom=2020-11-07 |
|
| validUntil |
Returns a list of employee records filtered based on the validUntil
https://api.youserve.nl/iam/v1.0/employees ?validUntil=2020-11-09 |
Data mapping
|
Property |
Description |
Example |
HR Core Business |
|
|---|---|---|---|---|
|
id |
The globally unique id assigned to an employee |
12345678 |
N/A |
Mutkey medewerker |
|
personCode |
The unique id assigned to the employee |
32789 |
7014 |
Uniek Persoonlijk ID (UPI)* |
|
personId |
The globally unique id assigned to an employee |
12345678 |
10519680 |
Persoon nummer |
|
initials |
The initials of the employee |
A.B. |
25 |
Voorletters |
|
firstNames |
The official given names of the employee |
Amy Beatrice |
51 |
Voornamen |
|
knownAs |
The name which is used by the employee as first name |
Amy |
165 |
Roepnaam |
|
lastNameAtBirth |
The last name at birth of the employee. Also known as the family name |
Vries |
24 |
Achternaam |
|
lastNameAtBirthPrefix |
The prefix of the employee's last name at birth |
de |
26 |
Voorvoegsels |
|
lastName |
The last name used by the employee at present |
de Vries - van Eijck |
524 |
Opgemaakte naam aanhef The value is determined by the setting in nameAssembleOrder |
|
lastNamePrefix (not recommended to use this field. This field is the same as lastNameAtBirthPrefix) |
The prefix of the employee's last name at birth |
de |
26 |
Voorvoegsels |
|
nameAssembleOrder |
Code of the assemble order used by the core system for the last name. Values: 0 = Partner's name + own last name |
3 |
28 |
Eigennaam code |
|
partnerName |
The last name of the employee's partner |
Eijck |
27 |
Naam Partner |
|
partnerNamePrefix |
The prefix of the partner's last name |
Van |
166 |
Voorvoegsels Partner |
|
titlePrefix |
Formal title prefix |
drs. |
94 |
Titel voor |
|
titleSuffix |
Formal title suffix |
Msc |
95 |
Titel na |
|
gender |
Gender of the employee |
Female |
36 |
Geslacht
|
|
dateOfBirth |
Date of birth |
1986-12-02 |
35 |
geboorte datum |
|
deceased |
This field indicates if an employee is deceased when false the property is not returned |
true |
10302568 |
Datum overlijden |
| language |
Language of employee FR - French EN - English NL - Dutch |
NL |
10 |
Taal |
|
validFrom |
The date from which the record is valid |
2020-04-01 |
N/A |
Peildatum |
|
validUntil |
The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. |
9999-12-31 2020-05-01 |
N/A |
N/A |
|
phoneNumbers |
List of phone numbers and types |
|||
|
Home |
+3188 123 45 67 |
7376 |
Telefoonnummer privé |
|
|
Business |
+3188 345 67 89 |
7374 |
Telefoonnummer intern |
|
|
Mobile |
+316 12 34 56 78 |
7377 |
Telefoonnummer mobiel |
|
|
emailAddresses |
List of email addresses of the employee |
|||
|
Business |
b.user@example.com |
7212 |
E-mailadres |
|
|
Private |
p.user@example.com |
7213 |
E-mailadres privé |
|
|
Addresses |
List of addresses |
|||
|
|
type |
Home |
||
|
street |
Kerkstraat |
391 |
Straat |
|
|
houseNumber |
1 |
392 |
Huisnummer |
|
|
houseNumberAddition |
C |
393 |
Huisnummer toevoeging |
|
|
additionalAddressLine |
2nd floor |
8099 |
Locatie omschrijving |
|
|
postalCode |
1234 AB |
394 |
Postcode |
|
|
city |
Amersfoort |
395 |
Woonplaats |
|
|
country |
NL |
34 |
Woonland |
|
|
|
type |
Postal |
||
|
street |
Poststraat |
7572 |
Straat (postadres) |
|
|
houseNumber |
1 |
7573 |
Huisnummer (postadres) |
|
|
houseNumberAddition |
A |
7574 |
Huisnummer toev (postadres) |
|
|
additionalAddressLine |
2nd floor |
8100 |
Locatie omschrijving (postadres) |
|
|
postalCode |
1234 AB |
7575 |
Postcode (postadres) |
|
|
city |
Amersfoort |
7576 |
Plaats (postadres) |
|
|
country |
NL |
7571 |
Land (postadres) |
|
|
Employments |
||||
|
employeeCode |
The code of the employee or employment |
12345 |
22 |
Medewerker code |
|
contractId |
Unique Id for the contract and/or employment |
654789 |
49 |
Contract mutkey |
|
contractCode |
Code of the contract |
1 |
91 |
Contract id |
|
originalHireDate |
The first hire date or original hire date of an employee within the organization. This date is important for the tenure or working anniversary of an employee |
2010-10-01 |
308 |
Datum in dienst organisatie |
|
dischargeDate |
The end date or discharge date of the employee. This is always an "up to and including" date. The field will always be in the response, even if the field is not filled. |
2018-12-31 |
10520479 |
Geplande laatste datum indienst
[Geplande laatste datum indienst] = [Datum uitdienst] - 1 day
Datum uitdienst = fieldnr 40 |
|
hireDate |
Date of hire for the employment |
2017-05-01 |
39 |
Datum indienst |
|
endDate |
Enddate of contract |
2022-12-31 |
7226 |
Afloopdatum |
|
company |
Unique identifier of company the where contract is concluded |
001 |
18 |
Bedrijfscode |
|
location |
The location at which the employment is being fulfilled |
AMF |
75 |
Vestiging |
|
site |
The location at which the employment is being fulfilled |
Vestiging 1 |
7449 |
Werklocatie |
|
costCenter |
The cost center under which the employment is registered |
012 |
53 |
Kostenplaats |
|
ReasonFor Termination OfEmployment |
Reason why the employment was ended |
20 (lookup table below) |
10528113 |
Reden einde arbeidsverhouding |
|
classification |
Cost allocation of the employment |
123 |
474 |
Classifiecatiekenmerk 1 |
|
employmentType |
Code of the employment type |
4 |
7393 |
Type medewerker |
|
workingAmount |
Working amount of the employment. |
|||
|
amountOfWork: numeric value representing the work amount |
40
|
465 |
Uren periode |
|
|
periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined |
|
463 |
Dagen/uren per
|
|
|
jobProfile |
The job profile code |
9909 DEV |
97 |
Functie |
|
organizationUnit |
The organization unit id |
1234567 ZKH |
6000 |
Mutkey organisatorische eenheid |
Lookup table ReasonForTerminationOfEmployment
| code | English | Dutch/ NL |
| 01 | Term./dismissal employer within probationary per. | Opzegging/ontslag werkgever binnen de proeftijd |
| 03 | Dissolution by court at request employer | Ontbinding door rechter op verzoek werkgever |
| 04 | Termination mutual consent employer | Beëindiging wederzijds goedvinden werkgever |
| 05 | Termination by employer long-term work incapacity | Opzegging door wg langdurig arbeidsongeschikt |
| 06 | Termination by employer economic reasons | Opzegging door wg bedrijfseconomische redenen |
| 20 | Termination initiative of the employee | Einde arbeidsverhouding opzegging werknemer |
| 21 | Termination by employer for urgent reasons | Opzegging door werkgever om dringende reden |
| 30 | Term operat. law due expiry of empl relationsh | Einde rechtsw. verstr. duur arb.verh bep.tijd |
| 31 | Term operat. of law by another reason(pension,etc) | Einde van rechtswege om andere reden (pens. ed) |
| 40 | End temporay emplmnt contr hirer due to ilness | Einde uitzendovrk, uitz.bed inlener ziekte uitzkr |
| 41 | End of temporay emplmnt contract by hirer for aor | Einde uitzendovrk, uitz.bed inlener om and. reden |
| 50 | Dismissal of public-law appointm. incompetence |
Ontslag publiekrecht. aanst. vw onbekwaamheid |
| 51 | Dismissal of public-law appointm age/retirement | Ontslag publiekr. aanst. vw leeftijd/pensionering |
| 90 | The empl relationsh continues, but I.R.S adm. term | Arb.verh loopt door, inkom.verh adm. beëindigd |
| 91 | The empl relationsh continues with new employer | De arbeidsverh. loopt door bij nieuwe werkgever |
| 92 | Empl. rel.ship is followed w/o interr. same Empl. | Arb.verh zonder onderbr opgevolgd bij zelfde WG |
| 99 | Another reason not mentioned above | Een andere, hiervoor niet genoemde reden |
Employments
GET employments
The employee endpoint returns information about the employments registered in HRCB.
GET https://api.youserve.nl/iam/v1.0/employments
The employees endpoint supports the following query string parameters
| Parameter | Description | |
|
<id> |
Retrieve 1 employment by adding the id of the employee. https://api.youserve.nl/iam/v1.0/employments/<id> |
|
|
personCode |
Returns a list of employments records filtered by personId https://api.youserve.nl/iam/v1.0/employments?personCode=191166 |
|
|
personId |
Returns a list of employments records filtered by personId https://api.youserve.nl/iam/v1.0/employments?personId=191166 |
|
|
company |
Returns a list of all employments records filtered by company https://api.youserve.nl/iam/v1.0/employments?company=1010A |
|
| organizationUnit |
Returns a list of all employments records filtered by organizationUnit id https://api.youserve.nl/iam/v1.0/employments?organizationUnit=13612345 |
|
| from and to |
Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/iam/v1.0/employments?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format: |
|
| isActive |
Allows to filter out inactive records, returns all records that have been “deactivated“ either due to:
https://api.youserve.nl/iam/v1.0/employments?isActive=false |
|
| validFrom | Returns a list of employments records filtered based on the validFrom and validUntil
https://api.youserve.nl/iam/v1.0/employments?validFrom=2020-11-07 |
|
| validUntil |
Returns a list of employments records filtered based on the validUntil
https://api.youserve.nl/iam/v1.0/employments?validUntil=2020-11-09 |
Data mapping
|
Property |
Description |
Example |
HR Core Business |
|
|---|---|---|---|---|
|
id |
Employment id |
12459897 |
49 |
Contract mutkey |
|
personCode |
The unique id assigned to the employee |
32789 |
7014 |
Uniek Persoonlijk ID (UPI)* |
|
personId |
The globally unique id assigned to an employee |
12345678 |
10519680 |
Persoon nummer * |
|
employeeCode |
The code of the employee or employment |
12345 |
22 |
Medewerker code |
|
contractCode |
Code of the contract |
1 |
91 |
Contract id |
|
validFrom |
The date from which the record is valid |
2020-04-01 |
N/A |
Peildatum |
|
validUntil |
The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. |
9999-12-31 2020-05-01 |
N/A |
N/A |
|
originalHireDate |
The first hire date or original hire date of an employee within the organization. This date is important for the tenure or working anniversary of an employee |
2010-10-01 |
308 |
Datum in dienst organisatie |
|
dischargeDate |
The end date or discharge date of the employee. This is always an "up to and including" date. In case of no values the field will not be returned as part of the response body |
2018-12-31 |
10520479 |
Geplande laatste datum indienst
[Geplande laatste datum indienst] = [Datum uitdienst] - 1 day
Datum uitdienst = fieldnr 40 |
|
enddate |
Enddate of contract |
2022-12-31 |
7226 |
Afloopdatum |
|
hireDate |
Date of hire for the employment |
2017-05-01 |
39 |
Datum in dienst |
|
company |
Unique identifier of company the where contract is concluded |
001 |
18 |
Bedrijfscode |
|
location |
The location of where the employment is being performed |
789 |
75 |
Vestiging |
|
site |
The location at which the employment is being fulfilled |
Vestiging 1 |
7449 |
Werklocatie |
|
costCenter |
The cost center under which the employment is registered |
012 |
53 |
Kostenplaats |
|
ReasonFor Termination OfEmployment
|
Reason why the employment was ended |
20 (lookup table below) |
10528113 |
Reden einde arbeidsverhouding |
|
classification |
Cost allocation of the employment |
123 |
474 |
Classifiecatiekenmerk 1 |
|
employmentType |
Code of the employment type |
4 |
7393 |
Type medewerker |
|
jobProfile |
The job profile code |
9909 DEV |
97 |
Functie |
|
organizationUnit |
The organization unit id |
1234567 ZKH |
6000 |
Mutkey organisatorische eenheid |
|
emailAddresses |
List of email addresses |
|||
|
|
Business |
7212 |
E-mailadres |
|
|
phoneNumbers |
List of phone numbers and types |
|||
|
Business |
+3188 345 67 89 |
7374 |
Telefoonnummer intern |
|
|
workingAmount |
Working amount of the employment. |
|||
|
amountOfWork: numeric value representing the work amount |
40
|
465 |
Uren periode |
|
|
periodOfwork: indicates the period for which amountOfWork and unitOfWork are defined |
|
463 |
Dagen/uren per
|
|
Lookup table ReasonForTerminationOfEmployment
| code | English | Dutch/ NL |
| 01 | Term./dismissal employer within probationary per. | Opzegging/ontslag werkgever binnen de proeftijd |
| 03 | Dissolution by court at request employer | Ontbinding door rechter op verzoek werkgever |
| 04 | Termination mutual consent employer | Beëindiging wederzijds goedvinden werkgever |
| 05 | Termination by employer long-term work incapacity | Opzegging door wg langdurig arbeidsongeschikt |
| 06 | Termination by employer economic reasons | Opzegging door wg bedrijfseconomische redenen |
| 20 | Termination initiative of the employee | Einde arbeidsverhouding opzegging werknemer |
| 21 | Termination by employer for urgent reasons | Opzegging door werkgever om dringende reden |
| 30 | Term operat. law due expiry of empl relationsh | Einde rechtsw. verstr. duur arb.verh bep.tijd |
| 31 | Term operat. of law by another reason(pension,etc) | Einde van rechtswege om andere reden (pens. ed) |
| 40 | End temporay emplmnt contr hirer due to ilness | Einde uitzendovrk, uitz.bed inlener ziekte uitzkr |
| 41 | End of temporay emplmnt contract by hirer for aor | Einde uitzendovrk, uitz.bed inlener om and. reden |
| 50 | Dismissal of public-law appointm. incompetence |
Ontslag publiekrecht. aanst. vw onbekwaamheid |
| 51 | Dismissal of public-law appointm age/retirement | Ontslag publiekr. aanst. vw leeftijd/pensionering |
| 90 | The empl relationsh continues, but I.R.S adm. term | Arb.verh loopt door, inkom.verh adm. beëindigd |
| 91 | The empl relationsh continues with new employer | De arbeidsverh. loopt door bij nieuwe werkgever |
| 92 | Empl. rel.ship is followed w/o interr. same Empl. | Arb.verh zonder onderbr opgevolgd bij zelfde WG |
| 99 | Another reason not mentioned above | Een andere, hiervoor niet genoemde reden |
Jobprofiles
GET jobprofiles
The jobProfiles endpoint returns information about the job profiles (Dutch: "Functie informatie") registered.
GET https://api.youserve.nl/iam/v1.0/jobprofiles
The endpoint supports the following query string parameters
| Parameter | Description | |
|
<id> (Deprecated May 2021) |
Retrieve 1 jobprofile by adding the id of the employee. https://api.youserve.nl/iam/v1.0/jobProfiles/<id> |
|
|
shortName |
Returns a list of all jobprofile records filtered by shortName https://api.youserve.nl/iam/v1.0/jobprofiles?personCode=191166 |
|
|
companyCode |
Returns a list of valueList records based on companyCode https://api.youserve.nl/iam/v1.0/jobprofiles?personId=191166 |
|
| from and to |
Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/iam/v1.0/jobprofiles?from=2020-01-01T09:00:00.000Z&to=2020-01-01T14:00:00.000Z Format: |
|
| isActive |
Allows to filter out inactive records, returns all records that have been “deactivated“ either due to:
https://api.youserve.nl/iam/v1.0/jobprofiles?isActive=false |
|
| validFrom | Returns a list of jobprofiles records filtered based on the validFrom and validUntil
https://api.youserve.nl/iam/v1.0/jobprofiles?validFrom=2020-11-07 |
|
| validUntil |
Returns a list of jobprofiles records filtered based on the validUntil
https://api.youserve.nl/iam/v1.0/jobprofiles?validUntil=2020-11-09 |
Data mapping
|
Property |
Description |
Example |
HR Core Business |
|
|---|---|---|---|---|
|
shortName |
Code or short name of the Job Profile |
SE |
97 |
Functie code |
|
fullName |
Name or full title of the Job Profile |
Software Engineer 5 |
97 |
Functie omschrijving |
|
jobTitle |
Job title description |
Senior Software Developer |
932 |
Visitekaartje |
|
validFrom |
The date from which the record is valid |
2020-04-01 |
N/A |
Peildatum |
|
validUntil |
The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. |
9999-12-31 2020-05-01 |
N/A |
N/A |
Organization Units
GET organization units
The endpoint organizationUnits gives a list of organizationUnits versions of the tenant.
GET https://api.youserve.nl/iam/v1.0/organizationunits
The endpoint supports the following query string parameters
| Parameter | Description | |
|
<id> |
Retrieve 1 organization unit by adding the id of the employee. https://api.youserve.nl/iam/v1.0/organizationunits/<id> |
|
|
shortName |
Returns a list of all organizationUnits records filtered by shortName https://api.youserve.nl/iam/v1.0/organizationunits?personCode=191166 |
|
| from and to |
Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/iam/v1.0/organizationunits?from=2022-01-01T09:00:00.000Z&to=2022-01-01T14:00:00.000Z Format: |
|
| isActive |
Allows to filter out inactive records, returns all records that have been “deactivated“ either due to:
https://api.youserve.nl/iam/v1.0/organizationunits?isActive=false |
|
| validFrom | Returns a list of organizationunits records filtered based on the validFrom and validUntil
https://api.youserve.nl/iam/v1.0/organizationunits?validFrom=2022-11-07 |
|
| validUntil |
Returns a list of organizationunits records filtered based on the validUntil
https://api.youserve.nl/iam/v1.0/organizationunits?validUntil=2022-11-09 |
Data mapping
|
Property |
Description |
Example |
HR Core Business |
|
|---|---|---|---|---|
|
id |
Unique id of the organization unit |
12345678 |
N/A |
Mutkey organisatorische eendheid |
|
shortName |
Code or short name of the Organization Unit |
PD |
548 |
Code organisatorische eenheid |
|
fullName |
Name or full title of the Organization Unit |
Product Development |
549 |
Naam organisatorische eenheid |
|
parentOrgUnit |
Code of the parent organization unit |
PD_EU |
6000 |
Bovenliggende organisatorische eenheid |
|
organizationUnitType |
Type of organization unit |
Divisie |
7475 |
Type organisatorische eenheid |
|
manager |
Unique id of the manager |
1234567 |
N/A |
Mutkey medewerker |
|
managerPersonId |
The globally unique id assigned to an the management employee |
12345678 |
10519680 |
Persoon nummer * |
| backupManager |
backup manager of org unit |
4005614 |
7011 |
Backup manager |
|
backupManagerPersonId |
PersonCode of the Backup manager of the Organization Unit. |
12345678 |
10519680 |
Persoon nummer Corresponds with: Endpoint: Employees, Property: peronId |
|
validFrom |
The date from which the record is valid |
2020-04-01 |
N/A |
Peildatum |
|
validUntil |
The date from which the record is no longer valid. Will contains a default date in case no “end date“ has been defined for the record. |
2020-05-01
9999-12-31 |
N/A |
N/A |
Persons
In order to work with the Persons endpoint, the Person layer needs to be enabled in HR Core Business.
GET Persons
The endpoint persons gives a list of all persons (HRCore Business: "Medewerker > Persoon")) of the tenant.
GET https://api.youserve.nl/iam/v1.0/persons
The endpoint supports the following query string parameters
| Parameter | Description | |
|
<id> |
Retrieve 1 person by adding the id of the employee. https://api.youserve.nl/iam/v1.0/persons/<id> |
|
| from and to |
Retrieve only records which that have changed within the provided date-time (UTC) range https://api.youserve.nl/iam/v1.0/persons?from=2022-01-01T09:00:00.000Z&to=2022-01-01T14:00:00.000Z Format: |
|
| isActive |
Allows to filter out inactive records, returns all records that have been “deactivated“ either due to:
https://api.youserve.nl/iam/v1.0/persons?isActive=false |
|
| validFrom | Returns a list of persons records filtered based on the validFrom and validUntil
https://api.youserve.nl/iam/v1.0/persons?validFrom=2022-11-07 |
|
| validUntil |
Returns a list of persons records filtered based on the validUntil
https://api.youserve.nl/iam/v1.0/persons?validUntil=2022-11-09 |
Data mapping
|
Property |
Description |
Example |
HR Core Business |
|
|---|---|---|---|---|
|
id |
The globally unique id assigned to an employee |
12345678 |
10519680 |
Persoon nummer |
|
personCode |
The unique id assigned to the employee |
32789 |
7014 |
Uniek Persoonlijk ID (UPI)* |
|
initials |
The initials of the employee |
A.B. |
25 |
Voorletters |
|
firstNames |
The official given names of the employee |
Amy Beatrice |
51 |
Voornamen |
|
knownAs |
The name which is used by the employee as first name |
Amy |
165 |
Roepnaam |
|
lastNameAtBirth |
The last name at birth of the employee. Also known as the family name |
Vries |
24 |
Achternaam |
|
lastNameAtBirthPrefix |
The prefix of the employee's last name at birth |
de |
26 |
Voorvoegsels |
|
lastName |
The last name used by the employee at present |
de Vries - Van Eijck |
524 |
Opgemaakte naam aanhef The value is determined by the setting in nameAssembleOrder |
|
lastNamePrefix (not recommended to use this field. This field is the same as lastNameAtBirthPrefix) |
The prefix of the employee's last name at birth |
de |
26 |
Voorvoegsels |
|
nameAssembleOrder |
Code of the assemble order used by the core system for the last name. Values: |
3 |
28 |
Eigennaam code |
|
partnerName |
The last name of the employee's partner |
Eijck |
27 |
Naam Partner |
|
partnerNamePrefix |
The prefix of the partner's last name |
Van |
166 |
Voorvoegsels Partner |
|
titlePrefix |
Formal title prefix |
drs. |
94 |
Titel voor |
|
titleSuffix |
Formal title suffix |
Msc |
95 |
Titel na |
|
gender |
Gender of the employee |
Female |
36 |
Geslacht
|
|
dateOfBirth |
Date of Birth |
1986-02-12 |
N/A |
N/A |
|
deceased |
This field indicates if an employee is deceased when false the property is not returned |
true |
10302568 |
Datum overlijden |
|
validFrom |
The date from which the record is valid |
2020-04-01 |
N/A |
Peildatum |
|
validUntil |
The data from which the record is no longer valid. Contains a default date in case no “end date“ has been defined for the record. |
9999-12-31 2020-05-01 |
N/A |
N/A |
|
phoneNumbers |
List of phone numbers and types |
|||
|
Home |
+3188 123 45 67 |
7376 |
Telefoonnummer privé |
|
|
Mobile |
+316 12 34 56 78 |
7377 |
Telefoonnummer mobiel |
|
|
emailAddresses |
List of email addresses of the employee |
|||
|
Private |
7213 |
E-mailadres privé |
||
|
Addresses |
List of addresses |
|||
|
|
type |
Home |
||
|
street |
Kerkstraat |
391 |
Straat |
|
|
houseNumber |
1 |
392 |
Huisnummer |
|
|
houseNumberAddition |
C |
393 |
Huisnummer toevoeging |
|
|
additionalAddressLine |
2nd floor |
8099 |
Locatie omschrijving |
|
|
postalCode |
1234 AB |
394 |
Postcode |
|
|
city |
Amersfoort |
395 |
Woonplaats |
|
|
country |
NL |
34 |
Woonland |
|
|
|
type |
Postal |
||
|
street |
Poststraat |
7572 |
Straat (postadres) |
|
|
houseNumber |
1 |
7573 |
Huisnummer (postadres) |
|
|
houseNumberAddition |
A |
7574 |
Huisnummer toev (postadres) |
|
|
additionalAddressLine |
2nd floor |
8100 |
Locatie omschrijving (postadres) |
|
|
postalCode |
1234 AB |
7575 |
Postcode (postadres) |
|
|
city |
Amersfoort |
7576 |
Plaats (postadres) |
|
|
country |
NL |
7571 |
Land (postadres) |
|
Valuelists
GET valuelists
The valueList endpoint returns the descriptions to the codes returned in the IAM entity endpoints.
The valueList can be configured on different levels;
-
system- The 1st level a valueList property can be defined, this is the highest level on which the valueList can be defined and concerns general properties such as “country” -
client- The 2nd level, these valueList items are defined on the tenant level and generally defined by the customer -
company- The 3rd level, these valueList items are defined on company level, meaning only relevant for the specific company the properties are defined for-
The company code is returned as part of the company type
-
GET https://api.youserve.nl/iam/v1.0/valuelist retrieves all valuelist items
GET https://api.youserve.nl/iam/v1.0/valuelist?type=[valulist type] retrieves only the valuelists of a specific type.
Example: retrieve all locations: https://api.youserve.nl/iam/v1.0/valueList?type=location
In table below, the types are shown, along with the endpoint where they are referenced.
|
IAM property |
Valuelist type |
|---|---|
|
Persons |
|
|
nameAssembleOrder |
nameAssembleOrder |
|
gender |
gender |
|
Employees |
|
|
nameAssembleOrder |
nameAssembleOrder |
|
employmentType |
|
|
gender |
gender |
|
country |
country |
|
costCenter |
costCenter |
|
classification |
classification |
|
location |
location |
|
Employments endpoint |
|
|
costCenter |
costCenter |
|
classification |
classification |
|
employmentType |
employmentType |
|
location |
location |
|
OrganizationUnits endpoint |
|
|
organizationUnitType |
organisationUnitType |
The endpoint supports the following query string parameters
| Parameter | Description |
|
<type> |
Retrieve only 1 valuelist type, for instance retrieve all countries: https://api.youserve.nl/iam/v1.0/valueList/country |
| level |
Returns a list of valuelist records based on the level. https://api.youserve.nl/iam/v1.0/valuelist?level=client |
| companyCode |
Returns a list of valuelist records based on companyCode https://api.youserve.nl/iam/v1.0/valuelist?companyCode=2 |
| validFrom | Returns a list of valuelist records filtered based on the validFrom and validUntil
https://api.youserve.nl/iam/v1.0/valuelist?validFrom=2022-11-07 |
| validUntil |
Returns a list of valuelist records filtered based on the validUntil
https://api.youserve.nl/iam/v1.0/valuelist?validUntil=2022-11-09 |
User
The User endpoint is described in a separate article: IAM User endpoint.
Over Visma
Copyright 2022 Visma Community. All right reserved.
Visma Denemarken
Visma Finland
Visma Letland
Visma Nederland
Visma Noorwegen
Visma Zweden
Visma Developers & Partners
Visma Latijns-Amerika