linkedevents-client-php
Linked Events provides categorized data on events and places using JSON-LD format. Events can be searched by date and location. Location can be exact address or larger area such as neighbourhood or borough JSON-LD format is streamlined using include mechanism. API users can request that certain fields are included directly into the result, instead of being hyperlinks to objects. Several fields are multilingual. These are implemented as object with each language variant as property. In this specification each multilingual field has (fi,sv,en) property triplet as example., (*1)
This PHP package is automatically generated by the Swagger Codegen project:, (*2)
- API version: v1
- Package version: 0.0.16
- Build package: io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.4.0 and later, (*3)
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json:, (*4)
{
"repositories": [
{
"type": "git",
"url": "https://github.com/metatavu/linkedevents-php-client.git"
}
],
"require": {
"metatavu/linkedevents-php-client": "*@dev"
}
}
Then run composer install, (*5)
Manual Installation
Download the files and include autoload.php:, (*6)
require_once('/path/to/linkedevents-client-php/autoload.php');
Tests
To run the unit tests:, (*7)
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:, (*8)
eventCreate($eventObject);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling EventApi->eventCreate: ', $e->getMessage(), PHP_EOL;
}
?>
Documentation for API Endpoints
All URIs are relative to https://api.hel.fi/linkedevents/v1, (*9)
| Class |
Method |
HTTP request |
Description |
| EventApi |
eventCreate |
POST /event/ |
Create a new event |
| EventApi |
eventDelete |
DELETE /event/{id}/ |
Delete an event |
| EventApi |
eventList |
GET /event/ |
Return a list of events |
| EventApi |
eventRetrieve |
GET /event/{id}/ |
Retrieve single event by id |
| EventApi |
eventUpdate |
PUT /event/{id}/ |
Update an event |
| FilterApi |
keywordCreate |
POST /keyword/ |
Creates new keyword |
| FilterApi |
keywordDelete |
DELETE /keyword/{id}/ |
Delete a keyword |
| FilterApi |
keywordList |
GET /keyword/ |
Returns a list of keywords used for describing events |
| FilterApi |
keywordRetrieve |
GET /keyword/{id}/ |
Return information for single keyword |
| FilterApi |
keywordSetList |
GET /keyword_set/ |
Return as list of keyword_sets for grouping keywords |
| FilterApi |
keywordSetRetrieve |
GET /keyword_set/{id} |
Return information about single keyword_set |
| FilterApi |
keywordUpdate |
PUT /keyword/{id}/ |
Update a keyword |
| FilterApi |
placeCreate |
POST /place/ |
Creates new place |
| FilterApi |
placeDelete |
DELETE /place/{id}/ |
Delete a place |
| FilterApi |
placeList |
GET /place/ |
Returns list of places used for describing events |
| FilterApi |
placeRetrieve |
GET /place/{id}/ |
Return information for single place |
| FilterApi |
placeUpdate |
PUT /place/{id}/ |
Update a place |
| ImageApi |
imageCreate |
POST /image/ |
Create a new image |
| ImageApi |
imageList |
GET /image/ |
Returns a list of images |
| ImageApi |
imageRetrieve |
GET /image/{id}/ |
Return information for single image |
| ImageApi |
imageUpdate |
PUT /image/{id}/ |
Update an image |
| LanguageApi |
languageList |
GET /language/ |
Return a list of languages used for describing events |
| LanguageApi |
languageRetrieve |
GET /language/{id}/ |
Return information for single language |
| SearchApi |
eventSearch |
GET /search/ |
Search through events and places |
Documentation For Models
Documentation For Authorization
All endpoints do not require authorization., (*10)
Author
Wallogit.com
