API Documentation

Schema (GET) GET

URL: /l/meeting2_api/meetings/schema

Scope:

meeting2/read

Last used: Never

Get a JSON schema for meetings for GET requests

Live testing disabled

Schema (GET)

GET

json

jsonStatus: 200

{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Meeting",
    "type": "object",
    "definitions": {
        "mlString": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "locale": {
                        "type": "string"
                    },
                    "string": {
                        "type": "string"
                    }
                },
                "required": [
                    "locale",
                    "string"
                ]
            }
        }
    },
    "properties": {
        "search": {
            "title": "Text search",
            "description": "Search for keyword in meeting title, meeting short description and meeting long description",
            "type": "string"
        },
        "filter_1351099": {
            "title": "Aanwezig bij Release Webinar",
            "description": "Search for meetings with these attendance modes",
            "type": "array",
            "items": {
                "type": "string",
                "enum": [
                    "online",
                    "mixed",
                    "offline"
                ],
                "enumNames": {
                    "online": "Dit is een online bijeenkomst (bijv. een webinar)",
                    "mixed": "Deze bijeenkomst is zowel online als offline",
                    "offline": "Dit is een offline bijeenkomst"
                }
            }
        },
        "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": "string",
            "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"
                }
            }
        },
        "title_ml": {
            "title": "Title (multilingual)",
            "$ref": "#\/definitions\/mlString"
        },
        "shortDescription_ml": {
            "title": "Short description (multilingual)",
            "$ref": "#\/definitions\/mlString"
        },
        "longDescription_ml": {
            "title": "Long description (multilingual)",
            "$ref": "#\/definitions\/mlString"
        },
        "ticketInformation": {
            "title": "Ticket information (multilingual)",
            "$ref": "#\/definitions\/mlString"
        },
        "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"
                }
            }
        },
        "contactPerson": {
            "title": "Contact person for this meeting",
            "description": "Information about the contact person for this meeting",
            "type": "object",
            "properties": {
                "name": {
                    "title": "Contact person name",
                    "type": "string"
                },
                "email": {
                    "title": "Contact person email address",
                    "type": "string"
                }
            }
        },
        "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"
                },
                "meetingDetailPage": {
                    "title": "Meeting detail page",
                    "description": "Front-end page with meeting details",
                    "type": "string",
                    "format": "uri"
                },
                "meetingRegistrationPage": {
                    "title": "Meeting registration page",
                    "description": "Front-end registration page for this meeting",
                    "type": "string",
                    "format": "uri"
                }
            }
        }
    },
    "required": [
        "title",
        "ownerId",
        "start",
        "languageCode"
    ]
}

Schema (PUT/POST) GET

URL: /l/meeting2_api/meetings/schema/post

Scope:

meeting2/write

Last used: Never

Get a JSON schema for meetings for PUT/POST requests

Live testing disabled

Schema (PUT/POST)

GET

json

jsonStatus: 200

{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Meeting",
    "type": "object",
    "definitions": {
        "mlString": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "locale": {
                        "type": "string"
                    },
                    "string": {
                        "type": "string"
                    }
                },
                "required": [
                    "locale",
                    "string"
                ]
            }
        }
    },
    "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": "string",
            "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"
                },
                "meetingDetailPage": {
                    "title": "Meeting detail page",
                    "description": "Front-end page with meeting details",
                    "type": "string",
                    "format": "uri"
                },
                "meetingRegistrationPage": {
                    "title": "Meeting registration page",
                    "description": "Front-end registration page for this meeting",
                    "type": "string",
                    "format": "uri"
                }
            }
        }
    },
    "required": [
        "title",
        "ownerId",
        "start",
        "languageCode"
    ]
}

Meetings GET

URL: /l/meeting2_api/meetings

Scope:

meeting2/read

Last used: Never

Get a set of published, upcoming meetings

Parameters

Parameter	Type	Description
search	string	Filter results by the given search key

Live testing disabled

Meetings

GET

json

jsonStatus: 200

