A "participant" entity represents a contact or team's participation in an [Appointment].
The "role" of the participant will be one of the following:
| Role | Description |
|---|---|
| CHAIR | Indicates chair of the calendar entity. |
| REQ-PARTICIPANT | Indicates a participant whose participation is required. |
| OPT-PARTICIPANT | Indicates a participant whose participation is optional. |
| NON-PARTICIPANT | Indicates a participant who is copied for informational purposes only. |
The "status" of the participant will be one of the following:
| Status | Description |
|---|---|
| NEEDS-ACTION | User has not set a participant status. |
| ACCEPTED | Event accepted. |
| DECLINED | Event declined. |
| TENTATIVE | Event tentatively accepted. |
| DELEGATED | Event participation delegated. |
In order to change their participant status the user must send a [ParticipantStatus] entity to the server.
"participant" entities are returned in the PARTICIPANTS special key of an [Appointment] entity when a detail level including zOGI_INCLUDE_PARTICIPANTS is specified.
As of revision 239 of the legacy OpenGroupware zOGI module the participant entity contains an additional "appointmentObjectId" element that refers to the appointment to which the participant entity belongs. This attribute is included in all versions of OpenGroupware Coils' zOGI implementation.
{'entityName': 'participant',
'firstName': 'Adam',
'lastname': 'Williams',
'objectId': 15050,
'appointmentObjectId': 40390,
'participantEntityName': 'Contact',
'participantObjectId': 10160,
'role': 'CHAIR'}
{'comment': '',
'entityName': 'participant',
'name': 'all intranet',
'objectId': 15060,
'appointmentObjectId': 40390,
'participantEntityName': 'Team',
'participantObjectId': 10003,
'role': 'REQ-PARTICIPANT',
'rsvp': ''}