Skip to main content
AFAS Get Connectors

In this article we explain how to create the right connectors for Oneteam.

Silvaan den Boer avatar
Written by Silvaan den Boer
Updated over 3 years ago

AFAS has the option to offer data to external parties with so-called 'connectors'. These are API endpoints where data in AFAS can be presented. Which data is presented can be configured by AFAS users themselves.

Recommendation for connector configuration

The property names or connector names can have a different name than what is used here. We can map the data fields dynamically for each organization.

Employee Connector

Connector to retrieve all employees. It is recommended that as soon as an employee should be invited, the employee can be seen in this connector. When the employee is out of service he should not be visible in the connector.

Employee data model

Name

Description

Required

id

A unique number to identify an employee. Can contain a mix of numbers and other characters.

yes

email

Email address, which will be used to send an invitation to Oneteam. This should be unique for each employee

yes

first name

yes

last name

If the employee has a middle name, it should be combined with this value.

yes

date of birth

Date of birth in YYYY-MM-DD format. Users can set this value to private in Oneteam after logging in.

no

telephone number

Users can set this value to private in Oneteam after logging in.

no

language

Language in which the invitation to the platform should be sent. Format should be in ISO 639-1.

no

invitation date

The alternative date at which an employee can be invited to the platform

no

out of service date

The date at which the user will be removed from Oneteam

no

community id

Single community id the employee should become a member of. The value should be the id of the community connector.

yes

function id

Single function id where the employee should become a member of. The value should be the id of a function returned in the functions connector.

no

Communities Connector

Connector to fetch a list of communities. All returned entities from the connector will have their own community in Oneteam. Please note that development won't be able to apply further filtering to the returned list.

Communities datamodel

Name

Description

Required

external id

Unique value to identify community by. Can contain a mix of numbers and other characters.

Yes

name

Name used to display the community in Oneteam

Yes

Functions Connector

Connector to fetch a list of functions available in the organization. All returned entities from the connector will have their own function in Oneteam.

Functions data model

Name

Description

Required

external id

Unique value to identify a function. Can contain a mix of numbers and other characters.

Yes

name

Name used to display the function in Oneteam

Yes

If you have any questions or comments, feel free to contact us via our live chat! πŸ‘‰


Related articles:

Did this answer your question?