Welcome to the TactiPlan API TactiPlan is a planning application for personnel which also tracks leave and salary information. This api currently allows read access to the TactiPlan application. ## Authentication You can retrieve a username and password token from the webapp at https://www.tactiplan.nl or contact the administrator of your organisation on TactiPlan There are 2 ways to authenticate to the api: 1. (preferred) Using a jwt token. You can use the [/api/login_check](/#/Account/post_api_login_check) endpoint to get a jwt token. This token can be used in the Authorization header with the value Bearer {token}. The token is valid for 1 hour. After it expires you can use the [/api/login_check](/#/Account/post_api_login_check) endpoint to get a new token. After getting this token you can use the "Authorize" button on the right to fill in the token under "JWT (http, bearer)". Afterwards, you can use the "try it out" buttons on each api call. 2. (deprecated) Using http basic authentication. With this username and password you can access the api through http basic authentication. Click on the Authorize button on the right, fill in your username and password under "Basic (http, Basic) Username and the password under Password." Afterwards, you can use the "try it out" buttons on each api call. ## Tenants If your organisation has access to multiple tenants in the tactiplan system, you can use the TP-TENANT header to specify which tenant you would like to receive data for. If not provided, the default tenant as set on the user will be used. If you want to see which tenants you have access to, use the /v1/me call. If the requested tenant is not valid, a 403 HTTP status code will be returned with the message `Invalid tenant requested, check TP-TENANT value`. In that case make sure the tenant-id is correct and you have access to the tenant. ## Changelog | Date | Change | Endpoint | Reason | | ---------------- | ------------ | ---------- | ----------------------------------- | | 2024-11-01 | Added | /v2/employees | V2 Endpoint added to handle date_of_birth breaking change. The v1 endpoint has been deprecated | | 2024-11-04 | Added | /v2/occupation/employees | V2 Endpoint added for faster employee/group retrieval. The v1 endpoint has been deprecated | | 2024-11-07 | Added | * | It's now possible to use jwt token authentication instead of http basic auth, see [JWT Authentication](#Authentication) for details. The basic auth authentication authenticates on each api request and this is a slow process. The JWT tokens will give faster response times as this is no longer needed. | ## Planned removal We release breaking changes as a new version of an endpoint. We will support the old version for at least 3 months after the new version is released. The table below shows the endpoints that will be removed, the date of removal and notes on how to migrate to the new version. | Removal date | Endpoint | Migration notes | | ---------------- | ------------ | ----------------------------------- | | 2025-03-01 | /v1/employees | Migrating from /v1/employees to /v2/employees:

Breaking If the date of birth is unknown, the response fielddate_of_birth will have the value null instead of "9999-00-00"

| | 2025-03-01 | /v1/occupation/employees | Migrating from [/v1/occupation/employees](#/Occupation/get_app_occupation_getemployees) to [/v2/occupation/employees](#/Occupation/get_app_occupation_getemployeesv2):

BreakingThe `driving_license` field has been removed. You can use the [/v1/competences](#/Resources/get_app_resources_getcompetences) endpoint to retrieve all competences for all employees including driving licenses

| | Not decided yet | * | Use the jwt token auth method, see [JWT Authentication](#Authentication) for details.

The basic auth authentication authenticates on each api request and this is a slow process. The JWT tokens will give faster response times as this is no longer needed.

| ## Support Feel free to contact us in case of questions through the means below: