2017 © Pedro Peláez
 

library kunta-api-php-client

image

otavanopisto/kunta-api-php-client

  • Tuesday, November 29, 2016
  • by metatavu
  • Repository
  • 8 Watchers
  • 0 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

kunta-api-php-client

Solution to combine municipality services under single API., (*1)

This PHP package is automatically generated by the Swagger Codegen project:, (*2)

  • API version: 0.0.1
  • Package version: 0.0.2-alpha1
  • Build date: 2016-11-29T14:30:49.568+02:00
  • Build package: class 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/otavanopisto/kunta-api-php-client.git"
    }
  ],
  "require": {
    "otavanopisto/kunta-api-php-client": "*@dev"
  }
}

Then run composer install, (*5)

Manual Installation

Download the files and include autoload.php:, (*6)

    require_once('/path/to/kunta-api-php-client/autoload.php');

Tests

To run the unit tests:, (*7)

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:, (*8)

findOrganizationAnnouncement($organizationId, $announcementId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->findOrganizationAnnouncement: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://demo.kuntaapi.fi/v1, (*9)

Class Method HTTP request Description
AnnouncementsApi findOrganizationAnnouncement GET /organizations/{organizationId}/announcements/{announcementId} Finds an organizations announcement
AnnouncementsApi listOrganizationAnnouncements GET /organizations/{organizationId}/announcements Lists organizations announcements
BannersApi findOrganizationBanner GET /organizations/{organizationId}/banners/{bannerId} Finds organizations banner
BannersApi listOrganizationBannerImages GET /organizations/{organizationId}/banners/{bannerId}/images Returns a list of organization banner images
BannersApi listOrganizationBanners GET /organizations/{organizationId}/banners Lists organizations banners
ElectronicChannelsApi createServiceElectronicChannel POST /services/{serviceId}/electronicChannels creates ElectronicChannel
ElectronicChannelsApi findServiceElectronicChannel GET /services/{serviceId}/electronicChannels/{electronicChannelId} finds ElectronicChannel by electronicChannelId
ElectronicChannelsApi listServiceElectronicChannels GET /services/{serviceId}/electronicChannels Lists ElectronicChannels by serviceId
ElectronicChannelsApi updateServiceElectronicChannel PUT /services/{serviceId}/electronicChannels/{electronicChannelId} Updates ElectronicChannel
EventsApi findOrganizationEvent GET /organizations/{organizationId}/events/{eventId} Returns organizations event by id
EventsApi findOrganizationEventImage GET /organizations/{organizationId}/events/{eventId}/images/{imageId} Returns an event image
EventsApi getOrganizationEventImageData GET /organizations/{organizationId}/events/{eventId}/images/{imageId}/data Returns an event image data
EventsApi listOrganizationEventImages GET /organizations/{organizationId}/events/{eventId}/images Returns list of event images
EventsApi listOrganizationEvents GET /organizations/{organizationId}/events Lists organizations events
FilesApi findOrganizationFile GET /organizations/{organizationId}/files/{fileId} Finds organizations file
FilesApi getOrganizationFileData GET /organizations/{organizationId}/files/{fileId}/data Returns an organization file data
FilesApi listOrganizationFiles GET /organizations/{organizationId}/files Lists organizations files
JobsApi findOrganizationJob GET /organizations/{organizationId}/jobs/{jobId} Finds organizations job
JobsApi listOrganizationJobs GET /organizations/{organizationId}/jobs Lists organizations jobs
MenusApi findOrganizationMenu GET /organizations/{organizationId}/menus/{menuId} Finds organizations menu
MenusApi findOrganizationMenuItem GET /organizations/{organizationId}/menus/{menuId}/items/{menuItemId} Finds organization menu item
MenusApi listOrganizationMenuItems GET /organizations/{organizationId}/menus/{menuId}/items Lists organizations menu items
MenusApi listOrganizationMenus GET /organizations/{organizationId}/menus Lists organizations menus
NewsApi findOrganizationBannerImage GET /organizations/{organizationId}/banners/{bannerId}/images/{imageId} Returns a single organiztion banner image
NewsApi findOrganizationNewsArticle GET /organizations/{organizationId}/news/{newsArticleId} Finds organizations news article
NewsApi findOrganizationNewsArticleImage GET /organizations/{organizationId}/news/{newsArticleId}/images/{imageId} Returns an news article image
NewsApi getOrganizationBannerImageData GET /organizations/{organizationId}/banners/{bannerId}/images/{imageId}/data Returns an organization banner image data
NewsApi getOrganizationNewsArticleImageData GET /organizations/{organizationId}/news/{newsArticleId}/images/{imageId}/data Returns a news article image data
NewsApi listOrganizationNews GET /organizations/{organizationId}/news Lists organizations news
NewsApi listOrganizationNewsArticleImages GET /organizations/{organizationId}/news/{newsArticleId}/images Returns list of news article images
OrganizationServicesApi createOrganizationService POST /organizations/{organizationId}/organizationServices Create organization service
OrganizationServicesApi findOrganizationService GET /organizations/{organizationId}/organizationServices/{organizationServiceId} Finds a organization service by id
OrganizationServicesApi listOrganizationOrganizationServices GET /organizations/{organizationId}/organizationServices Organization organization service list
OrganizationServicesApi updateOrganizationService PUT /organizations/{organizationId}/organizationServices/{organizationServiceId} Updates an organization service
OrganizationsApi createOrganizationService POST /organizations/{organizationId}/organizationServices Create organization service
OrganizationsApi findOrganization GET /organizations/{organizationId} Find organization
OrganizationsApi findOrganizationService GET /organizations/{organizationId}/organizationServices/{organizationServiceId} Finds a organization service by id
OrganizationsApi listOrganizationOrganizationServices GET /organizations/{organizationId}/organizationServices Organization organization service list
OrganizationsApi listOrganizations GET /organizations List organizations
OrganizationsApi updateOrganizationService PUT /organizations/{organizationId}/organizationServices/{organizationServiceId} Updates an organization service
PagesApi findOrganizationPage GET /organizations/{organizationId}/pages/{pageId} Finds organizations page
PagesApi findOrganizationPageContent GET /organizations/{organizationId}/pages/{pageId}/content Returns organizations page content in all available languages
PagesApi findOrganizationPageImage GET /organizations/{organizationId}/pages/{pageId}/images/{imageId} Returns a single organiztion page image
PagesApi getOrganizationPageImageData GET /organizations/{organizationId}/pages/{pageId}/images/{imageId}/data Returns an organization page image data
PagesApi listOrganizationPageImages GET /organizations/{organizationId}/pages/{pageId}/images Returns a list of organization page images
PagesApi listOrganizationPages GET /organizations/{organizationId}/pages Lists organizations pages
PhoneChannelsApi createServicePhoneChannel POST /services/{serviceId}/phoneChannels creates PhoneChannel
PhoneChannelsApi findServicePhoneChannel GET /services/{serviceId}/phoneChannels/{phoneChannelId} finds PhoneChannel by phoneChannelId
PhoneChannelsApi listServicePhoneChannels GET /services/{serviceId}/phoneChannels Lists PhoneChannels by serviceId
PhoneChannelsApi updatePhoneChannel PUT /services/{serviceId}/phoneChannels/{phoneChannelId} Updates PhoneChannel
PrintableFormChannelsApi createServicePrintableFormChannel POST /services/{serviceId}/printableFormChannels creates PrintableFormChannel
PrintableFormChannelsApi findServicePrintableFormChannel GET /services/{serviceId}/printableFormChannels/{printableFormChannelId} finds PrintableFormChannel by printableFormChannelId
PrintableFormChannelsApi listServicePrintableFormChannels GET /services/{serviceId}/printableFormChannels Lists PrintableFormChannels by serviceId
PrintableFormChannelsApi updatePrintableFormChannel PUT /services/{serviceId}/printableFormChannels/{printableFormChannelId} Updates PrintableFormChannel
ServiceLocationChannelsApi createServiceServiceLocationChannel POST /services/{serviceId}/serviceLocationChannels creates ServiceLocationChannel
ServiceLocationChannelsApi findServiceServiceLocationChannel GET /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} finds ServiceLocationChannel by serviceLocationChannelId
ServiceLocationChannelsApi listServiceServiceLocationChannels GET /services/{serviceId}/serviceLocationChannels Lists ServiceLocationChannels by serviceId
ServiceLocationChannelsApi updateServiceLocationChannel PUT /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} Updates ServiceLocationChannel
ServicesApi createService POST /services Create service
ServicesApi createServiceElectronicChannel POST /services/{serviceId}/electronicChannels creates ElectronicChannel
ServicesApi createServicePhoneChannel POST /services/{serviceId}/phoneChannels creates PhoneChannel
ServicesApi createServicePrintableFormChannel POST /services/{serviceId}/printableFormChannels creates PrintableFormChannel
ServicesApi createServiceServiceLocationChannel POST /services/{serviceId}/serviceLocationChannels creates ServiceLocationChannel
ServicesApi createServiceWebPageChannel POST /services/{serviceId}/webPageChannels creates WebPageChannel
ServicesApi findService GET /services/{serviceId} Finds a service by id
ServicesApi findServiceElectronicChannel GET /services/{serviceId}/electronicChannels/{electronicChannelId} finds ElectronicChannel by electronicChannelId
ServicesApi findServicePhoneChannel GET /services/{serviceId}/phoneChannels/{phoneChannelId} finds PhoneChannel by phoneChannelId
ServicesApi findServicePrintableFormChannel GET /services/{serviceId}/printableFormChannels/{printableFormChannelId} finds PrintableFormChannel by printableFormChannelId
ServicesApi findServiceServiceLocationChannel GET /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} finds ServiceLocationChannel by serviceLocationChannelId
ServicesApi findServiceWebPageChannel GET /services/{serviceId}/webPageChannels/{webPageChannelId} finds WebPageChannel by webPageChannelId
ServicesApi listServiceElectronicChannels GET /services/{serviceId}/electronicChannels Lists ElectronicChannels by serviceId
ServicesApi listServicePhoneChannels GET /services/{serviceId}/phoneChannels Lists PhoneChannels by serviceId
ServicesApi listServicePrintableFormChannels GET /services/{serviceId}/printableFormChannels Lists PrintableFormChannels by serviceId
ServicesApi listServiceServiceLocationChannels GET /services/{serviceId}/serviceLocationChannels Lists ServiceLocationChannels by serviceId
ServicesApi listServiceWebPageChannels GET /services/{serviceId}/webPageChannels Lists WebPageChannels by serviceId
ServicesApi listServices GET /services Service list
ServicesApi updatePhoneChannel PUT /services/{serviceId}/phoneChannels/{phoneChannelId} Updates PhoneChannel
ServicesApi updatePrintableFormChannel PUT /services/{serviceId}/printableFormChannels/{printableFormChannelId} Updates PrintableFormChannel
ServicesApi updateService PUT /services/{serviceId} Updates service
ServicesApi updateServiceElectronicChannel PUT /services/{serviceId}/electronicChannels/{electronicChannelId} Updates ElectronicChannel
ServicesApi updateServiceLocationChannel PUT /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} Updates ServiceLocationChannel
ServicesApi updateWebPageChannel PUT /services/{serviceId}/webPageChannels/{webPageChannelId} Updates WebPageChannel
SettingsApi createOrganizationSetting POST /organizations/{organizationId}/settings/ Creates organization setting
SettingsApi deleteOrganizationSetting DELETE /organizations/{organizationId}/settings/{settingId} Deletes an organization setting
SettingsApi findOrganizationSetting GET /organizations/{organizationId}/settings/{settingId} Finds organizations setting
SettingsApi listOrganizationSettings GET /organizations/{organizationId}/settings/ Lists organizations settings
SettingsApi updateOrganizationSetting PUT /organizations/{organizationId}/settings/{settingId} Updates an organization setting
TilesApi findOrganizationTile GET /organizations/{organizationId}/tiles/{tileId} Finds organizations tile
TilesApi findOrganizationTileImage GET /organizations/{organizationId}/tiles/{tileId}/images/{imageId} Returns a single organiztion tile image
TilesApi getOrganizationTileImageData GET /organizations/{organizationId}/tiles/{tileId}/images/{imageId}/data Returns an organization tile image data
TilesApi listOrganizationTileImages GET /organizations/{organizationId}/tiles/{tileId}/images Returns a list of organization tile images
TilesApi listOrganizationTiles GET /organizations/{organizationId}/tiles Lists organizations tiles
WebPageChannelsApi createServiceWebPageChannel POST /services/{serviceId}/webPageChannels creates WebPageChannel
WebPageChannelsApi findServiceWebPageChannel GET /services/{serviceId}/webPageChannels/{webPageChannelId} finds WebPageChannel by webPageChannelId
WebPageChannelsApi listServiceWebPageChannels GET /services/{serviceId}/webPageChannels Lists WebPageChannels by serviceId
WebPageChannelsApi updateWebPageChannel PUT /services/{serviceId}/webPageChannels/{webPageChannelId} Updates WebPageChannel

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization., (*10)

Author

The Versions

29/11 2016

dev-master

9999999-dev http://swagger.io

  Sources   Download

Apache V2

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk