{ "swagger": "2.0", "info": { "version": "1.0", "title": "APIEVENTS", "description": "APIEVENTS reference. Keep in mind that the provided apikey for the service is your secret, and must be kept as such, do not make it public or use it on client applications.\n\nSYMPOSIUM has a way to determine the language of the response based on the partner configuration settings and the user agent doing the request. If you experiment any issues with the language of the response in your integration, please, add a custom 'user agent' header to your request with a neutral value, e.g. 'apievents-integration/1.0 apievents integration'.\n\nQuota Rates:\n - 200 requests per minute\n - 1000 maximum requests per hour\n\nQuota values refresh every 1 minute for rates and 1 hour for maximum quota.", "contact": {} }, "host": "api.symposium.events", "basePath": "/apievents/v1", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/events": { "get": { "description": "List events of the instance of the platform.\n\nThe instance is identified by its apikey.\n\nUsing 'since' and 'until' return the events active between those dates, note that 'ongoing' when not sent defaults to 1. Using 'ongoing' as 0 removes the ongoing events and the range returns only the events starting and ending in the given range.", "summary": "events list", "tags": [ "event" ], "operationId": "EventsGet", "produces": [ "application/json" ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "type": "string", "description": "The instance apikey." }, { "name": "limit", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "The number of elements to retrieve from the server.", "minimum": 1, "default": "1" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "The page number, the first page is 1.", "minimum": 1, "default": "1" }, { "name": "search", "in": "query", "required": false, "type": "string", "description": "A search term to look for in titles, descriptions and places." }, { "name": "list_type", "in": "query", "required": false, "type": "string", "description": "Use 'past' on this field if you want to look for old events, otherwise you will get ongoing and future events." }, { "name": "event_type", "in": "query", "required": false, "description": "A string to search into event types. It can be also an event type id. One type at a time.", "type": "string" }, { "name": "event_type[]", "in": "query", "required": false, "description": "An array of event type ids to search, this will apply an OR filter. If the first element of the array is a string, it will be applied as the normal event type parameter, the rest of the array will be ignored. In any other case the array must be filled with numeric ids.", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "event_category[]", "in": "query", "required": false, "description": "A list of event category ids to filter the results, it can be also a list of strings to match event categories (complete words). This is an OR filter, if two or more filters are used, the event must be related to one of them.", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "tag[]", "in": "query", "required": false, "description": "A list of event tag ids to filter the results, it can be also a list of strings to match event tags (complete words). This is an OR filter, if two or more filters are used, the event must be related to one of them.", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "lang", "in": "query", "required": false, "type": "string", "description": "The language code for the response in lowercase. This language will be used to try to translate the response to that language if possible." }, { "name": "enable_demo_events", "in": "query", "required": false, "type": "integer", "description": "This parameter allows demo partners to search for their events [0|1], defaults to 0." }, { "name": "enable_private_events", "in": "query", "required": false, "type": "integer", "description": "This parameter allows the partner to add private events to the result list. Default is 0, which does not include them. The results will include the special urls required to access each private event. Allowed values [0|1]." }, { "name": "agenda", "in": "query", "required": false, "type": "integer", "description": "If not set, both agenda and non-agenda events will be returned. Setting this flag to 0 will remove agenda events from the result and setting it to 1 will return agenda events only." }, { "name": "show_in_agenda", "in": "query", "required": false, "type": "integer", "description": "If not set, this property is ignored and all events are returned. Setting this flag to 1 will return events flagged as 'show in agenda'. Setting this flag to 0 will return events flagged as 'not show in agenda'." }, { "name": "since", "in": "query", "required": false, "type": "integer", "description": "Unix timestamp UTC value to search events 'since' this date. In conjuntion with 'list_type', this value will prevail. This parameter will be compared to the opening date of each event. In conjuntion with 'ongoing', the order of the returned events changes, also the meaning, those ongoing, and future, after the given 'since' date are included. If 'ongoing' is not set, it defaults to 1. If you dont need ongoing events, set it to 0." }, { "name": "until", "in": "query", "required": false, "type": "integer", "description": "Unix timestamp UTC value to search events 'until' this date. In conjuntion with 'list_type', this value will prevail. This parameter will be compared to the closing date of the event. This parameter should be used in conjuntion with 'since' to create ranges. Note that 'ongoing' defaults to 1, this means that the result includes ongoing events. Set 'ongoing' to 0 to limit the results to those events starting after 'since' and ending before 'until'." }, { "name": "ongoing", "in": "query", "required": false, "type": "integer", "description": "This flag allows the search engine to return events that are currently in progress, [0|1], defaults to 1." }, { "name": "organizer", "in": "query", "required": false, "type": "string", "description": "String to match the event organizer." }, { "name": "location", "in": "query", "required": false, "type": "string", "description": "String to match the event location (address, country, city)." }, { "name": "content_lang", "in": "query", "required": false, "type": "string", "description": "If this parameter is sent, the search will be done over events translated to this language code." }, { "name": "frontpage_id", "in": "query", "required": false, "type": "number", "description": "If this parameter is sent, the search will be done over events assigned to the given frontpage id." }, { "name": "directory_id", "in": "query", "required": false, "type": "number", "description": "If this parameter is sent, the search will be done over events assigned to the given locations directory id." }, { "name": "place_id", "in": "query", "required": false, "type": "number", "description": "If this parameter is sent, the search will be done over events assigned to the given location id." }, { "name": "attending_modes[]", "in": "query", "required": false, "description": "An array of attending modes to search, this will apply an OR filter. Allowed values are ['close', 'external', 'free', 'payment'], meaning, no attending, external registration page, free antendance or paid attendance.", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A list of events.", "headers": {}, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the response. 1 Means ok." }, "total": { "type": "integer", "description": "Total number of events found." }, "events": { "type": "array", "items": { "$ref": "#/definitions/EventBasic" } }, "event_types_found": { "description": "Future and ongoing event types.", "type": "array", "items": { "$ref": "#/definitions/EventType" } }, "event_categories_found": { "description": "Future and ongoing event categories.", "type": "array", "items": { "$ref": "#/definitions/EventCategory" } } } } }, "400": { "description": "Invalid parámeter or validation error", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Apikey is not linked to any instance", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "The api key is invalid or missing", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/events/{event_id}": { "get": { "description": "Returns the given event details based on the data parameter.", "summary": "event details", "tags": [ "event" ], "operationId": "EventsByEventIdGet", "produces": [ "application/json" ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "type": "string", "description": "The instance apikey." }, { "name": "data", "in": "query", "required": false, "type": "string", "description": "Comma separated string with the values we want to retrieve from the event. Options: sponsors, programme, speakers, dates, attendees, notifications, news, files, videos, sections, tickets, products, expense_centers" }, { "name": "event_id", "in": "path", "required": true, "type": "string", "description": "The event id to be retrived." }, { "name": "enable_demo_events", "in": "query", "required": false, "type": "integer", "description": "This parameter allows demo partners to get the detail of their events, [0|1], defaults to 0." }, { "name": "enable_private_events", "in": "query", "required": false, "type": "integer", "description": "This parameter allows the partner to get the detail of private events. Default is 0. Allowed values [0|1]." } ], "responses": { "200": { "description": "Event object with extra information", "headers": {}, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the response. 1 Means ok." }, "total": { "type": "integer", "description": "Total number of events found." }, "events": { "type": "array", "items": { "$ref": "#/definitions/EventDetail" } }, "event_types_found": { "description": "Future and ongoing event types.", "type": "array", "items": { "$ref": "#/definitions/EventType" } }, "event_categories_found": { "description": "Future and ongoing event categories.", "type": "array", "items": { "$ref": "#/definitions/EventCategory" } } } } }, "401": { "description": "Apikey is not linked to any instance", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "The api key is invalid or missing", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/filters": { "get": { "description": "This method return the available filters for event search.", "summary": "event filter", "tags": [ "event" ], "operationId": "filtersGet", "produces": [ "application/json" ], "consumes": [ "application/x-www-form-urlencoded" ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "type": "string", "description": "The instance apikey." }, { "name": "lang", "in": "query", "required": false, "type": "string", "description": "The language code to try to translate the response to." }, { "name": "tree", "in": "query", "required": false, "type": "number", "description": "Send this paramater to retrieve the categories in a tree form, every parent category (first level) will have a 'children' property as an array of category objects without 'children' property." } ], "responses": { "200": { "description": "The list filters.", "headers": {}, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the response." }, "event_types_found": { "type": "array", "description": "List of found event types.", "items": { "$ref": "#/definitions/EventType" } }, "event_categories_found": { "type": "array", "description": "List of found event categories. The default category groups have a parent and a subset of childs, most of them will have a subcategory with the same name as the parent category. On this cases, in the result array, the parent category is set before the child. Parent categories could be used to find events with that parent category, including events set with the subcategory with the same name as the parent. In order to find only the events with one of those subcategories, you need to use the child category identifier.", "items": { "$ref": "#/definitions/EventCategory" } }, "frontpages": { "type": "array", "description": "List of frontpages of the partner.", "items": { "$ref": "#/definitions/Frontpage" } } } } }, "400": { "description": "Invalid parámeter or validation error", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Apikey is not linked to any instance", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "The api key is invalid or missing", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/locations": { "get": { "description": "This method return the available locations for the partner.", "summary": "event locations", "tags": [ "event" ], "operationId": "locationsGet", "produces": [ "application/json" ], "consumes": [ "application/x-www-form-urlencoded" ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "type": "string", "description": "The instance apikey." }, { "name": "lang", "in": "query", "required": false, "type": "string", "description": "The language code to try to translate the response to." }, { "name": "tree", "in": "query", "required": false, "type": "number", "description": "Send this paramater to retrieve the locations in a tree form, if the directory has places, it will populate a 'places' attribute as a list of locations." } ], "responses": { "200": { "description": "The list filters.", "headers": {}, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the response." }, "directories": { "type": "array", "description": "List of directories of the partner.", "items": { "$ref": "#/definitions/LocationsDirectory" } }, "locations": { "type": "array", "description": "List of locations of the partner.", "items": { "$ref": "#/definitions/Location" } } } } }, "400": { "description": "Invalid parámeter or validation error", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Apikey is not linked to any instance", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "The api key is invalid or missing", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/news": { "get": { "description": "List news or press releases of the instance of the platform.\n\nThe instance is identified by its apikey.\n\nUsing 'since' and 'until' return the items active between those dates.", "summary": "news or press releases list", "tags": [ "news" ], "operationId": "NewsGet", "produces": [ "application/json" ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "type": "string", "description": "The instance apikey." }, { "name": "limit", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "The number of elements to retrieve from the server.", "minimum": 1, "default": "1" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "The page number, the first page is 1.", "minimum": 1, "default": "1" }, { "name": "search", "in": "query", "required": false, "type": "string", "description": "A search term to look for in titles and descriptions." }, { "name": "category[]", "in": "query", "required": false, "description": "A list of category ids to filter the results, it can be also a list of strings to match categories (complete words). This is an OR filter, if two or more filters are used, the item must be related to one of them.", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "tag[]", "in": "query", "required": false, "description": "A list of tag ids to filter the results, it can be also a list of strings to match tags (complete words). This is an OR filter, if two or more filters are used, the item must be related to one of them.", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "lang", "in": "query", "required": false, "type": "string", "description": "The language code for the response in lowercase. This language will be used to try to translate the response to that language if possible." }, { "name": "enable_demo", "in": "query", "required": false, "type": "integer", "description": "This parameter allows demo partners to search for their news and press releases [0|1], defaults to 0." }, { "name": "since", "in": "query", "required": false, "type": "integer", "description": "Unix timestamp UTC value to search news 'since' this date." }, { "name": "until", "in": "query", "required": false, "type": "integer", "description": "Unix timestamp UTC value to search news 'until' this date." }, { "name": "organizer", "in": "query", "required": false, "type": "string", "description": "String to match the editor." }, { "name": "content_lang", "in": "query", "required": false, "type": "string", "description": "If this parameter is sent, the search will be done over news translated to this language code." }, { "name": "format", "in": "query", "required": false, "type": "string", "description": "String to match the item format. It could be one of [news|press_release]" } ], "responses": { "200": { "description": "A list of news or press releases.", "headers": {}, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the response. 1 Means ok." }, "total": { "type": "integer", "description": "Total number of items found." }, "events": { "type": "array", "items": { "$ref": "#/definitions/NewsBasic" } }, "categories_found": { "description": "News categories.", "type": "array", "items": { "$ref": "#/definitions/NewsCategory" } } } } }, "400": { "description": "Invalid parámeter or validation error", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Apikey is not linked to any instance", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "The api key is invalid or missing", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/news/{item_id}": { "get": { "description": "Returns the given item details based on the data parameter.", "summary": "event details", "tags": [ "news" ], "operationId": "NewsByItemIdGet", "produces": [ "application/json" ], "parameters": [ { "name": "client_id", "in": "query", "required": true, "type": "string", "description": "The instance apikey." }, { "name": "item_id", "in": "path", "required": true, "type": "string", "description": "The item id to be retrived." }, { "name": "enable_demo", "in": "query", "required": false, "type": "integer", "description": "This parameter allows demo partners to get the detail of their events, [0|1], defaults to 0." } ], "responses": { "200": { "description": "Event object with extra information", "headers": {}, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "The status of the response. 1 Means ok." }, "total": { "type": "integer", "description": "Total number of events found." }, "events": { "type": "array", "items": { "$ref": "#/definitions/NewsBasic" } }, "categories_found": { "description": "Categories found.", "type": "array", "items": { "$ref": "#/definitions/NewsCategory" } } } } }, "401": { "description": "Apikey is not linked to any instance", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "The api key is invalid or missing", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } } }, "tags": [], "definitions": { "EventBasic": { "type": "object", "properties": { "id": { "type": "integer", "description": "The event identifier." }, "title": { "type": "string", "description": "The event title." }, "description": { "type": "string", "description": "The event description. This information is utf8 encoded HTML content." }, "opening_date": { "type": "integer", "description": "The event opening date, as a unix timestamp in UTC timezone." }, "closing_date": { "type": "integer", "description": "The event closing date, as a unix timestamp in UTC timezone." }, "place": { "type": "string", "description": "The event location." }, "lat": { "type": "number", "description": "The event location latitude." }, "lng": { "type": "number", "description": "The event location longitude." }, "summary": { "type": "string", "description": "The event summary. Not translatable." }, "image": { "type": "string", "default": "null", "description": "The image of the event hosted at SYMPOSIUM." }, "crue_image": { "type": "string", "default": "null", "description": "The image of the event hosted at SYMPOSIUM for crue apps." }, "place_name": { "type": "string", "default": "null", "description": "The name of place." }, "place_detail": { "type": "string", "default": "null", "description": "The detail of place." }, "timezone": { "type": "string", "description": "The event timezone." }, "url": { "type": "string", "description": "The URL to the event page." }, "registration_url": { "type": "string", "description": "The URL to the event registration page. If any kind of registration period is currently open." }, "owner": { "type": "integer", "description": "The user identifier of event owner." }, "organizer_name": { "type": "string", "default": "null", "description": "The name of the organizer if any." }, "type_id": { "type": "integer", "description": "The type identifier of the event." }, "type_name": { "type": "string", "description": "Event type name." }, "type_route": { "type": "string", "description": "Event type description route to be used for searching this kind of events." }, "tags": { "type": "array", "description": "", "items": { "$ref": "#/definitions/EventTag" } }, "categories": { "type": "array", "description": "The categories of the event. The default category groups have a parent and a subset of childs, most of them will have a subcategory with the same name as the parent category. On this cases, in the result array, the parent category is set before the child. Parent categories could be used to find events with that parent category, including events set with the subcategory with the same name as the parent. In order to find only the events with one of those subcategories, you need to use the child category identifier.", "items": { "$ref": "#/definitions/EventDetailCategory" } }, "city_name": { "type": "string", "description": "City name of the event location." }, "country_name": { "type": "string", "description": "Country name of the event location." }, "is_private": { "type": "boolean", "default": "false", "description": "Flag to indicate that this event is private." }, "created_at": { "type": "string", "description": "Date of creation in Europe/Madrid timezone", "pattern": "[\\d]{4}-[\\d]{2}-[\\d]{2} [\\d]{2}:[\\d]{2}:[\\d]{2}" }, "created_at_timestamp": { "type": "number", "description": "Date of creation as Unix timestamp in UTC" }, "frontpages": { "type": "array", "items": { "$ref": "#/definitions/Frontpage" }, "description": "The list of frontpages assigned to the event. If there are no frontpages assigned, this attribute won't be part of the object." }, "attending_mode": { "type": "string", "description": "The type of registration mode if any. One of [close, link, free, payment]. Close means no registration, link means external registration, free and payment are normal registration modes." } } }, "EventDetail": { "type": "object", "properties": { "id": { "type": "integer", "description": "The event identifier." }, "title": { "type": "string", "description": "The event title." }, "description": { "type": "string", "description": "The event description. This information is utf8 encoded HTML content." }, "opening_date": { "type": "integer", "description": "The event opening date, as a unix timestamp in UTC timezone." }, "closing_date": { "type": "integer", "description": "The event closing date, as a unix timestamp in UTC timezone." }, "place": { "type": "string", "description": "The event location." }, "lat": { "type": "number", "description": "The event location latitude." }, "lng": { "type": "number", "description": "The event location longitude." }, "summary": { "type": "string", "description": "The event summary. Not translatable." }, "image": { "type": "string", "default": "null", "description": "The image of the event hosted at SYMPOSIUM." }, "crue_image": { "type": "string", "default": "null", "description": "The image of the event hosted at SYMPOSIUM for crue apps." }, "place_name": { "type": "string", "default": "null", "description": "The name of place." }, "place_detail": { "type": "string", "default": "null", "description": "The detail of place." }, "timezone": { "type": "string", "description": "The event timezone." }, "url": { "type": "string", "description": "The URL to the event page." }, "registration_url": { "type": "string", "description": "The URL to the event registration page. If any kind of registration period is currently open." }, "sponsors": { "type": "array", "description": "List of the sponsors of the event.", "items": { "$ref": "#/definitions/Sponsor" } }, "programme": { "type": "array", "description": "List of programme items.", "items": { "$ref": "#/definitions/Programme" } }, "speakers": { "type": "array", "description": "List of the event speakers.", "items": { "$ref": "#/definitions/Speaker" } }, "notifications": { "type": "array", "description": "List of the event notifications. Including the user personal notifications if the authtoken was provided.", "items": { "$ref": "#/definitions/Notification" } }, "dates": { "type": "array", "description": "List of dates of interest of the event.", "items": { "$ref": "#/definitions/Date" } }, "news": { "type": "array", "description": "List of event news.", "items": { "$ref": "#/definitions/EventNews" } }, "videos": { "type": "array", "description": "List of event videos.", "items": { "$ref": "#/definitions/EventVideo" } }, "files": { "type": "array", "description": "List of event files.", "items": { "$ref": "#/definitions/File" } }, "sections": { "type": "array", "description": "List of event sections.", "items": { "$ref": "#/definitions/EventSection" } }, "owner": { "type": "integer", "description": "The user identifier of event owner." }, "organizer_name": { "type": "string", "default": "null", "description": "The name of the organizer if any." }, "type_id": { "type": "integer", "description": "The type identifier of the event." }, "type_name": { "type": "string", "description": "Event type name." }, "type_route": { "type": "string", "description": "Event type description route to be used for searching this kind of events." }, "tags": { "type": "array", "description": "", "items": { "$ref": "#/definitions/EventTag" } }, "categories": { "type": "array", "description": "The categories of the event. The default category groups have a parent and a subset of childs, most of them will have a subcategory with the same name as the parent category. On this cases, in the result array, the parent category is set before the child. Parent categories could be used to find events with that parent category, including events set with the subcategory with the same name as the parent. In order to find only the events with one of those subcategories, you need to use the child category identifier.", "items": { "$ref": "#/definitions/EventDetailCategory" } }, "city_name": { "type": "string", "description": "City name of the event location." }, "country_name": { "type": "string", "description": "Country name of the event location." }, "campus_name": { "type": "string", "default": "null", "description": "Campus name." }, "faculty_name": { "type": "string", "default": "null", "description": "Faculty name." }, "created_at": { "type": "string", "description": "Date of creation in Europe/Madrid timezone", "pattern": "[\\d]{4}-[\\d]{2}-[\\d]{2} [\\d]{2}:[\\d]{2}:[\\d]{2}" }, "created_at_timestamp": { "type": "number", "description": "Date of creation as Unix timestamp in UTC" }, "frontpages": { "type": "array", "items": { "$ref": "#/definitions/Frontpage" }, "description": "The list of frontpages assigned to the event." }, "tickets": { "type": "array", "items": { "$ref": "#/definitions/Ticket" }, "description": "The list of tickets assigned to the event." }, "products": { "type": "array", "items": { "$ref": "#/definitions/EventProduct" }, "description": "The list of products of the event." }, "expense_centers": { "type": "array", "items": { "$ref": "#/definitions/ExpenseCenter" }, "description": "The list of expense centers of the event." } } }, "Error": { "type": "object", "properties": { "error": { "type": "string" } } }, "Attendee": { "type": "object", "properties": { "attending_id": { "type": "integer" }, "name": { "type": "string" } } }, "Notification": { "type": "object", "properties": { "id": { "type": "integer", "description": "The notification identifier." }, "event_id": { "type": "integer", "description": "The event identifier." }, "title": { "type": "string", "description": "The notification title." }, "description": { "type": "string", "description": "The notification contents." }, "date": { "type": "integer", "description": "The notification date as unix timestamp in UTC timezone." } } }, "Date": { "type": "object", "description": "Relevant date object. Date_end and description can be null.", "properties": { "id": { "type": "integer", "description": "The relevant date identifier." }, "date_ini": { "type": "integer", "description": "The relevant date start." }, "date_end": { "type": "integer", "default": "null", "description": "The relevant date end. Can be null." }, "tile": { "type": "string", "description": "The relevant date title." }, "description": { "type": "string", "default": "null", "description": "The relevant date description. Can be null." } } }, "Programme": { "type": "object", "properties": { "title": { "type": "string", "description": "The programme title." }, "description": { "type": "string", "description": "The programme description." }, "opening_date": { "type": "integer", "description": "The programme item opening date as unix timestamp in UTC timezone." }, "closing_date": { "type": "integer", "description": "The programme item closing date as unix timestamp in UTC timezone." } } }, "Speaker": { "type": "object", "properties": { "id": { "type": "integer", "description": "The speaker identifier." }, "name": { "type": "string", "description": "The name of the speaker." }, "picture": { "type": "string", "description": "The picture of the speaker if any." }, "curriculum": { "type": "string", "description": "The curriculum of the speaker." }, "current_location": { "type": "string", "description": "The speaker current location. Company, University or Research group." } } }, "Sponsor": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the sponsor." }, "picture": { "type": "string", "description": "The picture of the sponsor, if any." }, "link": { "type": "string", "description": "Link to the sponsor if any." } } }, "EventTag": { "type": "object", "description": "Tag for the event.", "properties": { "code": { "type": "integer", "description": "The tag identifier inside the partner code." }, "name": { "type": "string", "description": "The tag name." }, "partner": { "type": "integer", "description": "The partner identifier." } } }, "EventDetailCategory": { "type": "object", "description": "Event detail category.", "properties": { "code": { "type": "integer", "description": "The category identifier inside the partner code." }, "name": { "type": "string", "description": "The category name." }, "partner": { "type": "integer", "description": "The partner identifier." } } }, "EventType": { "type": "object", "description": "Event type item.", "properties": { "id": { "type": "integer", "description": "The type identifier." }, "name": { "type": "string", "description": "The type name." } } }, "EventCategory": { "type": "object", "description": "Event category item.", "properties": { "id": { "type": "string", "description": "The event category identifier." }, "name": { "type": "integer", "description": "The event category name." }, "partner_id": { "type": "integer", "description": "The event category partner identifier." } } }, "EventNews": { "type": "object", "description": "Event news item.", "properties": { "id": { "type": "integer", "description": "Event news item identifier." }, "event_id": { "type": "integer", "description": "The event identifier." }, "title": { "type": "string", "description": "The event news item title, utf8 encoded." }, "description": { "type": "string", "description": "The event news item contents, utf8 encoded." }, "date": { "type": "integer", "description": "The event news item publication date as Unix timestamp in UTC." } } }, "EventVideo": { "type": "object", "description": "Event video, contains a Youtube URL.", "properties": { "id": { "type": "integer", "description": "The event video identifier." }, "event_id": { "type": "integer", "description": "The event identifier." }, "title": { "type": "string", "description": "The event video title, utf8 encoded." }, "url": { "type": "string", "description": "The event video URL." } } }, "EventSection": { "type": "object", "description": "Event section.", "properties": { "id": { "type": "integer", "description": "The event section identifier." }, "event_id": { "type": "integer", "description": "The event identifier." }, "title": { "type": "string", "description": "The event section title. Utf8 encoded." }, "contents": { "type": "string", "description": "The event section contents. Utf8 encoded HTML content of the section." } } }, "File": { "type": "object", "description": "Event file.", "properties": { "id": { "type": "integer", "description": "The event file identifier." }, "name": { "type": "string", "description": "Name of the file." }, "extension": { "type": "string", "description": "Extension of the file." }, "type": { "type": "string", "description": "The file associated entity, in this case 'event'." }, "type_id": { "type": "integer", "description": "The associated entity identifier." }, "context": { "type": "string", "description": "The file context into the event. In this case the possible values are [notices|documents]." }, "url": { "type": "string", "description": "The URL of the file hosted at SYMPOSIUM." }, "description": { "type": "string", "description": "The description of the file." }, "upload_date": { "type": "integer", "description": "Upload date for the file, represented as Unix timestamp in UTC." } } }, "Frontpage": { "type": "object", "properties": { "id": { "type": "number", "description": "The frontpage identifier, use this id for searches." }, "partner_id": { "type": "number", "description": "The partner identifier of the frontpage." }, "directory_id": { "type": "number", "description": "The directory associated to this frontpage.", "default": "null" }, "place_id": { "type": "number", "description": "The directory place associated to this frontpage.", "default": "null" }, "page_name": { "type": "string", "description": "The frontpage name." }, "url_key": { "type": "string", "description": "The frontpage key to access by url." }, "show_in_menu": { "type": "boolean", "description": "If the frontpage is visible on menus or not." } } }, "Location": { "type": "object", "required": [ "id", "partner_id", "name" ], "properties": { "id": { "type": "number", "description": "The location id, can be use as place_id filter on events search." }, "partner_id": { "type": "number", "description": "The partner id." }, "name": { "type": "string", "description": "The location name." }, "description": { "type": "string", "description": "An optional description of the location.", "default": "null" }, "lat": { "type": "number", "description": "The latitude of the location.", "default": "null" }, "lon": { "type": "number", "description": "The longitude of the location.", "default": "null" } } }, "LocationsDirectory": { "type": "object", "required": [ "id", "partner_id", "name" ], "properties": { "id": { "type": "number", "description": "The locations directory id.", "default": "null" }, "partner_id": { "type": "number", "description": "The partner id.", "default": "null" }, "name": { "type": "string", "description": "The name of the locations directory." }, "root": { "type": "number", "description": "This value could be [0, 1], if 1, it is the main directory.", "default": "0" }, "places": { "type": "array", "description": "Optional list of places related to this directory. Only populated if the 'tree' parameter is set to 1.", "items": { "$ref": "#/definitions/Location" } } } }, "Ticket": { "type": "object", "properties": { "id": { "type": "number", "description": "The ticket identifier.", "default": "" }, "event_id": { "type": "number", "description": "The related event identifier.", "default": "" }, "name": { "type": "string", "description": "The name of the ticket, this is shown to the users.", "default": "" }, "date_opening": { "type": "string", "description": "Mysql date string in the event timezone.", "pattern": "[\\d]{4}-[\\d]{2}-[\\d]{2} [\\d]{2}:[\\d]{2}:[\\d]{2}", "default": "" }, "date_opening_timestamp": { "type": "number", "description": "UTC timestamp relative to the opening date." }, "date_closing": { "type": "string", "description": "Mysql date string in the event timezone.", "default": "" }, "date_closing_timestamp": { "type": "number", "description": "UTC timestamp relative to the closing date." }, "description": { "type": "string", "description": "The description of the ticket if any.", "default": "" }, "price": { "type": "number", "description": "The price of the ticket without currency.", "default": "" }, "tax": { "type": "number", "description": "The value of the tax for the ticket without currency.", "default": "" }, "currency_code": { "type": "string", "description": "The currency code.", "default": "" }, "available": { "type": "boolean", "description": "Checks if the ticket is available for the users or not.", "default": "" }, "visible": { "type": "boolean", "description": "Checks if the ticket is visible to the users or not.", "default": "" }, "extra_data": { "type": "string", "description": "Extra information in json or php serialized format", "default": "" }, "is_donation": { "type": "boolean", "description": "Checks if the ticket should be used as a donation", "default": "" } } }, "NewsBasic": { "type": "object", "properties": { "id": { "type": "integer", "description": "The item identifier." }, "title": { "type": "string", "description": "The item title." }, "description": { "type": "string", "description": "The item description. This information is utf8 encoded HTML content." }, "date": { "type": "integer", "description": "The item date, as a unix timestamp in UTC timezone." }, "summary": { "type": "string", "description": "The item summary. Not translatable." }, "image": { "type": "string", "default": "null", "description": "The image of the item hosted at SYMPOSIUM." }, "timezone": { "type": "string", "description": "The item timezone." }, "url": { "type": "string", "description": "The URL to the item page." }, "owner": { "type": "integer", "description": "The user identifier of item owner." }, "organizer_name": { "type": "string", "default": "null", "description": "The name of the organizer/editor if any." }, "type_id": { "type": "integer", "description": "The type identifier of the Item." }, "type_name": { "type": "string", "description": "Item type name." }, "type_route": { "type": "string", "description": "Item type description route to be used for searching this kind of items." }, "tags": { "type": "array", "description": "", "items": { "$ref": "#/definitions/NewsTag" } }, "categories": { "type": "array", "description": "The categories of the item. The default category groups have a parent and a subset of childs, most of them will have a subcategory with the same name as the parent category. On this cases, in the result array, the parent category is set before the child. Parent categories could be used to find news with that parent category, including news set with the subcategory with the same name as the parent. In order to find only the items with one of those subcategories, you need to use the child category identifier.", "items": { "$ref": "#/definitions/NewsDetailCategory" } }, "created_at": { "type": "string", "description": "Date of creation in Europe/Madrid timezone", "pattern": "[\\d]{4}-[\\d]{2}-[\\d]{2} [\\d]{2}:[\\d]{2}:[\\d]{2}" }, "created_at_timestamp": { "type": "number", "description": "Date of creation as Unix timestamp in UTC" } } }, "NewsCategory": { "type": "object", "description": "News category item.", "properties": { "id": { "type": "string", "description": "The news category identifier." }, "name": { "type": "integer", "description": "The news category name." }, "partner_id": { "type": "integer", "description": "The news category partner identifier." } } }, "NewsTag": { "type": "object", "description": "Tag for the news item.", "properties": { "code": { "type": "integer", "description": "The tag identifier inside the partner code." }, "name": { "type": "string", "description": "The tag name." }, "partner": { "type": "integer", "description": "The partner identifier." } } }, "NewsDetailCategory": { "type": "object", "description": "News detail category.", "properties": { "code": { "type": "integer", "description": "The category identifier inside the partner code." }, "name": { "type": "string", "description": "The category name." }, "partner": { "type": "integer", "description": "The partner identifier." } } }, "EventProduct": { "type": "object", "description": "An Event product", "properties": { "id": { "type": "integer", "description": "The event product identifier." }, "product_name": { "type": "string", "description": "The product name." }, "description": { "type": "string", "description": "The product description. HTML." }, "price": { "type": "number", "description": "The price of the product." }, "tax": { "type": "number", "description": "The product tax value." }, "currency": { "type": "string", "description": "The product currency." }, "stock": { "type": "string", "description": "The product stock as a number or the string 'unlimited'." }, "items_per_ticket": { "type": "number", "default": "null", "description": "Number of products a user can buy." } } }, "ExpenseCenter": { "type": "object", "description": "An expense center", "properties": { "id": { "type": "number", "description": "The expense center identifier." }, "name": { "type": "string", "description": "The expense center name." }, "code": { "type": "string", "description": "The expense center code." } } } }, "securityDefinitions": {} }