Meeting
Information about meetings
Accept header for requests to Meeting
application/vnd.procurios.meeting2+json; version=2
Schema (GET)
GET /l/meeting2_api/meetings/schema
Get a JSON schema for meetings for GET requests
Examples
[]
200
{
"$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
"title": "Meeting",
"type": "object",
"properties": {
"title": {
"title": "Title",
"type": "string"
},
"ownerId": {
"title": "Owner ID",
"description": "The Procurios relation ID of the owner of the meeting",
"type": "integer"
},
"start": {
"title": "Start",
"description": "The start date time of this meeting",
"type": "string",
"format": "date-time"
},
"end": {
"title": "End",
"description": "The end date time of this meeting",
"type": "string",
"format": "date-time"
},
"publishedFrom": {
"title": "Published from",
"description": "The date from which the meeting is published",
"type": "string",
"format": "date-time"
},
"registrationEnd": {
"title": "Registration end",
"description": "The date from which registration is no longer possible",
"type": "string",
"format": "date-time"
},
"languageCode": {
"title": "Language code",
"description": "The ISO 639-1 language code of the primary language of the meeting",
"type": "string",
"pattern": "^[a-z]{2}$"
},
"shortDescription": {
"title": "Short description",
"description": "A short description of the meeting",
"type": "string"
},
"longDescription": {
"title": "Long description",
"description": "A longer description of the meeting",
"type": "string"
},
"locationIds": {
"title": "Location ids",
"description": "The Procurios ids of the locations in this meeting",
"type": "array",
"items": {
"type": "integer"
}
},
"attendanceMode": {
"title": "Attendance mode",
"type": "enum",
"enumNames": {
"online": "This is an online meeting (e.g. a webinar)",
"offline": "This is an offline meeting",
"mixed": "This meeting is both online and offline"
},
"enum": [
"online",
"offline",
"mixed"
]
},
"coverPhoto": {
"title": "Cover photo",
"type": "object",
"items": {
"url": {
"title": "Url of cover image",
"type": "string"
}
}
},
"isRegistrationPossible": {
"title": "Is registration possible",
"description": "Is registration possible for this meeting",
"type": "bool"
},
"registrationCancellation": {
"title": "Cancellation of registration",
"description": "Information about the cancellation options for this meeting",
"type": "object",
"properties": {
"isCancellationAllowed": {
"title": "Is cancellation allowed",
"description": "Is cancellation allowed for the current date and time",
"type": "boolean"
},
"cancellationIsAllowedUntil": {
"title": "Cancellation is allowed until",
"description": "Cancellation is allowed until this date and time",
"type": "string",
"format": "date-time"
}
}
},
"categories": {
"title": "Categories",
"description": "Categories and sub-category information for this meeting",
"type": "object",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"subCategories": {
"type": "object",
"items": {
"name": {
"type": "string"
}
}
}
}
},
"tags": {
"title": "Tags",
"type": "array",
"items": {
"type": "string"
}
},
"_links": {
"title": "Links for this meeting",
"description": "A collection of links to get more information on this meeting",
"type": "object",
"properties": {
"details": {
"title": "Details",
"description": "Get additional details for this meeting",
"type": "string",
"format": "uri"
},
"registrationSchema": {
"title": "Registrations schema",
"description": "Get the schema for this meeting's registrations",
"type": "string",
"format": "uri"
},
"registrations": {
"title": "Registrations",
"description": "Get all registrations for this meeting",
"type": "string",
"format": "uri"
}
}
}
},
"required": [
"title",
"ownerId",
"start",
"languageCode"
]
}
Schema (PUT/POST)
GET /l/meeting2_api/meetings/schema/post
Get a JSON schema for meetings for PUT/POST requests
Examples
[]
200
{
"$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
"title": "Meeting",
"type": "object",
"properties": {
"title": {
"title": "Title",
"type": "string"
},
"ownerId": {
"title": "Owner ID",
"description": "The Procurios relation ID of the owner of the meeting",
"type": "integer"
},
"start": {
"title": "Start",
"description": "The start date time of this meeting",
"type": "string",
"format": "date-time"
},
"end": {
"title": "End",
"description": "The end date time of this meeting",
"type": "string",
"format": "date-time"
},
"publishedFrom": {
"title": "Published from",
"description": "The date from which the meeting is published",
"type": "string",
"format": "date-time"
},
"registrationEnd": {
"title": "Registration end",
"description": "The date from which registration is no longer possible",
"type": "string",
"format": "date-time"
},
"languageCode": {
"title": "Language code",
"description": "The ISO 639-1 language code of the primary language of the meeting",
"type": "string",
"pattern": "^[a-z]{2}$"
},
"shortDescription": {
"title": "Short description",
"description": "A short description of the meeting",
"type": "string"
},
"longDescription": {
"title": "Long description",
"description": "A longer description of the meeting",
"type": "string"
},
"locationIds": {
"title": "Location ids",
"description": "The Procurios ids of the locations in this meeting",
"type": "array",
"items": {
"type": "integer"
}
},
"attendanceMode": {
"title": "Attendance mode",
"type": "enum",
"enumNames": {
"online": "This is an online meeting (e.g. a webinar)",
"offline": "This is an offline meeting",
"mixed": "This meeting is both online and offline"
},
"enum": [
"online",
"offline",
"mixed"
]
},
"coverPhoto": {
"title": "Cover photo",
"type": "object",
"items": {
"url": {
"title": "Url of cover image",
"type": "string"
}
}
},
"_links": {
"title": "Links for this meeting",
"description": "A collection of links to get more information on this meeting",
"type": "object",
"properties": {
"details": {
"title": "Details",
"description": "Get additional details for this meeting",
"type": "string",
"format": "uri"
},
"registrationSchema": {
"title": "Registrations schema",
"description": "Get the schema for this meeting's registrations",
"type": "string",
"format": "uri"
},
"registrations": {
"title": "Registrations",
"description": "Get all registrations for this meeting",
"type": "string",
"format": "uri"
}
}
}
},
"required": [
"title",
"ownerId",
"start",
"languageCode"
]
}
Meetings
GET /l/meeting2_api/meetings
Get a set of published, upcoming meetings
Parameters
| Parameter | Type | Description |
|---|---|---|
| search | string | Filter results by the given search key |
Examples
[]
200
{
"meetings": [
{
"id": 42,
"title": "Demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"end": "2020-02-02T17:30:00+02:00",
"publishedFrom": "2020-01-01T00:00:00+02:00",
"registrationEnd": "2020-02-01T00:00:00+02:00",
"languageCode": "nl",
"shortDescription": "<p>Een meeting ter demonstratie<\/p>",
"longDescription": "",
"locationIds": [],
"attendanceMode": {},
"coverPhoto": {
"url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
},
"isRegistrationPossible": true,
"registrationCancellation": {
"isCancellationAllowed": true,
"cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
},
"schedule": [],
"_links": {
"details": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42",
"registrationSchema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration\/schema",
"registrations": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration"
}
}
],
"_links": {
"schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
}
}
Historical meetings
GET /l/meeting2_api/meetings/historical
Get a set of published, past events
Examples
[]
200
{
"meetings": [
{
"id": 42,
"title": "Demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"end": "2020-02-02T17:30:00+02:00",
"publishedFrom": "2020-01-01T00:00:00+02:00",
"registrationEnd": "2020-02-01T00:00:00+02:00",
"languageCode": "nl",
"shortDescription": "<p>Een meeting ter demonstratie<\/p>",
"longDescription": "",
"locationIds": [],
"attendanceMode": {},
"coverPhoto": {
"url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
},
"isRegistrationPossible": true,
"registrationCancellation": {
"isCancellationAllowed": true,
"cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
},
"schedule": [],
"_links": {
"details": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42",
"registrationSchema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration\/schema",
"registrations": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration"
}
}
],
"_links": {
"schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
}
}
Create a meeting
POST /l/meeting2_api/meetings
Create a new meeting
Examples
{
"title": "Another demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"languageCode": "nl"
}
200
{
"meetingId": 43
}
Meeting
GET /l/meeting2_api/meetings/42
Get a meeting
Examples
[]
200
{
"id": 42,
"title": "Demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"end": "2020-02-02T17:30:00+02:00",
"publishedFrom": "2020-01-01T00:00:00+02:00",
"registrationEnd": "2020-02-01T00:00:00+02:00",
"languageCode": "nl",
"shortDescription": "<p>Een meeting ter demonstratie<\/p>",
"longDescription": "",
"locationIds": [],
"attendanceMode": {},
"coverPhoto": {
"url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
},
"isRegistrationPossible": true,
"registrationCancellation": {
"isCancellationAllowed": true,
"cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
},
"schedule": [
{
"id": 229,
"title": "Demo",
"sections": [
{
"id": 877,
"start": "2020-02-01T09:30:00+02:00",
"end": "2020-02-01T09:30:00+02:00",
"activities": [
{
"id": 1454,
"title": "Example title",
"description": "Example description"
}
]
}
]
}
],
"_links": {
"details": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42",
"registrationSchema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration\/schema",
"registrations": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration"
}
}
Meeting
PUT /l/meeting2_api/meetings/42
Update a meeting
Examples
{
"title": "Another demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"languageCode": "nl"
}
200
{
"meetingId": 42
}
Meeting
POST /l/meeting2_api/meetings/42
Update a meeting (see PUT)
Meeting
DELETE /l/meeting2_api/meetings/42
Remove a meeting
Examples
[]
200
[]
Upcoming meetings for relation
GET /l/meeting2_api/meetings/upcoming/42
Get a set of upcoming meetings that the given relation is registered to attend
Parameters
| Parameter | Type | Description |
|---|---|---|
| page | int | The api will provide 25 results per page |
Examples
[]
200
{
"meetings": [
{
"id": 42,
"title": "Demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"end": "2020-02-02T17:30:00+02:00",
"publishedFrom": "2020-01-01T00:00:00+02:00",
"registrationEnd": "2020-02-01T00:00:00+02:00",
"languageCode": "nl",
"shortDescription": "<p>Een meeting ter demonstratie<\/p>",
"longDescription": "",
"locationIds": [],
"attendanceMode": {},
"coverPhoto": {
"url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
},
"isRegistrationPossible": true,
"registrationCancellation": {
"isCancellationAllowed": true,
"cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
},
"schedule": [],
"_links": {
"details": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42",
"registrationSchema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration\/schema",
"registrations": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration"
}
}
],
"_links": {
"schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
}
}
Historical meetings for relation
GET /l/meeting2_api/meetings/historical/42
Get a set of historical meetings that the given relation was registered to attend
Parameters
| Parameter | Type | Description |
|---|---|---|
| page | int | The api will provide 25 results per page |
Examples
[]
200
{
"meetings": [
{
"id": 42,
"title": "Demo meeting",
"ownerId": 99,
"start": "2020-02-01T09:30:00+02:00",
"end": "2020-02-02T17:30:00+02:00",
"publishedFrom": "2020-01-01T00:00:00+02:00",
"registrationEnd": "2020-02-01T00:00:00+02:00",
"languageCode": "nl",
"shortDescription": "<p>Een meeting ter demonstratie<\/p>",
"longDescription": "",
"locationIds": [],
"attendanceMode": {},
"coverPhoto": {
"url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
},
"isRegistrationPossible": true,
"registrationCancellation": {
"isCancellationAllowed": true,
"cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
},
"schedule": [],
"_links": {
"details": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42",
"registrationSchema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration\/schema",
"registrations": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/42\/registration"
}
}
],
"_links": {
"schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
}
}
