========================
Event object description
========================

Requirements for event creation
-------------------------------

+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **Tag**                      | **Required** | **Value**       | **Description**                                                     |
+==============================+==============+=================+=====================================================================+ 
| **event**:occupants          |true          | Object          | Array of User object                                                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:jabberId       |true          | String          | jabberId of user                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:isAdmin        |false         | boolean         |                                                                     |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:isOwner        |false         | boolean         |                                                                     |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:start_date         |true          | datetime        | start date and time of the event                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:end_date           |true          | datetime        | end date and time of the event                                      |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:roomname           |true          | String          | name of the event                                                   |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:subject            |false         | String          | description of the event                                            |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:label              |false         | String          | label of the event                                                  |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:event_type         |true          | String          | type of the event `private, public`                                 |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:members_can_invite |false         | boolean         | define if a member is allowed to invite, default value is **false** |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:members_can_chat   |false         | boolean         | define if a member is allowed to invite, default value is **true**  |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:location           |true          | json object     | location information                                                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:lat             |true          | double          | location latitude                                                   |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:lng             |true          | double          | location longitude                                                  |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:location_name   |false         | String          | name of the place where the event is going to happen                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:street_address  |false         | String          | street address of the location                                      |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+

Requirements for event configuration change
-------------------------------------------

+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **Tag**                      | **Required** | **Value**       | **Description**                                                     |
+==============================+==============+=================+=====================================================================+ 
| **event**:jid                | true         | String          | jid of the event                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:occupants          | false        | Object          | Array of User object                                                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:jabberId       | true         | String          | jabberId of user                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:isAdmin        | false        | boolean         |                                                                     |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:action         | true         | String          | `add,remove`                                                        |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:start_date         | false        | datetime        | start date and time of the event                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:end_date           | false        | datetime        | end date and time of the event                                      |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:roomname           | false        | String          | name of the event                                                   |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:subject            | false        | String          | description of the event                                            |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:label              | false        | String          | label of the event                                                  |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:event_type         | false        | String          | type of the event `private, public`                                 |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:members_can_invite | false        | boolean         | define if a member is allowed to invite, default value is **false** |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:members_can_chat   | false        | boolean         | define if a member is allowed to invite, default value is **true**  |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:location           | false        | json object     | location information                                                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:lat             | true         | double          | location latitude                                                   |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:lng             | true         | double          | location longitude                                                  |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:location_name   | false        | String          | name of the place where the event is going to happen                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **location**:street_address  | false        | String          | street address of the location                                      |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+



Requirements for event change occupants
---------------------------------------

+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **Tag**                      | **Required** | **Value**       | **Description**                                                     |
+==============================+==============+=================+=====================================================================+  
| **event**:jid                |true          | String          | jid of the event                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:occupants          |true          | Object          | Array of User object                                                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:jabberId       |true          | String          | jabberId of user                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:action         |true          | String          | `add,remove`                                                        |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+



Requirements for event set participation
----------------------------------------

+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **Tag**                      | **Required** | **Value**       | **Description**                                                     |
+==============================+==============+=================+=====================================================================+ 
| **event**:jid                | true         | String          | jid of the event                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **event**:occupants          | true         | Object          | Array of User object                                                |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:jabberId       | true         | String          | jabberId of user                                                    |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+
| **occupants**:status         | true         | String          | `maybe,joined,declined,requested`                                   |
+------------------------------+--------------+-----------------+---------------------------------------------------------------------+