EBSCO PHP wrapper for HoldingsIQ v4 API

The EBSCO HoldingsIQ service retrieves vendor, package and title related information in JSON format. The information includes customer selected resources as reflected in the EBSCO Knowledge Base for both EBSCO managed and customer managed resources.

You can find the Service Reference at https://developer.ebsco.com/reference/rmapi

You can find interactive Swagger documentation at https://developer.ebsco.com/interactive/holdingsiq

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/ebsco/holdingsiq-php-client.git"
    }
  ],
  "require": {
    "ebsco/holdingsiq-php-client": "*@dev"
  }
}

Then run composer install

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\HoldingsResourcesApi( new GuzzleHttp\Client() );
$custid = "demo";
$format = "kbart2";
$count = 5;
$offset = 1;
$x_api_key = "your_key_goes_here";

try {
    $result = $apiInstance->custidHoldingsGet($custid, $format, $count, $offset, $x_api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HoldingsResourcesApi->custidHoldingsGet: ', $e->getMessage(), PHP_EOL;
}

Documentation for API Endpoints

All URIs are relative to https://sandbox.ebsco.io/rm/rmaccounts

Class	Method	HTTP request	Description
HoldingsResourcesApi	custidHoldingsGet	GET /{custid}/holdings
HoldingsResourcesApi	custidHoldingsPost	POST /{custid}/holdings
HoldingsResourcesApi	custidHoldingsStatusGet	GET /{custid}/holdings/status
LabelAndProxyResourcesApi	custidGet	GET /{custid}/
LabelAndProxyResourcesApi	custidProxiesGet	GET /{custid}/proxies
LabelAndProxyResourcesApi	custidPut	PUT /{custid}/
PackageResourcesApi	custidPackagesGet	GET /{custid}/packages
PackageResourcesApi	custidVendorsVendoridPackagesPackageidGet	GET /{custid}/vendors/{vendorid}/packages/{packageid}
PackageResourcesApi	custidVendorsVendoridPackagesPackageidPut	PUT /{custid}/vendors/{vendorid}/packages/{packageid}
PackageResourcesApi	custidVendorsVendoridPackagesPackageidTitlesGet	GET /{custid}/vendors/{vendorid}/packages/{packageid}/titles
PackageResourcesApi	custidVendorsVendoridPackagesPackageidTitlesKbidGet	GET /{custid}/vendors/{vendorid}/packages/{packageid}/titles/{kbid}
PackageResourcesApi	custidVendorsVendoridPackagesPackageidTitlesKbidPut	PUT /{custid}/vendors/{vendorid}/packages/{packageid}/titles/{kbid}
PackageResourcesApi	custidVendorsVendoridPackagesPost	POST /{custid}/vendors/{vendorid}/packages
TitleResourcesApi	custidTitlesGet	GET /{custid}/titles
TitleResourcesApi	custidTitlesKbidGet	GET /{custid}/titles/{kbid}
TitleResourcesApi	custidVendorsVendoridPackagesPackageidTitlesPost	POST /{custid}/vendors/{vendorid}/packages/{packageid}/titles
VendorResourcesApi	custidVendorsGet	GET /{custid}/vendors
VendorResourcesApi	custidVendorsVendoridGet	GET /{custid}/vendors/{vendorid}
VendorResourcesApi	custidVendorsVendoridPackagesGet	GET /{custid}/vendors/{vendorid}/packages
VendorResourcesApi	custidVendorsVendoridPut	PUT /{custid}/vendors/{vendorid}

Documentation For Models

• ContributorID
• CoverageDates
• CustomLabels
• CustomLabelsProxy
• CustomPackagePayload
• CustomPackageResponse
• CustomTitlePayload
• CustomTitleResponse
• CustomTitleUpdatePayload
• CustomerResources
• CustomerResourcesCustom
• CustomerResourcesPackageId
• CustomerResourcesTitleROP
• CustomerToken
• EmbargoPeriod
• ErrorModel
• Errors
• Holding
• HoldingsDetails
• HoldingsStatus
• Identifier
• IdentifierCustom
• Label
• Labelid
• Model202error
• Model403error
• Model404error
• Model409error
• NItem
• Package
• PackageIdDetails
• Packages
• PackagesCombinedPayload
• ProxyDetails
• ProxyInfo
• ProxyInfoIn
• ProxyList
• ProxyWithURL
• SelectPayload
• SetCustomCoverageExcludeHidePayload
• SetCustomCoverageIncludingHidePayload
• SetCustomCoveragePayload
• SetCustomPackagePayload
• SetHidePayload
• SetManagedPackagePayload
• SetProxyInPayload
• SetProxyPayload
• SetProxyTwoPayload
• SetUserDefinedFieldsPayload
• Subj
• TitleCustom
• TitleManaged
• TitlePackageId
• TitleROP
• Titles
• TitlesCombinedPayload
• TitlesPackageId
• TokenDetails
• TokenInfo
• UnhidePackageTitlePayload
• UnselectPayload
• UpdatePackageInheritedProxyPayload
• UpdatePackageNonInheritedProxyPayload
• UpdatePackageProxyPayload
• UpdateVendorInheritedProxyPayload
• UpdateVendorNonInheritedProxyPayload
• UpdateVendorProxyPayload
• Vendor
• VendorDetails
• Vendors
• VisibilityInfo

Documentation For Authorization

All endpoints do not require authorization.

Author