{
    "meetings": [
        {
            "id": 42,
            "title": "Demo bijeenkomst",
            "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 bijeenkomst ter demonstratie<\/p>",
            "longDescription": "",
            "locationIds": [],
            "attendanceMode": {
                "value": "mixed"
            },
            "coverPhoto": {
                "url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
            },
            "title_ml": [
                {
                    "locale": "nl_NL",
                    "string": "Demo bijeenkomst"
                },
                {
                    "locale": "en_US",
                    "string": "Demo meeting"
                }
            ],
            "shortDescription_ml": [
                {
                    "locale": "nl_NL",
                    "string": "<p>Een bijeenkomst ter demonstratie<\/p>"
                },
                {
                    "locale": "en_US",
                    "string": "A meeting as demonstration"
                }
            ],
            "longDescription_ml": [],
            "ticketInformation": [
                {
                    "locale": "nl_NL",
                    "string": "Informatie over tickets ter demonstratie"
                },
                {
                    "locale": "en_US",
                    "string": "Information about tickets as demonstration"
                }
            ],
            "isRegistrationPossible": true,
            "registrationCancellation": {
                "isCancellationAllowed": true,
                "cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
            },
            "contactPerson": {
                "name": "John Doe",
                "email": "john@example.com"
            },
            "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",
                "meetingDetailPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/about",
                "meetingRegistrationPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/register"
            }
        }
    ],
    "_links": {
        "schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
    }
}

Historical meetings GET

URL: /l/meeting2_api/meetings/historical

Scope:

meeting2/read

Last used: Never

Get a set of published, past events

Live testing disabled

Historical meetings

GET

json

jsonStatus: 200

{
    "meetings": [
        {
            "id": 42,
            "title": "Demo bijeenkomst",
            "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 bijeenkomst ter demonstratie<\/p>",
            "longDescription": "",
            "locationIds": [],
            "attendanceMode": {
                "value": "mixed"
            },
            "coverPhoto": {
                "url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
            },
            "title_ml": [
                {
                    "locale": "nl_NL",
                    "string": "Demo bijeenkomst"
                },
                {
                    "locale": "en_US",
                    "string": "Demo meeting"
                }
            ],
            "shortDescription_ml": [
                {
                    "locale": "nl_NL",
                    "string": "<p>Een bijeenkomst ter demonstratie<\/p>"
                },
                {
                    "locale": "en_US",
                    "string": "A meeting as demonstration"
                }
            ],
            "longDescription_ml": [],
            "ticketInformation": [
                {
                    "locale": "nl_NL",
                    "string": "Informatie over tickets ter demonstratie"
                },
                {
                    "locale": "en_US",
                    "string": "Information about tickets as demonstration"
                }
            ],
            "isRegistrationPossible": true,
            "registrationCancellation": {
                "isCancellationAllowed": true,
                "cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
            },
            "contactPerson": {
                "name": "John Doe",
                "email": "john@example.com"
            },
            "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",
                "meetingDetailPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/about",
                "meetingRegistrationPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/register"
            }
        }
    ],
    "_links": {
        "schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
    }
}

Create a meeting POST

URL: /l/meeting2_api/meetings

Scope:

meeting2/write

Last used: Never

Create a new meeting

Validation

{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Meeting",
    "type": "object",
    "definitions": {
        "mlString": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "locale": {
                        "type": "string"
                    },
                    "string": {
                        "type": "string"
                    }
                },
                "required": [
                    "locale",
                    "string"
                ]
            }
        }
    },
    "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": "string",
            "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"
                },
                "meetingDetailPage": {
                    "title": "Meeting detail page",
                    "description": "Front-end page with meeting details",
                    "type": "string",
                    "format": "uri"
                },
                "meetingRegistrationPage": {
                    "title": "Meeting registration page",
                    "description": "Front-end registration page for this meeting",
                    "type": "string",
                    "format": "uri"
                }
            }
        }
    },
    "required": [
        "title",
        "ownerId",
        "start",
        "languageCode"
    ]
}

Live testing disabled

Create a meeting

POST

json

{
    "title": "Another demo meeting",
    "ownerId": 99,
    "start": "2020-02-01T09:30:00+02:00",
    "languageCode": "nl"
}

jsonStatus: 200

{
    "meetingId": 43
}

Meeting GET

URL: /l/meeting2_api/meetings/42

Scope:

meeting2/read

Last used: Never

Get a meeting

Live testing disabled

Meeting

GET

json

jsonStatus: 200

