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 locations

Information on locations for meetings

Accept header for requests to Meeting locations

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

Locations GET

URL: /l/meeting2_api/location

Scope:

meeting2/location/read
Last used: Never

Get a list of locations

Parameters

Parameter Type Description
locationIds int[]

Limit the results to the given location ID's, as a single integer, comma-separated list of integers, or array of integers
meetingIds int[]

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

Locations

Request

json

Response

jsonStatus: 200
{
    "locations": [
        {
            "id": 42,
            "title": "Some location",
            "title_ml": [
                {
                    "locale": "nl_NL",
                    "string": "Zomaar een locatie"
                },
                {
                    "locale": "en_US",
                    "string": "Some location"
                }
            ],
            "description": "Some description",
            "description_ml": [
                {
                    "locale": "nl_NL",
                    "string": "Zomaar een beschrijving"
                },
                {
                    "locale": "en_US",
                    "string": "Some description"
                }
            ],
            "address": {
                "street": "Street",
                "number": "42",
                "postcode": "1111 ZZ",
                "town": "Town",
                "state": "",
                "country": "NL"
            },
            "capacity": 0,
            "images": [
                {
                    "url": "http:\\\/\\\/www.example.com\\\/image.jpg"
                },
                {
                    "url": "http:\\\/\\\/www.example.com\\\/photo.png"
                }
            ]
        }
    ]
}

Schema GET

URL: /l/meeting2_api/location/schema

Scope:

meeting2/location/read
Last used: Never

Get JSON schema for locations

Live testing disabled

Schema

Request

json

Response

jsonStatus: 200
{
    "$schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "Locations schema",
    "type": "object",
    "properties": {
        "locations": {
            "title": "List of locations",
            "type": "array",
            "items": {
                "$ref": "#\/$defs\/location"
            }
        }
    },
    "$defs": {
        "location": {
            "type": "object",
            "properties": {
                "id": {
                    "title": "Location ID",
                    "description": "The unique ID for the location",
                    "type": "integer"
                },
                "title": {
                    "title": "Title (or name) of the location",
                    "type": "string"
                },
                "title_ml": {
                    "title": "Title (multilingual)",
                    "$ref": "#\/$defs\/mlString"
                },
                "description": {
                    "title": "Short description",
                    "type": "string"
                },
                "description_ml": {
                    "title": "Short description (multilingual)",
                    "$ref": "#\/$defs\/mlString"
                },
                "address": {
                    "type": [
                        "object",
                        "null"
                    ],
                    "properties": {
                        "street": {
                            "title": "Street",
                            "type": "string"
                        },
                        "number": {
                            "title": "Number",
                            "type": "string"
                        },
                        "postcode": {
                            "title": "Postcode",
                            "type": "string"
                        },
                        "town": {
                            "title": "Town",
                            "type": "string"
                        },
                        "state": {
                            "title": "State",
                            "type": "string"
                        },
                        "country": {
                            "title": "Country code",
                            "type": "string",
                            "minimum": 2,
                            "maximum": 2,
                            "enum": [
                                "AT",
                                "AU",
                                "AW",
                                "BE",
                                "CA",
                                "CH",
                                "CY",
                                "CZ",
                                "DE",
                                "DK",
                                "DO",
                                "ES",
                                "FI",
                                "FR",
                                "GB",
                                "GR",
                                "HR",
                                "HU",
                                "IE",
                                "IL",
                                "IT",
                                "JP",
                                "KP",
                                "KR",
                                "LU",
                                "NL",
                                "NO",
                                "NP",
                                "NZ",
                                "PL",
                                "PT",
                                "SE",
                                "TR",
                                "TW",
                                "US",
                                "ZA"
                            ]
                        }
                    },
                    "required": [
                        "street",
                        "number",
                        "postcode",
                        "town",
                        "state",
                        "country"
                    ]
                },
                "capacity": {
                    "title": "Location capacity",
                    "type": "integer"
                },
                "images": {
                    "title": "Location images",
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "url": {
                                "type": "string",
                                "format": "uri"
                            }
                        }
                    }
                }
            },
            "required": [
                "id",
                "title",
                "description",
                "address",
                "capacity",
                "images"
            ]
        },
        "mlString": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "locale": {
                        "type": "string"
                    },
                    "string": {
                        "type": "string"
                    }
                },
                "required": [
                    "locale",
                    "string"
                ]
            }
        }
    }
}