Page tree
Skip to end of metadata
Go to start of metadata

REST APIs

The Linchpin Events app has a RESTful API to retrieve useful information for any kind of external usage.

All endpoints return their data as JSON strings (a standardized lightweight data-interchange format).

Disclaimer

Please be aware, that all APIs might be subject to change without prior announcement.

There is no guarantee and no support.

Usage at your own risk.

{ "swagger": "2.0", "info": { "version": "2.2.12", "title": "Linchpin Events" }, "host": "", "basePath": "/rest/easyevents/2.0/", "paths": { "/categories": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/EventCategoryDto" } } } } }, "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "label", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { } } } } }, "/categories/{id}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/EventCategoryDto" } }, "400": { "description": "Bad Request", "headers": { } } } }, "put": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "id", "in": "path", "required": true }, { "type": "string", "name": "label", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { } } } }, "delete": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { } } } } }, "/events/create": { "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EventDto" } } ], "responses": { "200": { "description": "OK", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "500": { "description": "Internal Server Error", "headers": { } } } } }, "/events/delete/{uuid}": { "delete": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "500": { "description": "Internal Server Error", "headers": { } } } } }, "/events/i18n": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "500": { "description": "Internal Server Error", "headers": { } } } } }, "/events/search": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/EventDto" } }, "403": { "description": "Forbidden", "headers": { } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SearchDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/EventDto" } } }, "402": { "description": "Payment Required", "headers": { } } } } }, "/events/{uuid}/invitations": { "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true }, { "type": "string", "name": "invitee", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/events/{uuid}/participants": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ParticipantDto" } } } } }, "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "400": { "description": "Bad Request", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "403": { "description": "Forbidden", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/events/{uuid}/participants/{participantId}": { "delete": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "participantId", "in": "path", "required": true }, { "type": "string", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "403": { "description": "Forbidden", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/events/{uuid}/selfsign": { "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "400": { "description": "Bad Request", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "403": { "description": "Forbidden", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } }, "delete": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "402": { "description": "Payment Required", "headers": { } }, "403": { "description": "Forbidden", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/image/preview": { "post": { "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FilePart" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "400": { "description": "Bad Request", "headers": { } }, "406": { "description": "Not Acceptable", "headers": { } } } } }, "/image/upload": { "post": { "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FilePart" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "400": { "description": "Bad Request", "headers": { } }, "406": { "description": "Not Acceptable", "headers": { } } } } }, "/image/{filename}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "filename", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } } } } }, "/permission/{uuid}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "uuid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/Permissions" } }, "403": { "description": "Forbidden", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/spaces": { "get": { "consumes": [ ], "produces": [ ], "parameters": [ { "type": "string", "name": "spaceKeys", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/SpaceDto" } } }, "400": { "description": "Bad Request", "headers": { } } } } }, "/spaces/search": { "get": { "consumes": [ ], "produces": [ ], "parameters": [ { "type": "integer", "name": "limit", "in": "query", "required": true }, { "type": "string", "name": "parameter", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "403": { "description": "Forbidden", "headers": { } } } } } }, "definitions": { "EventCategoryDto": { "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } }, "EventDto": { "properties": { "categories": { "type": "array", "items": { "ref": "#/definitions/EventCategoryDto" } }, "categoryIds": { "type": "string" }, "date": { "type": "string" }, "dayLong": { "type": "boolean" }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "end": { "type": "object" }, "endDate": { "type": "string" }, "endTime": { "type": "string" }, "endTimestamp": { "type": "string" }, "eventPageUrl": { "type": "string" }, "eventVersion": { "type": "integer" }, "fullTitle": { "type": "string" }, "hasEndTime": { "type": "boolean" }, "hasStartTime": { "type": "boolean" }, "hideParticipantCount": { "type": "boolean" }, "hideParticipantList": { "type": "boolean" }, "isCurrentUserParticipating": { "type": "boolean" }, "location": { "type": "string" }, "maxParticipants": { "type": "integer" }, "page": { "type": "object" }, "pageId": { "type": "integer" }, "participantCount": { "type": "integer" }, "participants": { "type": "array", "items": { "$ref": "#/definitions/ParticipantDto" } }, "rawDate": { "type": "string" }, "signUpAllowed": { "type": "boolean" }, "signUpOption": { "type": "string", "enum": [ "NO_RESTRICTION", "RESTRICTED_TO_SELF", "RESTRICTED_TO_SPECIFIC", "UNDEFINED" ] }, "spaceKey": { "type": "string" }, "start": { "type": "object" }, "startTime": { "type": "string" }, "startTimestamp": { "type": "string" }, "teaserImageName": { "type": "string" }, "teaserImageUrl": { "type": "string" }, "timezoneCreatedIn": { "type": "string" }, "title": { "type": "string" }, "uUID": { "type": "string" }, "userKey": { "type": "string" } } }, "FilePart": { "properties": { "contentType": { "type": "string" }, "formField": { "type": "boolean" }, "inputStream": { "type": "object" }, "name": { "type": "string" }, "value": { "type": "string" } } }, "ParticipantDto": { "properties": { "avatarUrl": { "type": "string" }, "eventUUID": { "type": "string" }, "external": { "type": "boolean" }, "fullName": { "type": "string" }, "participantId": { "type": "integer" }, "userKey": { "type": "string" }, "userName": { "type": "string" } } }, "Permissions": { "properties": { "deletePermission": { "type": "boolean" }, "duplicatePermission": { "type": "boolean" }, "editPermission": { "type": "boolean" }, "exportPermission": { "type": "boolean" }, "manageParticipantsPermission": { "type": "boolean" }, "participationPermission": { "type": "boolean" }, "viewPermission": { "type": "boolean" } } }, "SearchDto": { "properties": { "categoryConjunctionAnd": { "type": "boolean" }, "categoryIds": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "endDate": { "type": "integer" }, "limit": { "type": "string" }, "location": { "type": "string" }, "offset": { "type": "string" }, "onlyMyEvents": { "type": "boolean" }, "spaces": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "integer" }, "title": { "type": "string" } } }, "SpaceDto": { "properties": { "spaceKey": { "type": "string" }, "spaceName": { "type": "string" } } } } }