Types of documents

Types of documents are:

• event
• user
• group
• schema
• agenda
• category

Common attributes

Warning

These attributes are read only.

id (String)

It is the unique identifier of the document. It is also its URI. So you can do a GET request on a document’s id to get it.

createDate (Datetime)

creation date.

updateDate (String)

Last update date.

Type user

These documents holds informations about registered users.

firstName (String)

lastName (String)

email (String)

Warning

To be the user or to have a staff account is required to write/update this attribute

password (String)

Warning

To be the user or to have a staff account is required to write/update this attribute

isActive (Boolean)

Warning

Staff account is required to write/update this attribute

True if the user is active. Inactive users cant’s access the service.

isStaff (Boolean)

Warning

Staff account is required to write/update this attribute

True if the user is a staff member. Only staff members can access the admin interface.

isSuperuser (Boolean)

Warning

Staff account is required to write/update this attribute

True if the user is a super user. Super users have no restrictions when accessing the admin interface.

lastSeen (Datetime)

Warning

Read only

Date of last authentication against the service.

dateJoined (Datetime)

Warning

Read only

Date of the registration.

groups (String)

Warning

Read only

Contains an URI to get groups list of which the user is a member.

Type event

event (Object)

event attribute contains a data structure that describes the event itself. this structure is constrained by a schema document type.

author (String)

Warning

Read only

The user id of the user document type.

writeGroups (List)

Warning

Read only

Contains an URI to get write group permissions.

readGroups (List)

Warning

Read only

Contains an URI to get read group permissions.

writeUsers (List)

Warning

Read only

Contains an URI to get write user permissions.

readUsers (List)

Warning

Read only

Contains an URI to get read user permissions.

Type schema

These documents are used to describe and validate the event attribute for the event document type

name (String)

schema (Object)

Contains the data structure used to validate. More informations can be found here

final (Boolean)

Warning

Staff account is required to write/update this attribute

True if the document can be used to validate an event. If false the document must be part of an inheritance.

sample (Object)

Contains a data sample that validate the schema.

template (String)

Contains a template which can be used to render an event as html.

status (Enum)

Warning

Staff account is required to write/update this attribute

Define document’s status

• PUBLISHED
• DRAFT
• DEPRECATED

Type entity

entity (Object)

entity attribute contains a data structure that describes the entity itself. this structure is constrained by a schema document type.

author (String)

Warning

read only

The user id of the user document type.

writeGroups (List)

Contains an URI to get write group permissions.

writeUsers (List)

Warning

read only

Contains an URI to get write user permissions.

Type category

Warning

Create, update and delete require staff privileges

Category are used in event.

title (String)

description (String)

author (String)

Warning

read only

The user id of the user document type.

Type group

title (String)

description (String)

users (String)

Warning

Read only

Contains an URI to get group memberships in terms of the group.

writeGroups (List)

Warning

Read only

Contains an URI to get write group permissions.

writeUsers (List)

Warning

Read only

Contains an URI to get write user permissions.

Type agenda

title (String)

description (String)

writeGroups (List)

Warning

Read only

Contains an URI to get write group permissions.

writeUsers (List)

Warning

Read only

Contains an URI to get write user permissions.

Type membership

user (String)

Contains the user id

group (String)

Contains the group id