Appearance
FormMessages
Introduction
FormMessages
are the processed and validated input of a User when submitting a Form.
They contain all information which is needed and used when sending the ForMessage to their receivers and are generated from FormMessageFields when sending a Form.
Model & Relations
Namespace
Modules\Forms\Entities\FormMessage
Relations
Relation | Key | Type | Relation Field(s) |
---|---|---|---|
User | user | Belongs to | user_id |
Department | department | Belongs to | department_id |
Form | form | Belongs to | form_id |
FormMessageFields | formMessageFields | Has many | form_message_field.form_message_id |
Computed Properties
hash
- The hashedid
of theFormMessage
List
Get a list of all FormMessages
.
Definition
GET /api/forms/messages
Example Request
php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/forms/messages', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
json
[
{
"id": 4,
"user_id": 2,
"group_account_user_id": null,
"department_id": 1,
"form_id": 1,
"recipient": null,
"subject": "\"Form-1-changed\" wurde von intratool Service (intratool) \u00fcbertragen",
"body": "<p><strong>Field-1</strong></p><p>https://intratool.de</p><p><br></p><p><strong>Field-2</strong></p><p>accusam et</p><p><br></p>",
"sent_at": "2019-01-25 14:18:05",
"created_at": "2019-01-25 14:18:05",
"updated_at": "2019-01-25 14:18:05",
"hash": "2w54q7xmvk1drl8ygeo96jrd"
},
{
"id": 5,
"user_id": 2,
"group_account_user_id": null,
"department_id": 1,
"form_id": 1,
"recipient": null,
"subject": "\"Form-1-changed\" wurde von intratool Service (intratool) \u00fcbertragen",
"body": "<p><strong>Field-1</strong></p><p>https://intratool.de</p><p><br></p><p><strong>Field-2</strong></p><p>congue nihil</p><p><br></p>",
"sent_at": "2019-01-25 14:19:25",
"created_at": "2019-01-25 14:19:25",
"updated_at": "2019-01-25 14:19:25",
"hash": "r609mj42kn1rm3v58dogz7we"
}
]
Get
Get a single FormMessage
by id
.
Definition
GET /api/forms/messages/{id}
Example Request
php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/forms/messages/4', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
json
{
"id": 4,
"user_id": 2,
"group_account_user_id": null,
"department_id": 1,
"form_id": 1,
"recipient": null,
"subject": "\"Form-1-changed\" wurde von intratool Service (intratool) \u00fcbertragen",
"body": "<p><strong>Field-1</strong></p><p>https://intratool.de</p><p><br></p><p><strong>Field-2</strong></p><p>accusam et</p><p><br></p>",
"sent_at": "2019-01-25 14:18:05",
"created_at": "2019-01-25 14:18:05",
"updated_at": "2019-01-25 14:18:05",
"hash": "2w54q7xmvk1drl8ygeo96jrd"
}