README

ETIM International webservices. - Extra documentation and testclient

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2.0
Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/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');

$apiInstance = new Swagger\Client\Api\ClassApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\ClassDetailsInput(); // \Swagger\Client\Model\ClassDetailsInput | Object of type Etim.Models.Elastic.ClassDetailsInput.

try {
    $result = $apiInstance->apiV2ClassDetailsDiffPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClassApi->apiV2ClassDetailsDiffPost: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\ClassApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\ClassDetailsReleaseInput(); // \Swagger\Client\Model\ClassDetailsReleaseInput | Object of type Etim.Models.Elastic.ClassDetailsReleaseInput.

try {
    $result = $apiInstance->apiV2ClassDetailsForReleasePost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClassApi->apiV2ClassDetailsForReleasePost: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\ClassApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\ClassListInput(); // \Swagger\Client\Model\ClassListInput | Objects of type Etim.Models.Elastic.ClassListInput.

try {
    $result = $apiInstance->apiV2ClassDetailsManyPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClassApi->apiV2ClassDetailsManyPost: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\ClassApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\ClassDetailsInput(); // \Swagger\Client\Model\ClassDetailsInput | Object of type Etim.Models.Elastic.ClassDetailsInput.

try {
    $result = $apiInstance->apiV2ClassDetailsPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClassApi->apiV2ClassDetailsPost: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\ClassApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\EntitySearchInput(); // \Swagger\Client\Model\EntitySearchInput | Object of type Etim.Models.Elastic.EntitySearchInput.

try {
    $result = $apiInstance->apiV2ClassSearchPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClassApi->apiV2ClassSearchPost: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
ClassApi	apiV2ClassDetailsDiffPost	POST /api/v2/Class/DetailsDiff	Get a specific class by class code and version, and show changes with previous version.
ClassApi	apiV2ClassDetailsForReleasePost	POST /api/v2/Class/DetailsForRelease	Get a specific class by class code and release.
ClassApi	apiV2ClassDetailsManyPost	POST /api/v2/Class/DetailsMany	Get multiple classes by class code and version.
ClassApi	apiV2ClassDetailsPost	POST /api/v2/Class/Details	Get a specific class by class code and version.
ClassApi	apiV2ClassSearchPost	POST /api/v2/Class/Search	Get a list of all classes that meet the input filters.
FeatureApi	apiV2FeatureDetailsPost	POST /api/v2/Feature/Details
FeatureApi	apiV2FeatureSearchPost	POST /api/v2/Feature/Search
GroupApi	apiV2GroupDetailsPost	POST /api/v2/Group/Details
GroupApi	apiV2GroupSearchPost	POST /api/v2/Group/Search
MiscApi	apiV2MiscLanguagesAllowedGet	GET /api/v2/Misc/LanguagesAllowed	Get a list of languages.
MiscApi	apiV2MiscLanguagesGet	GET /api/v2/Misc/Languages	Get a list of languages.
MiscApi	apiV2MiscReleasesGet	GET /api/v2/Misc/Releases	Get a list of ETIM releases.
UnitApi	apiV2UnitDetailsPost	POST /api/v2/Unit/Details
UnitApi	apiV2UnitSearchPost	POST /api/v2/Unit/Search
ValueApi	apiV2ValueDetailsPost	POST /api/v2/Value/Details
ValueApi	apiV2ValueSearchPost	POST /api/v2/Value/Search

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

info@etim-international.com

uteq / etim-php-client

Maintainers

Details