API Documentation

This document is a work in progress and your opinion helps us to improve. Please let us know what we can do better. Thanks! support@procurios.com

Meeting registrations

Information on registrations for a meeting

Accept header for requests to Meeting registrations

application/vnd.procurios.meeting2+json; version=1

All registrations GET

URL: /l/meeting2_api/meetings/registration

Scope:

meeting2/read
Last used: Never

Get the list of all registrations for any meeting

Parameters

Parameter Type Description
page int

The api will provide 25 results per page
since datetime

Only get results created or updated since yyyy-mm-ddThh:mm:ss
relationIds int[]

Limit the results to the given relationIds, as a single integer, comma-separated list of integers, or array of integers
Live testing disabled

All registrations

Request

json

Response

jsonStatus: 200
{
    "registrations": [
        {
            "registrationId": 10,
            "meetingId": 11,
            "ticketId": null,
            "relationId": 99,
            "registrationDate": "2020-12-02T01:02:03"
        }
    ]
}

Schema GET

URL: /l/meeting2_api/meetings/42/registration/schema

Scope:

meeting2/register
Last used: Never

Get a JSON schema for a meeting registration

Live testing disabled

Schema

Request

json

Response

jsonStatus: 200
{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Registration for Demo meeting",
    "type": "object",
    "properties": {
        "relationId": {
            "title": "Relation ID",
            "description": "The unique ID for the person registering",
            "type": "integer"
        },
        "ticketId": {
            "title": "Ticket ID",
            "description": "The ticket the person wants to register with",
            "type": "integer"
        },
        "remark": {
            "title": "Remark",
            "type": "string"
        },
        "sendEmail": {
            "title": "Send email",
            "description": "Send registration email to registrant",
            "type": "bool"
        }
    },
    "required": [
        "relationId"
    ]
}

Registrations GET

URL: /l/meeting2_api/meetings/42/registration

Scope:

meeting2/read
Last used: Never

Get the list of registrations for the meeting

Live testing disabled

Registrations

Request

json

Response

jsonStatus: 200
{
    "registrations": [
        {
            "registrationId": 10,
            "ticketId": null,
            "relationId": 99
        }
    ]
}

Create a new registration POST

URL: /l/meeting2_api/meetings/42/registration

Scope:

meeting2/register
Last used: Never

Create a new registration

Parameters

Parameter Type Description
sendEmail bool

Send an e-mail to the registrant (as configured for the meeting)
Live testing disabled

Create a new registration

Request

json
{
    "relationId": 99,
    "sendEmail": true
}

Response

jsonStatus: 200
{
    "registrationId": 32
}

Registration GET

URL: /l/meeting2_api/meetings/42/registration/10

Scope:

meeting2/read
Last used: Never

Get a registration

Live testing disabled

Registration

Request

json

Response

jsonStatus: 200
{
    "relationId": 99,
    "ticketId": null,
    "remark": null
}

Registration DELETE

URL: /l/meeting2_api/meetings/42/registration/10

Scope:

meeting2/register
Last used: Never

Cancel a registration; does not remove the registration!

Parameters

Parameter Type Description
sendEmail bool

Send an e-mail to the registrant (as configured for the meeting)
Live testing disabled

Registration

Request

{
    "sendEmail": true
}

Response

Status: 200

Registration

Request

json

Response

jsonStatus: 400
{
    "errors": "Cancelling is not allowed for this meeting"
}