{
    "id": 42,
    "title": "Demo bijeenkomst",
    "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 bijeenkomst ter demonstratie<\/p>",
    "longDescription": "",
    "locationIds": [],
    "attendanceMode": {
        "value": "mixed"
    },
    "coverPhoto": {
        "url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
    },
    "title_ml": [
        {
            "locale": "nl_NL",
            "string": "Demo bijeenkomst"
        },
        {
            "locale": "en_US",
            "string": "Demo meeting"
        }
    ],
    "shortDescription_ml": [
        {
            "locale": "nl_NL",
            "string": "<p>Een bijeenkomst ter demonstratie<\/p>"
        },
        {
            "locale": "en_US",
            "string": "A meeting as demonstration"
        }
    ],
    "longDescription_ml": [],
    "ticketInformation": [
        {
            "locale": "nl_NL",
            "string": "Informatie over tickets ter demonstratie"
        },
        {
            "locale": "en_US",
            "string": "Information about tickets as demonstration"
        }
    ],
    "isRegistrationPossible": true,
    "registrationCancellation": {
        "isCancellationAllowed": true,
        "cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
    },
    "contactPerson": {
        "name": "John Doe",
        "email": "john@example.com"
    },
    "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",
        "meetingDetailPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/about",
        "meetingRegistrationPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/register"
    }
}

Meeting PUT

URL: /l/meeting2_api/meetings/42

Scope:

meeting2/write

Last used: Never

Update a meeting

Validation

{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Meeting",
    "type": "object",
    "definitions": {
        "mlString": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "locale": {
                        "type": "string"
                    },
                    "string": {
                        "type": "string"
                    }
                },
                "required": [
                    "locale",
                    "string"
                ]
            }
        }
    },
    "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": "string",
            "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"
                },
                "meetingDetailPage": {
                    "title": "Meeting detail page",
                    "description": "Front-end page with meeting details",
                    "type": "string",
                    "format": "uri"
                },
                "meetingRegistrationPage": {
                    "title": "Meeting registration page",
                    "description": "Front-end registration page for this meeting",
                    "type": "string",
                    "format": "uri"
                }
            }
        }
    },
    "required": [
        "title",
        "ownerId",
        "start",
        "languageCode"
    ]
}

Live testing disabled

Meeting

PUT

json

{
    "title": "Another demo meeting",
    "ownerId": 99,
    "start": "2020-02-01T09:30:00+02:00",
    "languageCode": "nl"
}

jsonStatus: 200

{
    "meetingId": 42
}

Meeting POST

URL: /l/meeting2_api/meetings/42

Scope:

meeting2/write

Last used: Never

Update a meeting

Validation

{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Meeting",
    "type": "object",
    "definitions": {
        "mlString": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "locale": {
                        "type": "string"
                    },
                    "string": {
                        "type": "string"
                    }
                },
                "required": [
                    "locale",
                    "string"
                ]
            }
        }
    },
    "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": "string",
            "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"
                },
                "meetingDetailPage": {
                    "title": "Meeting detail page",
                    "description": "Front-end page with meeting details",
                    "type": "string",
                    "format": "uri"
                },
                "meetingRegistrationPage": {
                    "title": "Meeting registration page",
                    "description": "Front-end registration page for this meeting",
                    "type": "string",
                    "format": "uri"
                }
            }
        }
    },
    "required": [
        "title",
        "ownerId",
        "start",
        "languageCode"
    ]
}

Live testing disabled

Meeting

POST

json

{
    "title": "Another demo meeting",
    "ownerId": 99,
    "start": "2020-02-01T09:30:00+02:00",
    "languageCode": "nl"
}

jsonStatus: 200

{
    "meetingId": 42
}

Meeting DELETE

URL: /l/meeting2_api/meetings/42

Scope:

meeting2/write

Last used: Never

Remove a meeting

Live testing disabled

Meeting

DELETE

Status: 204

Upcoming meetings for relation GET

URL: /l/meeting2_api/meetings/upcoming/42

Scope:

meeting2/read

Last used: Never

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

Live testing disabled

Upcoming meetings for relation

GET

json

jsonStatus: 200

