2017 © Pedro Peláez
 

library kunta-api-php-client

image

metatavu/kunta-api-php-client

  • Friday, December 22, 2017
  • by metatavu
  • Repository
  • 2 Watchers
  • 0 Stars
  • 16 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 14 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.1.0
  • Package version: 1.0.19
  • Build date: 2019-07-09T11:12:08.838+03: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/metatavu/kunta-api-php-client.git"
    }
  ],
  "require": {
    "metatavu/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)

setUsername('YOUR_USERNAME');
KuntaAPI\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new KuntaAPI\Api\AnnouncementsApi();
$organizationId = "organizationId_example"; // string | Organization id
$announcementId = "announcementId_example"; // string | Announcement id

try {
    $result = $api_instance->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 findOrganizationBannerImage GET /organizations/{organizationId}/banners/{bannerId}/images/{imageId} Returns a single organiztion banner image
BannersApi getOrganizationBannerImageData GET /organizations/{organizationId}/banners/{bannerId}/images/{imageId}/data Returns an organization banner image data
BannersApi listOrganizationBannerImages GET /organizations/{organizationId}/banners/{bannerId}/images Returns a list of organization banner images
BannersApi listOrganizationBanners GET /organizations/{organizationId}/banners Lists organizations banners
CodesApi findCode GET /codes/{codeId} Finds a code
CodesApi listCodes GET /codes Lists codes
ContactsApi findOrganizationContact GET /organizations/{organizationId}/contacts/{contactId} Finds an organizations contact
ContactsApi listOrganizationContacts GET /organizations/{organizationId}/contacts Lists organizations contacts
ElectronicChannelsApi findServiceElectronicChannel GET /services/{serviceId}/electronicChannels/{electronicChannelId} finds ElectronicChannel by electronicChannelId
ElectronicChannelsApi listServiceElectronicChannels GET /services/{serviceId}/electronicChannels Lists ElectronicChannels by serviceId
ElectronicServiceChannelsApi findElectronicServiceChannel GET /electronicServiceChannels/{electronicServiceChannelId} Finds an electronic service channel by id
ElectronicServiceChannelsApi listElectronicServiceChannels GET /electronicServiceChannels Lists electronic service channels
ElectronicServiceChannelsApi updateElectronicServiceChannel PUT /electronicServiceChannels/{electronicServiceChannelId} Updates a channel
EmergenciesApi findOrganizationEmergency GET /organizations/{organizationId}/emergencies/{emergencyId} Returns organizations emergency by id
EmergenciesApi listOrganizationEmergencies GET /organizations/{organizationId}/emergencies Lists organizations emergencies
EnvironmentalWarningsApi findOrganizationEnvironmentalWarning GET /organizations/{organizationId}/environmentalWarnings/{environmentalWarningId} Returns organizations environmental warning by id
EnvironmentalWarningsApi listOrganizationEnvironmentalWarnings GET /organizations/{organizationId}/environmentalWarnings Lists organizations environmentalWarnings
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 deleteOrganizationFile DELETE /organizations/{organizationId}/files/{fileId} Deletes an organization file
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
FragmentsApi findOrganizationFragment GET /organizations/{organizationId}/fragments/{fragmentId} Finds organizations page fragment
FragmentsApi listOrganizationFragments GET /organizations/{organizationId}/fragments Lists organizations page fragments
IncidentsApi findOrganizationIncident GET /organizations/{organizationId}/incidents/{incidentId} Returns organizations incident by id
IncidentsApi listOrganizationIncidents GET /organizations/{organizationId}/incidents Lists organizations incidents
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 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 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
OrganizationsApi findOrganization GET /organizations/{organizationId} Find organization
OrganizationsApi listOrganizations GET /organizations List organizations
PagesApi deleteOrganizationPage DELETE /organizations/{organizationId}/pages/{pageId} Deletes an organizations page
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 findServicePhoneChannel GET /services/{serviceId}/phoneChannels/{phoneChannelId} finds PhoneChannel by phoneChannelId
PhoneChannelsApi listServicePhoneChannels GET /services/{serviceId}/phoneChannels Lists PhoneChannels by serviceId
PhoneServiceChannelsApi findPhoneServiceChannel GET /phoneServiceChannels/{phoneServiceChannelId} Finds a phone service channel by id
PhoneServiceChannelsApi listPhoneServiceChannels GET /phoneServiceChannels Lists phone service channels
PhoneServiceChannelsApi updatePhoneServiceChannel PUT /phoneServiceChannels/{phoneServiceChannelId} Updates a channel
PrintableFormChannelsApi findServicePrintableFormChannel GET /services/{serviceId}/printableFormChannels/{printableFormChannelId} finds PrintableFormChannel by printableFormChannelId
PrintableFormChannelsApi listServicePrintableFormChannels GET /services/{serviceId}/printableFormChannels Lists PrintableFormChannels by serviceId
PrintableFormServiceChannelsApi findPrintableFormServiceChannel GET /printableFormServiceChannels/{printableFormServiceChannelId} Finds a printable form service channel
PrintableFormServiceChannelsApi listPrintableFormServiceChannels GET /printableFormServiceChannels Lists printable form service channels
PrintableFormServiceChannelsApi updatePrintableFormServiceChannel PUT /printableFormServiceChannels/{printableFormServiceChannelId} Updates a channel
PublicTransportApi findOrganizationPublicTransportAgency GET /organizations/{organizationId}/transportAgencies/{agencyId} Finds an organizations public transport agency
PublicTransportApi findOrganizationPublicTransportRoute GET /organizations/{organizationId}/transportRoutes/{routeId} Finds an organizations public transport route
PublicTransportApi findOrganizationPublicTransportSchedule GET /organizations/{organizationId}/transportSchedules/{scheduleId} Finds organizations public transport schedule
PublicTransportApi findOrganizationPublicTransportStop GET /organizations/{organizationId}/transportStops/{stopId} Finds a stop of organizations public transport route
PublicTransportApi findOrganizationPublicTransportStopTime GET /organizations/{organizationId}/transportStopTimes/{stopTimeId} Finds organizations public transport stopTime
PublicTransportApi findOrganizationPublicTransportTrip GET /organizations/{organizationId}/transportTrips/{tripId} Finds organizations public transport trip
PublicTransportApi listOrganizationPublicTransportAgencies GET /organizations/{organizationId}/transportAgencies Lists organizations public transport agencies
PublicTransportApi listOrganizationPublicTransportRoutes GET /organizations/{organizationId}/transportRoutes Lists organizations public transport routes
PublicTransportApi listOrganizationPublicTransportSchedules GET /organizations/{organizationId}/transportSchedules Lists schedules of organization's public transport schedules
PublicTransportApi listOrganizationPublicTransportStopTimes GET /organizations/{organizationId}/transportStopTimes Lists stopTimes of organization's public transport stopTimes
PublicTransportApi listOrganizationPublicTransportStops GET /organizations/{organizationId}/transportStops Lists organizations public transport stops
PublicTransportApi listOrganizationPublicTransportTrips GET /organizations/{organizationId}/transportTrips Lists trips of organization's public transport trips
ServiceChannelsApi findElectronicServiceChannel GET /electronicServiceChannels/{electronicServiceChannelId} Finds an electronic service channel by id
ServiceChannelsApi findPhoneServiceChannel GET /phoneServiceChannels/{phoneServiceChannelId} Finds a phone service channel by id
ServiceChannelsApi findPrintableFormServiceChannel GET /printableFormServiceChannels/{printableFormServiceChannelId} Finds a printable form service channel
ServiceChannelsApi findServiceLocationServiceChannel GET /serviceLocationServiceChannels/{serviceLocationServiceChannelId} Finds a service location service by id
ServiceChannelsApi findWebPageServiceChannel GET /webPageServiceChannels/{webPageServiceChannelId} Finds a web page service channel by id
ServiceChannelsApi listElectronicServiceChannels GET /electronicServiceChannels Lists electronic service channels
ServiceChannelsApi listPhoneServiceChannels GET /phoneServiceChannels Lists phone service channels
ServiceChannelsApi listPrintableFormServiceChannels GET /printableFormServiceChannels Lists printable form service channels
ServiceChannelsApi listServiceLocationServiceChannels GET /serviceLocationServiceChannels Lists service location service channels
ServiceChannelsApi listWebPageServiceChannels GET /webPageServiceChannels Lists web page service channels
ServiceChannelsApi updateElectronicServiceChannel PUT /electronicServiceChannels/{electronicServiceChannelId} Updates a channel
ServiceChannelsApi updatePhoneServiceChannel PUT /phoneServiceChannels/{phoneServiceChannelId} Updates a channel
ServiceChannelsApi updatePrintableFormServiceChannel PUT /printableFormServiceChannels/{printableFormServiceChannelId} Updates a channel
ServiceChannelsApi updateServiceLocationServiceChannel PUT /serviceLocationServiceChannels/{serviceLocationServiceChannelId} Updates a service location channel
ServiceChannelsApi updateWebPageServiceChannel PUT /webPageServiceChannels/{webPageServiceChannelId} Updates a channel
ServiceLocationChannelsApi findServiceServiceLocationChannel GET /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} finds ServiceLocationChannel by serviceLocationChannelId
ServiceLocationChannelsApi listServiceServiceLocationChannels GET /services/{serviceId}/serviceLocationChannels Lists ServiceLocationChannels by serviceId
ServiceLocationServiceChannelsApi findServiceLocationServiceChannel GET /serviceLocationServiceChannels/{serviceLocationServiceChannelId} Finds a service location service by id
ServiceLocationServiceChannelsApi listServiceLocationServiceChannels GET /serviceLocationServiceChannels Lists service location service channels
ServiceLocationServiceChannelsApi updateServiceLocationServiceChannel PUT /serviceLocationServiceChannels/{serviceLocationServiceChannelId} Updates a service location channel
ServicesApi createService POST /services Create service
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 updateService PUT /services/{serviceId} Updates service
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
ShortlinksApi findOrganizationShortlink GET /organizations/{organizationId}/shortlinks/{shortlinkId} Finds organization shortlink
ShortlinksApi listOrganizationShortlinks GET /organizations/{organizationId}/shortlinks Lists organizations shortlinks
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 findServiceWebPageChannel GET /services/{serviceId}/webPageChannels/{webPageChannelId} finds WebPageChannel by webPageChannelId
WebPageChannelsApi listServiceWebPageChannels GET /services/{serviceId}/webPageChannels Lists WebPageChannels by serviceId
WebPageServiceChannelsApi findWebPageServiceChannel GET /webPageServiceChannels/{webPageServiceChannelId} Finds a web page service channel by id
WebPageServiceChannelsApi listWebPageServiceChannels GET /webPageServiceChannels Lists web page service channels
WebPageServiceChannelsApi updateWebPageServiceChannel PUT /webPageServiceChannels/{webPageServiceChannelId} Updates a channel

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Author

The Versions

22/12 2017

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

22/12 2017

1.0.15

1.0.15.0 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

22/12 2017

1.0.14

1.0.14.0 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

21/12 2017

1.0.13

1.0.13.0 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

20/12 2017

1.0.11

1.0.11.0 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

19/12 2017

1.0.10

1.0.10.0 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

19/12 2017

1.0.9

1.0.9.0 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

18/12 2017

1.0.8

1.0.8.0 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

15/12 2017

1.0.7

1.0.7.0 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

29/11 2017

1.0.6

1.0.6.0 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

23/11 2017

1.0.5

1.0.5.0 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

20/11 2017

1.0.4

1.0.4.0 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

10/11 2017

1.0.3

1.0.3.0 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

01/11 2017

1.0.0

1.0.0.0 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