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 attendees

Information on attendees for a meeting

Accept header for requests to Meeting attendees

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

All attendees for meeting GET

URL: /l/meeting2_api/meetings/42/attendees

Scope:

meeting2/read
Last used: Never

Get the list of all attendees for the given meeting

Live testing disabled

All attendees for meeting

Request

json

Response

jsonStatus: 200
{
    "attendees": [
        {
            "relation_id": 123,
            "relation_name": "Firstname Lastname",
            "relation_first_name": "Firstname van Lastname",
            "relation_insertion": "van",
            "relation_last_name": "Firstname van Lastname",
            "relation_initials": "F",
            "presence": 1,
            "activitiesSignedUp": [
                12,
                13,
                127
            ],
            "organization_name": "Organization",
            "registration_status": 1
        }
    ]
}

Attendee schema for meeting GET

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

Scope:

meeting2/read
Last used: Never

Get a JSON schema for an attendee, given the specified meeting

Live testing disabled

Attendee schema for meeting

Request

json

Response

jsonStatus: 200
{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Attendee",
    "type": "object",
    "properties": {
        "relation_id": {
            "title": "Relation ID",
            "description": "The unique ID for the relation that is attending",
            "type": "integer"
        },
        "relation_name": {
            "title": "Relation name",
            "description": "The formatted full name of the relation that is attending",
            "type": "string"
        },
        "relation_first_name": {
            "title": "Relation first name",
            "type": [
                "string",
                "null"
            ]
        },
        "relation_insertion": {
            "title": "Relation insertion",
            "type": [
                "string",
                "null"
            ]
        },
        "relation_last_name": {
            "title": "Relation last name",
            "type": "string"
        },
        "relation_initials": {
            "title": "Relation initials",
            "type": [
                "string",
                "null"
            ]
        },
        "presence": {
            "title": "Presence status for this attendee",
            "description": "0 = absent, 1 = present, 2 = unknown",
            "type": "integer",
            "enum": [
                0,
                1,
                2
            ]
        },
        "activitiesSignedUp": {
            "title": "Activities",
            "description": "An activity id for each activity the attendee is going to attend.",
            "type": "array",
            "items": {
                "type": "number"
            }
        },
        "organization_name": {
            "title": "Name of organization if any",
            "type": [
                "string",
                "null"
            ]
        },
        "registration_status": {
            "title": "Registration status for this attendee",
            "type": "int",
            "enum": [
                0,
                1,
                2,
                3,
                4
            ],
            "enumNames": [
                "No reaction",
                "Registered",
                "Opted out",
                "Reserve list",
                "Cancelled"
            ]
        }
    },
    "required": [
        "relation_id",
        "relation_name",
        "presence",
        "activitiesSignedUp"
    ]
}

Update presence PUT

URL: /l/meeting2_api/meetings/42/attendees/1978/presence

Scope:

meeting2/presence/write
Last used: Never

Update the presence of an attendee (relation ID 1978) of a meeting (meeting ID 42); Scope needed: meeting2/presence/write

Validation

{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Attendee",
    "type": "object",
    "properties": {
        "relation_id": {
            "title": "Relation ID",
            "description": "The unique ID for the relation that is attending",
            "type": "integer"
        },
        "relation_name": {
            "title": "Relation name",
            "description": "The formatted full name of the relation that is attending",
            "type": "string"
        },
        "relation_first_name": {
            "title": "Relation first name",
            "type": [
                "string",
                "null"
            ]
        },
        "relation_insertion": {
            "title": "Relation insertion",
            "type": [
                "string",
                "null"
            ]
        },
        "relation_last_name": {
            "title": "Relation last name",
            "type": "string"
        },
        "relation_initials": {
            "title": "Relation initials",
            "type": [
                "string",
                "null"
            ]
        },
        "presence": {
            "title": "Presence status for this attendee",
            "description": "0 = absent, 1 = present, 2 = unknown",
            "type": "integer",
            "enum": [
                0,
                1,
                2
            ]
        },
        "activitiesSignedUp": {
            "title": "Activities",
            "description": "An activity id for each activity the attendee is going to attend.",
            "type": "array",
            "items": {
                "type": "number"
            }
        },
        "organization_name": {
            "title": "Name of organization if any",
            "type": [
                "string",
                "null"
            ]
        },
        "registration_status": {
            "title": "Registration status for this attendee",
            "type": "int",
            "enum": [
                0,
                1,
                2,
                3,
                4
            ],
            "enumNames": [
                "No reaction",
                "Registered",
                "Opted out",
                "Reserve list",
                "Cancelled"
            ]
        }
    },
    "required": [
        "relation_id",
        "relation_name",
        "presence",
        "activitiesSignedUp"
    ]
}
Live testing disabled

Update presence

Request

{
    "presence": 1
}

Response

Status: 204

Update presence

Request

json

Response

jsonStatus: 404
{
    "errors": "Meeting could not be found."
}

Update presence

Request

json

Response

jsonStatus: 404
{
    "errors": "Attendee could not be found."
}

Schema for updating presence GET

URL: /l/meeting2_api/meetings/attendees/schema/presence/put

Scope:

meeting2/presence/write
Last used: Never

Get a JSON schema for updating the presence of an attendee for the the specified meeting; Scope needed: meeting2/presence/write

Live testing disabled

Schema for updating presence

Request

json

Response

jsonStatus: 200
{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Attendee presence schema (PUT)",
    "type": "object",
    "properties": {
        "presence": {
            "title": "Presence",
            "type": "integer",
            "enum": [
                1,
                0
            ],
            "enumNames": {
                "1": "Yes, present",
                "0": "No, absent"
            }
        }
    },
    "required": [
        "presence"
    ]
}