Info
Welcome to the generated API reference.
Authentication
Requesting token
Before making a request to the API you should request a token using oauth.
HTTP Request
GET /oauth/token
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| username | required | emailaddress of the user |
| password | required | password of the user |
| grant_type | required | the grant type |
| client_id | required | the oauth client ID |
| client_secret | required | the oauth client secret |
| provider | required | which authentication provider to use |
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/attachment/1/file", [
'headers' => [
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
{
"token_type": "Bearer",
"expires_in": 2591999,
"access_token":"token",
"refresh_token": "token"
}Making requests
A valid token must be sent along with each API request, by providing it in the HTTP call’s Authorization header using the Bearer method. For example: a valid Authorization header should look like Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS....
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("{api endpoint}", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
App - Attachments
Retrieval of attachment details and the attachment file itself.
/app/attachment/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/attachment/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "dolorem",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET /app/attachment/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
/app/attachment/{id}/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/attachment/1/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/attachment/{id}/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
App - Authentication
Logging readers on and off and resetting passwords.
/app/oauth/token (legacy)
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/oauth/token", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));HTTP Request
POST /app/oauth/token
/app/password-forgot
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/password-forgot", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "password_reset_send",
"status_code": "200"
}HTTP Request
POST /app/password-forgot
/app/password-reset
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/password-reset", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "password_reset_success",
"status_code": "200"
}HTTP Request
POST /app/password-reset
/app/logout
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/logout", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "logout_success",
"status_code": "200"
}HTTP Request
GET /app/logout
App - Categories
Retrieval of categories and its descending categories in a global or personal scope.
/app/categories
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/categories", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": [
{
"id": 3,
"parent_id": 1,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"status": "active",
"description": "Arbeidsvoorwaarden",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 4,
"parent_id": 1,
"account_id": 1,
"name": "Functiebeschrijvingen",
"status": "active",
"description": "Functiebeschrijvingen",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 2,
"parent_id": 1,
"account_id": 1,
"name": "Verloning",
"status": "active",
"description": "Verloning",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": []
}
}
]
}
},
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": [
{
"id": 3,
"parent_id": 1,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"status": "active",
"description": "Arbeidsvoorwaarden",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 4,
"parent_id": 1,
"account_id": 1,
"name": "Functiebeschrijvingen",
"status": "active",
"description": "Functiebeschrijvingen",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 2,
"parent_id": 1,
"account_id": 1,
"name": "Verloning",
"status": "active",
"description": "Verloning",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": []
}
}
]
}
}
]
}HTTP Request
GET /app/categories
/app/categories/personal
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/categories/personal", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": [
{
"id": 3,
"parent_id": 1,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"status": "active",
"description": "Arbeidsvoorwaarden",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 4,
"parent_id": 1,
"account_id": 1,
"name": "Functiebeschrijvingen",
"status": "active",
"description": "Functiebeschrijvingen",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 2,
"parent_id": 1,
"account_id": 1,
"name": "Verloning",
"status": "active",
"description": "Verloning",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": []
}
}
]
}
},
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": [
{
"id": 3,
"parent_id": 1,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"status": "active",
"description": "Arbeidsvoorwaarden",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 4,
"parent_id": 1,
"account_id": 1,
"name": "Functiebeschrijvingen",
"status": "active",
"description": "Functiebeschrijvingen",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 2,
"parent_id": 1,
"account_id": 1,
"name": "Verloning",
"status": "active",
"description": "Verloning",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": []
}
}
]
}
}
]
}HTTP Request
GET /app/categories/personal
/app/category/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/category/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "quod",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": [
{
"id": 3,
"parent_id": 1,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"status": "active",
"description": "Arbeidsvoorwaarden",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 4,
"parent_id": 1,
"account_id": 1,
"name": "Functiebeschrijvingen",
"status": "active",
"description": "Functiebeschrijvingen",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"descendants": {
"data": []
}
},
{
"id": 2,
"parent_id": 1,
"account_id": 1,
"name": "Verloning",
"status": "active",
"description": "Verloning",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"descendants": {
"data": []
}
}
]
}
}
}HTTP Request
GET /app/category/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
/app/category/{id}/personal
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/category/1/personal", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "earum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{}HTTP Request
GET /app/category/{id}/personal
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
App - Changelogs
Retrieval of the latest changes to documents in a global or personal scope.
/app/changelog
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/changelog", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
[]HTTP Request
GET /app/changelog
/app/changelog/personal
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/changelog/personal", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
[]HTTP Request
GET /app/changelog/personal
App - Comments
Create comments on documents.
/app/comments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/comments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
POST /app/comments
App - Documents
Retrieval of documents and its relations.
/app/document/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/document/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "nobis",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/document/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
App - Me
Retrieval and updating of reader specific information and creating or deleting bookmarks.
/app/me
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/me", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
GET /app/me
/app/me
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("/app/me", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
PUT /app/me
/app/me/bookmark
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/me/bookmark", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
POST /app/me/bookmark
/app/me/bookmark/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete("/app/me/bookmark/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
DELETE /app/me/bookmark/{id}
/app/me/bookmarks
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/me/bookmarks", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET /app/me/bookmarks
App - Processes
Retrieval of processes, its relations and the visual export file (PDF) of the process.
/app/process/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/process/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "placeat",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET /app/process/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
/app/process/{id}/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/process/1/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ut",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/process/{id}/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
App - Ratings
Create ratings for documents.
/app/ratings
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/ratings", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"rating": 2,
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17"
}
}HTTP Request
POST /app/ratings
App - Search
Search for documents based on its name, summary, contents or related tags.
/app/search
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("/app/search", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
POST /app/search
App - Tags
Retrieval of tags and their related documents in a global or personal scope.
/app/tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
},
{
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
]
}HTTP Request
GET /app/tags
/app/tags/personal
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tags/personal", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
},
{
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
]
}HTTP Request
GET /app/tags/personal
/app/tag/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "rem",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
}HTTP Request
GET /app/tag/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/documents
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/documents", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "voluptatibus",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
GET /app/tag/{id}/documents
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/attachments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/attachments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "sed",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET /app/tag/{id}/attachments
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/entities
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/entities", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "non",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/tag/{id}/entities
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/personal
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/personal", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/tag/{id}/personal
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/personal/documents
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/personal/documents", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ut",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
GET /app/tag/{id}/personal/documents
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/personal/attachments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/personal/attachments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "vel",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET /app/tag/{id}/personal/attachments
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
/app/tag/{id}/personal/entities
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/tag/1/personal/entities", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "consectetur",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/tag/{id}/personal/entities
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
App - Theming
Retrieval of account specific styling information like the account logo.
/app/theme/logo/{platform?}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/theme/logo/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"platform" => "qui",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/theme/logo/{platform?}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| platform | optional | optional get logo for specific handboek client (app/web) |
App - Versions
Retrieval of iOS and Android app version availability and requirements.
/app/version
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/version", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"ios": {
"current": "130",
"minimal": "75",
"message": "De geinstalleerde Handboek versie is verouderd."
},
"android": {
"current": "45",
"minimal": "44",
"message": "De geinstalleerde Handboek versie is verouderd."
}
}HTTP Request
GET /app/version
Backoffice - Accounts
Retrieval of account details.
account
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("account", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"name": "Zorgstroom",
"email": "smtoorop@gmail.com",
"tier": "start",
"tier_name": "Handboek Start",
"sla": "standard",
"sla_name": "Standaard",
"limit_readers": 4,
"limit_writers": 999,
"limit_documents": 750,
"limit_notifications": 75,
"limit_storage": 25,
"usage_readers": 4,
"usage_writers": 2,
"usage_documents": 19,
"usage_notifications": 0,
"usage_storage": 0,
"price_readers": 1000,
"price_tier": 17500,
"price_sla": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}HTTP Request
GET account
Backoffice - Attachments
Retrieval of attachment details and create, update and archive attachments and its files. Attach and detach attachments from other entities.
attachments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("attachments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET attachments
attachments/due
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("attachments/due", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET attachments/due
attachments/overdue
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("attachments/overdue", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET attachments/overdue
attachment/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("attachment/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "id",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET attachment/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("attachment/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"user_id" => "me",
],
'json' => [
"title" => "eos",
"body" => "consequatur",
"type" => "odio",
"author_id" => "2",
"thumbnail" => "facilis",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET attachment/{id}/archive
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
| title | string | required | The title of the post. |
| body | string | required | The content of the post. |
| type | string | optional | The type of post to create. Defaults to 'textophonious'. |
| author_id | integer | optional | the ID of the author. |
| thumbnail | image | optional | This is required if the post type is 'imagelicious'. |
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| user_id | required | The id of the user. |
attachment/{id}/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("attachment/1/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "iure",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET attachment/{id}/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("attachment/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST attachment/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("attachment/1/tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "eligendi",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST attachment/{id}/tags
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("attachment/1/tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "modi",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
PUT attachment/{id}/tags
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/categories
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("attachment/1/categories", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ex",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST attachment/{id}/categories
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/categories
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("attachment/1/categories", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "eos",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
PUT attachment/{id}/categories
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("attachment/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "repudiandae",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
PUT attachment/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachment/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("attachment/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "at",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST attachment/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the attachment |
attachments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("attachments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST attachments
Backoffice - Authentication
Logging writers on and off, handling two factor authentication and resetting passwords.
password-forgot
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("password-forgot", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "password_reset_send",
"status_code": "200"
}HTTP Request
POST password-forgot
password-reset
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("password-reset", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "password_reset_success",
"status_code": "200"
}HTTP Request
POST password-reset
2fa
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("2fa", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "2fa_success",
"status_code": "200"
}HTTP Request
POST 2fa
logout
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("logout", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"message": "logout_success",
"status_code": "200"
}HTTP Request
GET logout
Backoffice - Categories
Retrieval of category details and create, update and archive categories. Attach and detach categories from other entities.
categories
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("categories", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
},
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
]
}HTTP Request
GET categories
category/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("category/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "facilis",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
GET category/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
category/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("category/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "vitae",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
GET category/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
category/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("category/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "officia",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
PUT category/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
categories
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("categories", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
POST categories
category/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("category/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "aliquam",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
PUT category/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
category/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("category/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "saepe",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "HRM",
"status": "active",
"description": "HRM",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verloning",
"description": "Verloning",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 2,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Indienen overwerk",
"summary": "Om overwerk uitbetaald te krijgen moet je het indienen bij de salarisadministratie. Hier leggen we uit hoe.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 2
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 2,
"document_id": 1
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 2,
"position_id": 5
}
}
]
},
{
"id": 3,
"account_id": 1,
"name": "Arbeidsvoorwaarden",
"description": "Arbeidsvoorwaarden",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 4,
"_rgt": 5,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 3,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "CAO",
"summary": "We zijn gebonden aan een collectieve arbeidsovereenkomst. Alle voorwaarden en regelingen zijn hier te vinden.",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 3,
"document_id": 3
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 3,
"position_id": 5
}
}
]
},
{
"id": 4,
"account_id": 1,
"name": "Functiebeschrijvingen",
"description": "Functiebeschrijvingen",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"_lft": 6,
"_rgt": 7,
"parent_id": 1,
"depth": 1,
"entity_type": "category",
"documents": [
{
"id": 6,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Arts",
"summary": "Functieomschrijving van Arts",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 15:22:44",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 6
}
},
{
"id": 7,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Fysiotherapeut",
"summary": "Functieomschrijving van Fysiotherapeut",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 7
}
},
{
"id": 4,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Verpleegkundige",
"summary": "Functieomschrijving van Verpleegkundige",
"changes": null,
"status": "published",
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 4
}
},
{
"id": 5,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Zorghulp",
"summary": "Functieomschrijving van Zorghulp",
"changes": null,
"status": "published",
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:27:32",
"deleted_at": null,
"entity_type": "document",
"pivot": {
"category_id": 4,
"document_id": 5
}
}
],
"positions": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 1
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"deleted_at": null,
"entity_type": "position",
"pivot": {
"category_id": 4,
"position_id": 5
}
}
]
}
],
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"documents": {
"data": [
{
"id": 18,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Organisatiestructuur",
"summary": "De organisatiestructuur wordt hier uitgelegd en weergegeven.",
"changes": null,
"status": "published",
"average_rating": null,
"locked_at": "2018-01-01 12:00:00",
"locked_writer_id": 1,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
},
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}
}
}HTTP Request
POST category/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the category |
Backoffice - Comments
Retrieval of comment details and create, update and archive comments.
comments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("comments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
},
{
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
]
}HTTP Request
GET comments
comment/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("comment/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
GET comment/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the comment |
comment/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("comment/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "facilis",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
GET comment/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the comment |
comment/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("comment/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "voluptas",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
PUT comment/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the comment |
comments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("comments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"attachment_id": null,
"comment": "Ik snap het niet! Erg onduidelijk dit!",
"status": "open",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-03 19:30:14",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
},
"document": {
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
POST comments
Backoffice - Departments
Retrieval of departments details and create, update and archive departments.
departments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("departments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
},
{
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
]
}HTTP Request
GET departments
department/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("department/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ea",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}HTTP Request
GET department/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the department |
department/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("department/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "molestias",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}HTTP Request
GET department/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the department |
department/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("department/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "eos",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}HTTP Request
PUT department/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the department |
departments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("departments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}HTTP Request
POST departments
Backoffice - Documents
Retrieval of document details and create, update, version, publish and archive documents. Download exports of a document and attach and detach documents from other entities.
documents
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("documents", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
GET documents
documents
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("documents", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
POST documents
documents/due
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("documents/due", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
GET documents/due
documents/overdue
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("documents/overdue", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
GET documents/overdue
document/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "consequatur",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "dolorum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/version
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/version", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "est",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}/version
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/publish
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/publish", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "earum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}/publish
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/unpublish
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/unpublish", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}/unpublish
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/lock
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/lock", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "aperiam",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}/lock
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/unlock
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/unlock", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "delectus",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
GET document/{id}/unlock
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "aut",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET document/{id}/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/fileword
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("document/1/fileword", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ipsum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET document/{id}/fileword
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("document/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "aut",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
PUT document/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("document/1/tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "quo",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
PUT document/{id}/tags
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/categories
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("document/1/categories", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ea",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
PUT document/{id}/categories
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{id}/attachments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("document/1/attachments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "minima",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
POST document/{id}/attachments
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{documentId}/attachment/{attachmentId}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete("document/1/attachment/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"documentId" => "tempora",
"attachmentId" => "porro",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
DELETE document/{documentId}/attachment/{attachmentId}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| documentId | required | id of the document |
| attachmentId | required | id of the attachment |
document/{id}/processes
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("document/1/processes", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "alias",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
POST document/{id}/processes
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
document/{documentId}/process/{processId}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete("document/1/process/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"documentId" => "quia",
"processId" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}HTTP Request
DELETE document/{documentId}/process/{processId}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| documentId | required | id of the document |
| processId | required | id of the process |
/app/document/{id}/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/document/1/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "earum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/document/{id}/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
/app/document/{id}/fileword
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("/app/document/1/fileword", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "consequatur",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET /app/document/{id}/fileword
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the document |
Backoffice - Me
Retrieval and updating of writer specific information and its created entities.
me
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("me", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}HTTP Request
GET me
me/documents
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("me/documents", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"version": 1,
"original_id": null,
"index": 0,
"name": "Uitleg loonstrook",
"summary": "Hier leggen we uit wat er op de loonstrook staat en hoe je de verschillende onderdelen moet lezen",
"changes": null,
"status": "published",
"average_rating": 2,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 2,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-03 18:25:35",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
]
}HTTP Request
GET me/documents
me/processes
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("me/processes", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET me/processes
me/attachments
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("me/attachments", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 1,
"name": "Richtlijn calamiteitenrapportage",
"description": null,
"filename": "Richtlijn-calamiteitenrapportage.pdf",
"size": "23400",
"path": "attachments\/seeded\/Richtlijn-calamiteitenrapportage.pdf",
"type": "application\/pdf",
"orientation": "landscape",
"status": "active",
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2017-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 12:19:03",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET me/attachments
Backoffice - Notifications
Retrieval and creation (sending out) of notifications to readers.
notifications
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("notifications", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"reader_id": 1,
"writer_id": null,
"document_id": 14,
"process_id": null,
"attachment_id": null,
"comment_id": null,
"title": "Wijziging",
"content": "Stappenplan valpreventie is zojuist gewijzigd met voor jou relevante wijzigingen",
"type": "push",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}
},
{
"id": 1,
"account_id": 1,
"reader_id": 1,
"writer_id": null,
"document_id": 14,
"process_id": null,
"attachment_id": null,
"comment_id": null,
"title": "Wijziging",
"content": "Stappenplan valpreventie is zojuist gewijzigd met voor jou relevante wijzigingen",
"type": "push",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}
}
]
}HTTP Request
GET notifications
notification/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("notification/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "porro",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"writer_id": null,
"document_id": 14,
"process_id": null,
"attachment_id": null,
"comment_id": null,
"title": "Wijziging",
"content": "Stappenplan valpreventie is zojuist gewijzigd met voor jou relevante wijzigingen",
"type": "push",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}
}
}HTTP Request
GET notification/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the notification |
notifications
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("notifications", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"writer_id": null,
"document_id": 14,
"process_id": null,
"attachment_id": null,
"comment_id": null,
"title": "Wijziging",
"content": "Stappenplan valpreventie is zojuist gewijzigd met voor jou relevante wijzigingen",
"type": "push",
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17",
"reader": {
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}
}
}HTTP Request
POST notifications
Backoffice - Paragraphs
Retrieval of paragraph details and create, update, archive and delete paragraphs. Attach and detach positions from paragraphs.
paragraphs
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("paragraphs", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
},
{
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
]
}HTTP Request
GET paragraphs
paragraph/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("paragraph/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ipsum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
GET paragraph/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the paragraph |
paragraph/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("paragraph/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "eum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
PUT paragraph/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the paragraph |
paragraphs
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("paragraphs", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
POST paragraphs
paragraph/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete("paragraph/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "sunt",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
DELETE paragraph/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the paragraph |
paragraph/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("paragraph/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "tempore",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"document_id": 14,
"index": 0,
"name": "Directe hulp na een valincident",
"content": "De focus ligt op het direct hulp verlenen. Wanneer nodig moet een arts worden ingeschakeld door de *verzorgende* of *zorghulp*. Ook moet het incident worden vastgelegd. Het volledige stappenplan is gekoppeld aan dit artikel.",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"positions": {
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 5,
"account_id": 1,
"department_id": 1,
"name": "Arts",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
},
"document": {
"data": {
"id": 14,
"account_id": 1,
"writer_id": 1,
"version": 1,
"original_id": null,
"index": 0,
"name": "Stappenplan valpreventie",
"summary": "Hoe je moet handelen na een valincident is in een stappenplan vastgelegd. Het stappenplan is onderverdeeld in directe hulp en de procedure na een incident.",
"changes": null,
"status": "published",
"average_rating": 3,
"locked_at": null,
"locked_writer_id": null,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": null,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 13:29:45",
"writer": {
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
},
"tags": {
"data": []
}
}
}
}
}HTTP Request
PUT paragraph/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the paragraph |
Backoffice - Positions
Retrieval of position details and create, update and archive positions.
positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
},
{
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
]
}HTTP Request
GET positions
position/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("position/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "odit",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}HTTP Request
GET position/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the position |
position/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("position/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "qui",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}HTTP Request
GET position/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the position |
position/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("position/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "veniam",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}HTTP Request
PUT position/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the position |
positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}HTTP Request
POST positions
Backoffice - Processes
Retrieval of process details and its steps and create, update and archive processes. Download export of a process and attach and detach processes from other entities.
processes
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("processes", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET processes
processes
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("processes", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST processes
processes/due
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("processes/due", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET processes/due
processes/overdue
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("processes/overdue", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
},
{
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
]
}HTTP Request
GET processes/overdue
process/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "nihil",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET process/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "neque",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET process/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/lock
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1/lock", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "sunt",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET process/{id}/lock
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/unlock
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1/unlock", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "quia",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
GET process/{id}/unlock
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "rerum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET process/{id}/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/steps/file
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1/steps/file", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET process/{id}/steps/file
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/steps/fileword
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("process/1/steps/fileword", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "repellat",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET process/{id}/steps/fileword
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("process/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "accusantium",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
PUT process/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("process/1/tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "beatae",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
PUT process/{id}/tags
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{id}/documents
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("process/1/documents", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "cupiditate",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
POST process/{id}/documents
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the process |
process/{processId}/document/{documentId}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete("process/1/document/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"processid" => "enim",
"documentid" => "aut",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"writer_id": 2,
"original_id": null,
"version": 1,
"name": "Stappenplan valincident",
"description": "Dit is het stappenplan dat we moeten volgen na het voordoen van een valincident",
"graph_direction": "TB",
"graph_structure": "graph TB\n 1(Eerste hulp verlenen)\n 1-->2(Intern melden)\n 2-->3{Extern melden?}\n 3-->4(Nee)\n 3-->5(Ja)\n 4-->6(Bespreken in team)\n 5-->7(Melden afdelingshoofd)\n 7-->8(Melden bij IGZ)\n 8-->9(Onderzoek starten)\n ",
"average_rating": null,
"changes": null,
"status": "published",
"is_auto_sectioned": 1,
"locked_at": "2017-01-01 12:00:00",
"locked_writer_id": 2,
"responsible_writer_id": 1,
"is_notified_due": 0,
"is_notified_overdue": 0,
"due_at": "2018-07-01 10:00:00",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"writer": {
"data": {
"id": 2,
"account_id": 1,
"name": "Suzanne Toorop",
"email": "suzanne@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}
}
}HTTP Request
DELETE process/{processId}/document/{documentId}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| processid | required | id of the process |
| documentid | required | id of the document |
Backoffice - Ratings
Retrieval and creation document ratings.
ratings
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("ratings", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"rating": 2,
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17"
},
{
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"rating": 2,
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17"
}
]
}HTTP Request
GET ratings
rating/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("rating/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "nostrum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"rating": 2,
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17"
}
}HTTP Request
GET rating/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the rating |
ratings
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("ratings", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"reader_id": 1,
"document_id": 1,
"process_id": null,
"rating": 2,
"created_at": "2019-05-02 10:34:17",
"updated_at": "2019-05-02 10:34:17"
}
}HTTP Request
POST ratings
Backoffice - Readers
Retrieval of reader details and create, update and deactivate readers. Attach and detach the readers positions.
readers
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("readers", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
},
{
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
]
}HTTP Request
GET readers
reader/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("reader/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "repudiandae",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}HTTP Request
GET reader/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the reader |
reader/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("reader/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "aut",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}HTTP Request
GET reader/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the reader |
reader/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("reader/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "voluptatum",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}HTTP Request
PUT reader/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the reader |
readers
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("readers", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}HTTP Request
POST readers
reader/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("reader/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "dolorem",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}HTTP Request
POST reader/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the reader |
reader/{id}/positions
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("reader/1/positions", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "dolores",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Noortje",
"email": "noortje@handboekapp.nl",
"cellphone": "0031642634418",
"status": "active",
"push_id": "21f381fe-dbbd-4fa7-a2c4-e696a4eb8046",
"device_type": null,
"device_os": null,
"device_model": null,
"app_build": null,
"app_used_at": "1970-01-01 01:00:00",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-27 13:09:34"
}
}HTTP Request
PUT reader/{id}/positions
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the reader |
Backoffice - Statistics
Retrieval of entity viewing statistics.
statistics/{entity}/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("statistics/1/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"entity" => "sed",
"entityId" => "veniam",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response:
nullHTTP Request
GET statistics/{entity}/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| entity | required | the entity to get statistics for |
| entityId | required | the id of the entity to get statistics for |
Backoffice - Steps
Retrieval of process step details and create, update and delete steps.
steps
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("steps", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"process_id": 1,
"position_id": 1,
"step": 1,
"section": "1",
"name": "Eerste hulp verlenen",
"description": "Eerste hulp verlenen",
"type": "action",
"step_link_from": 0,
"step_link_to": 0,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"position": {
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}
},
{
"id": 1,
"account_id": 1,
"process_id": 1,
"position_id": 1,
"step": 1,
"section": "1",
"name": "Eerste hulp verlenen",
"description": "Eerste hulp verlenen",
"type": "action",
"step_link_from": 0,
"step_link_to": 0,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"position": {
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}
}
]
}HTTP Request
GET steps
step/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("step/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "pariatur",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"process_id": 1,
"position_id": 1,
"step": 1,
"section": "1",
"name": "Eerste hulp verlenen",
"description": "Eerste hulp verlenen",
"type": "action",
"step_link_from": 0,
"step_link_to": 0,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"position": {
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}
}
}HTTP Request
GET step/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the step |
step/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("step/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "animi",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"process_id": 1,
"position_id": 1,
"step": 1,
"section": "1",
"name": "Eerste hulp verlenen",
"description": "Eerste hulp verlenen",
"type": "action",
"step_link_from": 0,
"step_link_to": 0,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"position": {
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}
}
}HTTP Request
PUT step/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the step |
steps
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("steps", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"process_id": 1,
"position_id": 1,
"step": 1,
"section": "1",
"name": "Eerste hulp verlenen",
"description": "Eerste hulp verlenen",
"type": "action",
"step_link_from": 0,
"step_link_to": 0,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"position": {
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}
}
}HTTP Request
POST steps
step/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->delete("step/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "provident",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"process_id": 1,
"position_id": 1,
"step": 1,
"section": "1",
"name": "Eerste hulp verlenen",
"description": "Eerste hulp verlenen",
"type": "action",
"step_link_from": 0,
"step_link_to": 0,
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"position": {
"data": {
"id": 1,
"account_id": 1,
"department_id": 1,
"name": "Zorghulp",
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15",
"department": {
"data": {
"id": 1,
"parent_id": null,
"account_id": 1,
"name": "Intramuraal",
"description": "Een hoofdafdeling",
"descendants": [
{
"id": 2,
"account_id": 1,
"name": "Verpleeghuiszorg",
"description": "Een subafdeling",
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16",
"_lft": 2,
"_rgt": 3,
"parent_id": 1,
"depth": 1,
"entity_type": "department",
"positions": []
}
],
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-02 10:34:16"
}
}
}
}
}
}HTTP Request
DELETE step/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the step |
Backoffice - Tags
Retrieval of tag details and create, update and archive tags.
tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
},
{
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
]
}HTTP Request
GET tags
tag/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("tag/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "et",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
}HTTP Request
GET tag/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
tag/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("tag/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "dolorem",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
}HTTP Request
GET tag/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
tag/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("tag/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "ab",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
}HTTP Request
PUT tag/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the tag |
tags
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("tags", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Functiebeschrijving",
"color": "#00d1b2",
"is_browsable": 1,
"status": "active",
"created_at": "2019-05-02 10:34:16",
"updated_at": "2019-05-27 14:17:39"
}
}HTTP Request
POST tags
Backoffice - Tools
Various tools that offer functionality while working with documents or other entities.
tools/convert/document/word
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("tools/convert/document/word", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"message": "Conversion succesful",
"content": "<markdown>"
}
}HTTP Request
POST tools/convert/document/word
Backoffice - Writers
Retrieval of writer details and create, update and deactivate writers.
writers
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("writers", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": [
{
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
},
{
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
]
}HTTP Request
GET writers
writer/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("writer/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "qui",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}HTTP Request
GET writer/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the writer |
writer/{id}/archive
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get("writer/1/archive", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "reprehenderit",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}HTTP Request
GET writer/{id}/archive
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the writer |
writer/{id}
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put("writer/1", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
'query' => [
"id" => "tempore",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}HTTP Request
PUT writer/{id}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| id | required | id of the writer |
writers
Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post("writers", [
'headers' => [
"Authorization" => "Bearer {token}",
"Content-Type" => "application/json",
],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (200):
{
"data": {
"id": 1,
"account_id": 1,
"name": "Jeroen van Brink",
"email": "jeroen@handboekapp.nl",
"cellphone": "0031642634418",
"is_notified_due": 1,
"is_notified_comment": 1,
"is_twofactor_authenticated": 0,
"status": "active",
"created_at": "2019-05-02 10:34:15",
"updated_at": "2019-05-02 10:34:15"
}
}HTTP Request
POST writers