Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Search for a License by Assignment URL

After you have created your license (POST /{custid}/license) and created an assignment for your license (POST /{custid}/assignment/{objectid}), you can search for your license by assignment url. The request will yield the license(s) for the assignment.

To Get a License by Assignment URL (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The assignment URL.

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license/assignment?url=http://hostname.com

Response

200 OK

{
  "items": [
    {
      "extensionObject": {
        "id": "60601dc8-2c2a-4973-aec8-68a55b69e767",
        "customerId": "123355",
        "status": "active",
        "objectType": "license",
        "objectDescription": "Sample Description Test"
      },
      "license": {
        "licenseType": "Click-Through License Agreement",
        "publisherAcceptsSERU": "Yes",
        "authorizedUsers": "Sample authorized user statement",
        "governingJurisdiction": "Example venue",
        "governingLaw": "Sample clause",
        "indemnificationbyLicensee": "Sample clause",
        "indemnificationbyLicensor": "Sample clause",
        "allRightsReserved": "Sample clause",
        "confidentialityofAgreementRequired": "Yes",
        "confidentialityofUserInformationProtected": "Yes",
        "licenseNotes": "General notes",
        "url1": "http://hostname.com",
        "url2": "http://hostname.com",
        "url3": "http://hostname.com",
        "url4": "http://hostname.com",
        "licenseStartDate": "2000-10-10T00:00:00.000Z",
        "licenseDuration": "1 year",
        "licenseEndDate": "2000-10-10T00:00:00.000Z",
        "licenseEndAdvanceNoticeRequired": 1,
        "reviewer": "John Stearns",
        "reviewerNotes": "Sample reviewer comments",
        "licenseLocation": "www.urlstorage.com",
        "licenseStatus": "Current status",
        "otherStatus1": "Example status",
        "otherStatus2": "Example status",
        "otherStatus3": "Example status",
        "otherYesNo1": "Yes",
        "otherYesNo2": "Yes",
        "otherYesNo3": "Yes",
        "otherString1": "Text note",
        "otherString2": "Text note",
        "otherString3": "Text note",
        "archivingAllowed": "Yes",
        "archivingFormat": "string",
        "perpetualAccess": "Yes",
        "copyDigital": "Permitted Explicit",
        "copyPrint": "Permitted Implied",
        "coursePackElectronic": "Permitted Implied",
        "coursePackPrint": "Prohibited Implied",
        "distanceEducation": "Permitted Explicit",
        "fairUseClause": "Sample fair use clause.",
        "applicableCopyrightLaw": null,
        "illElectronic": "Prohibited Implied",
        "illPrint": "Permitted Explicit",
        "illSecureElectronic": "Not Specified in Agreement",
        "linkElectronic": "Prohibited Implied",
        "reservesElectronic": "Permitted Explicit",
        "reservesPrint": "Prohibited Implied",
        "scholarlySharing": "Prohibited Implied",
        "otherRestrictions": "Sample additional information",
        "walkIns": "Yes",
        "concurrentUsers": "25",
        "otherTerm1": "Permitted Explicit",
        "otherTerm2": "Permitted Explicit",
        "otherTerm3": "Permitted Explicit"
      },
      "dateCreated": "2018-12-31T14:44:40.000Z",
      "dateLastUpdated": "2019-01-07T16:39:56.000Z"
    }
  ],
  "totalResults": 1
}

For more information on the GET license by assignment resource, please refer to our interactive or service reference documentation.