{
    "meetings": [
        {
            "id": 42,
            "title": "Demo bijeenkomst",
            "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 bijeenkomst ter demonstratie<\/p>",
            "longDescription": "",
            "locationIds": [],
            "attendanceMode": {
                "value": "mixed"
            },
            "coverPhoto": {
                "url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
            },
            "title_ml": [
                {
                    "locale": "nl_NL",
                    "string": "Demo bijeenkomst"
                },
                {
                    "locale": "en_US",
                    "string": "Demo meeting"
                }
            ],
            "shortDescription_ml": [
                {
                    "locale": "nl_NL",
                    "string": "<p>Een bijeenkomst ter demonstratie<\/p>"
                },
                {
                    "locale": "en_US",
                    "string": "A meeting as demonstration"
                }
            ],
            "longDescription_ml": [],
            "ticketInformation": [
                {
                    "locale": "nl_NL",
                    "string": "Informatie over tickets ter demonstratie"
                },
                {
                    "locale": "en_US",
                    "string": "Information about tickets as demonstration"
                }
            ],
            "isRegistrationPossible": true,
            "registrationCancellation": {
                "isCancellationAllowed": true,
                "cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
            },
            "contactPerson": {
                "name": "John Doe",
                "email": "john@example.com"
            },
            "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",
                "meetingDetailPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/about",
                "meetingRegistrationPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/register"
            }
        }
    ],
    "_links": {
        "schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
    }
}

Historical meetings for relation GET

URL: /l/meeting2_api/meetings/historical/42

Scope:

meeting2/read

Last used: Never

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

Live testing disabled

Historical meetings for relation

GET

json

jsonStatus: 200

{
    "meetings": [
        {
            "id": 42,
            "title": "Demo bijeenkomst",
            "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 bijeenkomst ter demonstratie<\/p>",
            "longDescription": "",
            "locationIds": [],
            "attendanceMode": {
                "value": "mixed"
            },
            "coverPhoto": {
                "url": "https:\/\/api.procurios.com\/l\/library\/download\/urn:uuid:cea87149-3d05-4ed3-92f9-b842cfc04237\/cover_photo.png"
            },
            "title_ml": [
                {
                    "locale": "nl_NL",
                    "string": "Demo bijeenkomst"
                },
                {
                    "locale": "en_US",
                    "string": "Demo meeting"
                }
            ],
            "shortDescription_ml": [
                {
                    "locale": "nl_NL",
                    "string": "<p>Een bijeenkomst ter demonstratie<\/p>"
                },
                {
                    "locale": "en_US",
                    "string": "A meeting as demonstration"
                }
            ],
            "longDescription_ml": [],
            "ticketInformation": [
                {
                    "locale": "nl_NL",
                    "string": "Informatie over tickets ter demonstratie"
                },
                {
                    "locale": "en_US",
                    "string": "Information about tickets as demonstration"
                }
            ],
            "isRegistrationPossible": true,
            "registrationCancellation": {
                "isCancellationAllowed": true,
                "cancellationIsAllowedUntil": "2020-02-04T08:00:00+01:00"
            },
            "contactPerson": {
                "name": "John Doe",
                "email": "john@example.com"
            },
            "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",
                "meetingDetailPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/about",
                "meetingRegistrationPage": "https:\/\/api.procurios.com\/k\/n7836\/meeting2\/details\/42\/demo-bijeenkomst\/register"
            }
        }
    ],
    "_links": {
        "schema": "https:\/\/api.procurios.com\/l\/meeting2_api\/meetings\/schema"
    }
}

Meeting

Accept header for requests to Meeting

Schema (GET) GET

Scope:

Schema (GET)

Request

Response

Schema (PUT/POST) GET

Scope:

Schema (PUT/POST)

Request

Response

Meetings GET

Scope:

Parameters

Meetings

Request

Response

Historical meetings GET

Scope:

Historical meetings

Request

Response

Create a meeting POST

Scope:

Validation

Create a meeting

Request

Response

Meeting GET

Scope:

Meeting

Request

Response

Meeting PUT

Scope:

Validation

Meeting

Request

Response

Meeting POST

Scope:

Validation

Meeting

Request

Response

Meeting DELETE

Scope:

Meeting

Request

Response

Upcoming meetings for relation GET

Scope:

Parameters

Upcoming meetings for relation

Request

Response

Historical meetings for relation GET

Scope:

Parameters

Historical meetings for relation

Request

Response