metatavu / linkedevents-php-client
Requires
- php: >=5.4
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ~4.8
- satooshi/php-coveralls: ~1.0
- squizlabs/php_codesniffer: ~2.6
README
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.
This PHP package is automatically generated by the Swagger Codegen project:
- API version: v1
- Package version: 0.0.16
- Build package: io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.4.0 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/metatavu/linkedevents-php-client.git"
}
],
"require": {
"metatavu/linkedevents-php-client": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/linkedevents-client-php/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $api_instance = new Metatavu\LinkedEvents\Api\EventApi(); $eventObject = new \Metatavu\LinkedEvents\Model\Event(); // \Metatavu\LinkedEvents\Model\Event | try { $result = $api_instance->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
Documentation For Models
- Event
- EventInfoUrl
- EventName
- Eventlink
- IdRef
- Image
- ImageUrl
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- Keyword
- KeywordName
- KeywordSet
- KeywordSetName
- Language
- LanguageName
- MetaDefinition
- Offer
- OfferDescription
- OfferInfoUrl
- OfferPrice
- Place
- PlaceAddressLocality
- PlaceCustomData
- PlaceDescription
- PlaceInfoUrl
- PlaceName
- PlacePosition
- PlaceStreetAddress
- PlaceTelephone
Documentation For Authorization
All endpoints do not require authorization.