Service Guides for ResourceIQ

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

Update a License

After you have created your license (POST /{custid}/license), you can update your license. A license is defined by a license object. The data elements related to a license can be updated. The request will yield the updated license object, the license id, any errors and a success flag.

To Update a License (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The license id for the license that you would like to update.
  • The updated license object.

Request

PUT  https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/license/LICENSEID
Body Request Parameter

{
  "extensionObject": {
    "objectDescription": "Sample Description",
    "objectType": "license",
    "status": "active"
  },
  "license": {
    "licenseType": "Click-Through License Agreement",
    "publisherAcceptsSERU": "Yes",
    "authorizedUsers": "Sample authorized user statement",
    "governingJurisdiction": "free-text",
    "governingLaw": "free-text",
    "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-10T10:10:10.000Z",
    "licenseDuration": "1 year",
    "licenseEndDate": "2000-10-10T10:10:10.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": "CD-ROM",
    "perpetualAccess": "Yes",
    "copyDigital": "Permitted Explicit",
    "copyPrint": "Permitted Implied",
    "coursePackElectronic": "Permitted Implied",
    "coursePackPrint": "Prohibited Implied",
    "distanceEducation": "Permitted Explicit",
    "fairUseClause": "Sample fair use clause.",
    "applicableCopyrightLaw": "Sample copyright",
    "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"
  }
}

Response

200 OK

{
  "licenseId": "60601dc8-2c2a-4973-aec8-68a55b69e767",
  "errors": [],
  "updatedLicense": {
    "extensionObject": {
      "id": "60601dc8-2c2a-4973-aec8-68a55b69e767",
      "customerId": "123355",
      "status": "active",
      "objectType": "license",
      "objectDescription": "Sample Description"
    },
    "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-10T10:10:10.000Z",
      "licenseDuration": "1 year",
      "licenseEndDate": "2000-10-10T10:10:10.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-22T21:08:14.829Z"
  },
  "successful": true
}

For more information on the PUT update license by id resource, please refer to our interactive or service reference documentation.