Licenses response details
Examples:
The following examples demonstrate the different operations that can be executed on licenses using HTTP methods. The licenses service can return data in two possible formats.
| Format | Accept Header | Extension |
|---|---|---|
| Atom XML | application/atom+xml | .xml |
| Atom JSON | application/json | .json |
GET a collection of licenses:
Request:
https://beta-lman.sd00.worldcat.org/license-manager/licenses?q=licenseStatus:OPEN&startIndex=2&itemsPerPage=5
XML Response:
<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
<id>info:OCLC/Platform/Service</id>
<title type="text">OCLC Platform Service Results</title>
<link href="https://beta-lman.sd00.worldcat.org/licenses?inst=128807&principalID=8eaa9f92-3951-431c-975a-d7df26b8d131&principalIDNS=urn:oclc:wms:da" rel="self" />
<updated>2012-08-03T13:10:59.982Z</updated>
<os:totalResults>1</os:totalResults>
<os:startIndex>1</os:startIndex>
<os:itemsPerPage>10</os:itemsPerPage>
<entry xmlns:gd="http://schemas.google.com/g/2005">
<title type="text">Karen Test License</title>
<id>https://beta-lman.sd00.worldcat.org/licenses/491eb1bb-7b98-4d13-9517-0bdea9ed2db2</id>
<link href="https://beta-lman.sd00.worldcat.org/licenses/491eb1bb-7b98-4d13-9517-0bdea9ed2db2" rel="self" type="application/atom+xml" />
<updated>2012-08-03T13:11:00.115Z</updated>
<content type="application/xml">
<license xmlns="http://worldcat.org/xmlschemas/LicenseManager" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://worldcat.org/xmlschemas/LicenseManager http://worldcat.org/xmlschemas/LicenseManager/1.1/LicenseManager-1.1-license.xsd">
<id>491eb1bb-7b98-4d13-9517-0bdea9ed2db2</id>
<name>Karen Test License</name>
<description>License template for EBSCOhost databases</description>
<active>false</active>
<dateCreated>2012-03-13T18:28:21Z</dateCreated>
<createdBy>
<name>Karen</name>
</createdBy>
<starts>2012-03-14T00:00Z</starts>
<expires>2013-03-13T00:00Z</expires>
<renewByDate>2013-01-02T00:00Z</renewByDate>
<signed>false</signed>
<licensor href="https://vic.sd00.worldcat.org/vendors/02fa25f2-aae5-4865-878b-fe8aecdc0ac6">
<id>02fa25f2-aae5-4865-878b-fe8aecdc0ac6</id>
<name>EBSCO Publishing</name>
</licensor>
<collections>
<collection>
<id>EBSCOhost.a9h</id>
<link>http://worldcat.org/webservices/kb/rest/collections/EBSCOhost.a9h</link>
<name>Academic Search Complete</name>
<provider>EBSCOhost</provider>
</collection>
</collections>
<terms>
<term>
<type>Course_Materials</type>
<termValue>yes</termValue>
<subTerms>
<subTerm>
<subTermName>Methods Supported</subTermName>
<options>
<option>
<name>Electronic Course Materials</name>
<value>true</value>
</option>
<option>
<name>Printed Course Pack</name>
<value>false</value>
</option>
<option>
<name>Printed Course Reserves</name>
<value>false</value>
</option>
</options>
</subTerm>
</subTerms>
</term>
<term>
<type>Interlibrary_Loan</type>
<termValue>yes</termValue>
<subTerms>
<subTerm>
<subTermName>Additional Rights and Restrictions</subTermName>
<options>
<option>
<name>Record Keeping Required</name>
<value>false</value>
</option>
<option>
<name>Loansome Doc Required</name>
<value>false</value>
</option>
<option>
<name>Non-Profit Only</name>
<value>true</value>
</option>
<option>
<name>Same Country Only</name>
<value>true</value>
</option>
</options>
</subTerm>
<subTerm>
<subTermName>Methods Supported</subTermName>
<options>
<option>
<name>Secure Electronic (e.g. Ariel, Odyssey)</name>
<value>true</value>
</option>
<option>
<name>Print or Fax</name>
<value>false</value>
</option>
<option>
<name>Electronic Copy</name>
<value>false</value>
</option>
</options>
</subTerm>
</subTerms>
</term>
</terms>
</license>
</content>
<gd:etag>c0ff9270b02e34abbc22c940db950b20</gd:etag>
</entry>
....
</feed>
JSON Response:
{
"id":"info:OCLC/Platform/Service",
"title":"OCLC Platform Service Results",
"updated":"2012-08-03T13:12:30.727Z",
"links":[
{
"href":"https://beta-lman.sd00.worldcat.org/licenses?inst=128807&principalID=8eaa9f92-3951-431c-975a-d7df26b8d131&principalIDNS=urn:oclc:wms:da",
"rel":"self"
}
],
"entries":[
{
"id":"https://beta-lman.sd00.worldcat.org/licenses/491eb1bb-7b98-4d13-9517-0bdea9ed2db2",
"title":"Karen Test License",
"content":{
"href":"https://beta-lman.sd00.worldcat.org/licenses/491eb1bb-7b98-4d13-9517-0bdea9ed2db2",
"name":"Karen Test License",
"id":"491eb1bb-7b98-4d13-9517-0bdea9ed2db2",
"description":"License template for EBSCOhost databases",
"createdBy":{
"name":"Karen",
"id":null,
"etag":"b9977c747ccc6a8f8e4283c056e6277b"
},
"licensor":{
"href":"https://vic.sd00.worldcat.org/vendors/02fa25f2-aae5-4865-878b-fe8aecdc0ac6",
"name":"EBSCO Publishing",
"id":"02fa25f2-aae5-4865-878b-fe8aecdc0ac6",
"etag":"44188fff48ef1032d76745ae84a81c1f"
},
"collections":{
"collectionWrappers":[
{
"name":"Academic Search Complete",
"id":"EBSCOhost.a9h",
"provider":"EBSCOhost",
"link":"http://worldcat.org/webservices/kb/rest/collections/EBSCOhost.a9h"
}
]
},
"active":"false",
"dateCreated":"2012-03-13T18:28:21Z",
"starts":"2012-03-14T00:00Z",
"expires":"2013-03-13T00:00Z",
"renewByDate":"2013-01-02T00:00Z",
"signed":"false",
"dateSigned":null,
"terms":{
"terms":[
{
"subTerms":{
"subterms":[
{
"options":{
"option":[
{
"name":"Print or Fax",
"value":"false",
"etag":"e89a5f98b14405ebaaa88287538e148c"
},
{
"name":"Electronic Copy",
"value":"false",
"etag":"d3e38760efbbaf24082ab42891525016"
},
{
"name":"Secure Electronic (e.g. Ariel, Odyssey)",
"value":"true",
"etag":"46cec3a70890d6d499384ae807ecc30c"
}
]
},
"subTermName":"Methods Supported"
},
{
"options":{
"option":[
{
"name":"Loansome Doc Required",
"value":"false",
"etag":"b06e987f231d751b2c0a3c1eb8d1d557"
},
{
"name":"Same Country Only",
"value":"true",
"etag":"82e705b9f4aaf78fada0ac3ce03e0563"
},
{
"name":"Non-Profit Only",
"value":"true",
"etag":"b5487a760785d2e21b60593ef0bbf2a1"
},
{
"name":"Record Keeping Required",
"value":"false",
"etag":"ca68a0082a74ac28191d8666976e44d2"
}
]
},
"subTermName":"Additional Rights and Restrictions"
}
],
"etag":"12a6b18753b0822a4e728e850905515a"
},
"type":"Interlibrary_Loan",
"notes":null,
"termValue":"yes",
"etag":"4c9df68c2786046ec2d811cbb2911d5f"
},
{
"subTerms":{
"subterms":[
{
"options":{
"option":[
{
"name":"Electronic Course Materials",
"value":"true",
"etag":"5eb00b6815e84ad13b6df84d6924fcd1"
},
{
"name":"Printed Course Reserves",
"value":"false",
"etag":"300bd65841c17dd302b35be707398d6f"
},
{
"name":"Printed Course Pack",
"value":"false",
"etag":"f8b88b9a789be004f5249dae41553df9"
}
]
},
"subTermName":"Methods Supported"
}
],
"etag":"a51852213246275615e26e45189b283a"
},
"type":"Course_Materials",
"notes":null,
"termValue":"yes",
"etag":"ea7399bde4faff8273824c0d531946cf"
}
],
"etag":"4520f14cca6fc8625734bcf817c59bc5"
},
"comments":null,
"documents":null,
"etag":"441be2dccd5235a305bec5f8e48e551a"
},
"updated":"2012-08-03T13:12:30.731Z",
"links":[
{
"href":"https://beta-lman.sd00.worldcat.org/licenses/491eb1bb-7b98-4d13-9517-0bdea9ed2db2",
"rel":"self",
"type":"application/atom+xml"
}
],
"extensions":[
{
"name":"gd:etag",
"attributes":{
"xmlns:gd":"http://schemas.google.com/g/2005"
},
"children":[
"441be2dccd5235a305bec5f8e48e551a"
]
}
]
}
],
"extensions":[
{
"name":"os:totalResults",
"attributes":{
"xmlns:os":"http://a9.com/-/spec/opensearch/1.1/"
},
"children":[
"1"
]
},
{
"name":"os:startIndex",
"attributes":{
"xmlns:os":"http://a9.com/-/spec/opensearch/1.1/"
},
"children":[
"1"
]
},
{
"name":"os:itemsPerPage",
"attributes":{
"xmlns:os":"http://a9.com/-/spec/opensearch/1.1/"
},
"children":[
"10"
]
}
]
}
POST a license
Request:
https://beta-lman.sd00.worldcat.org/license-manager/licenses
POST Body:
<entry xmlns="http://www.w3.org/2005/Atom"> <title type="text">Heather License 2</title> <link rel="alternate" type="application/atom+xml"/> <modified>2012-08-28T18:06:58.466Z</modified> <content type="application/xml"> <license xmlns="http://worldcat.org/xmlschemas/LicenseManager"> <name>Heather License Test Create</name> <description>TestWriteAPI POST i.e. CREATE</description> <active>false</active> <dateCreated>02/22/2012 02:38:17</dateCreated> <createdBy> <id>660ecd7d-3d1b-4433-abcd-ae843b716ecd</id> <institutionId>91475</institutionId> <name>Heather Dudash</name> </createdBy> <starts>02/01/2012 00:00:00</starts> <expires>04/24/2012 00:00:00</expires> <signed>false</signed> <licensor> <id>c387fde6-2f18-42a5-bf46-d7c447cc0e58</id> <name>Neil's Automated Vendor Safari</name> </licensor> <collections> <collection> <id>EBSCOhost.28h</id> <link>http://worldcat.org/webservices/kb/rest/collections/EBSCOhost.28h</link> <name>Violence and Abuse Abstracts</name> <provider>EBSCO Host</provider> </collection> </collections> <terms> <term> <type>Interlibrary_Loan</type> <termValue>silent</termValue> <subTerms> <subTerm> <subTermName>Methods_Supported</subTermName> <options> <option> <name>Electronic_Copy</name> <value>false</value> </option> <option> <name>Secure_Electronic</name> <value>false</value> </option> <option> <name>Print_or_Fax</name> <value>false</value> </option> </options> </subTerm> <subTerm> <subTermName>Additional_Rights_and_Restrictions</subTermName> <options> <option> <name>Loansome_Doc_Required</name> <value>false</value> </option> <option> <name>Same_Country_Only</name> <value>false</value> </option> <option> <name>Record_Keeping_Required</name> <value>false</value> </option> <option> <name>Non-Profit_Only</name> <value>false</value> </option> </options> </subTerm> </subTerms> </term> </terms> <comments> <comment> <content>new comment</content> <createdBy> <id>660ecd7d-3d1b-4433-abcd-ae843b716ecd</id> <institutionId>91475</institutionId> <name>Heather Dudash</name> </createdBy> <dateCreated>02/22/2012 13:57:59</dateCreated> </comment> </comments> <documents> <document> <dateCreated>05/24/2012 18:49:32</dateCreated> <description>Short Wavy Haircuts.docx</description> <fileName>Short Wavy Haircuts.docx</fileName> <includesSignature>false</includesSignature> <notes/> <url>unknown</url> </document> </documents> </license> </content> </entry>
Response:
<entry xmlns="http://www.w3.org/2005/Atom"> <title type="text">Heather License Test Create</title> <id>https://lmanapi.sd00-dev.ent.oclc.org/licenses/def84811-de69-4054-8224-bbb207cf441a</id> <link href="https://lmanapi.sd00-dev.ent.oclc.org/licenses/def84811-de69-4054-8224-bbb207cf441a" rel="self" type="application/atom+xml" /> <updated>2012-10-31T13:28:45.504Z</updated> <content type="application/xml"> <license xmlns="http://worldcat.org/xmlschemas/LicenseManager" xmlns:ns2="http://worldcat.org/xmlschemas/LicenseManager" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://worldcat.org/xmlschemas/LicenseManager http://svn.dev.oclc.org/svn/XMLSchemas/LicenseManager/trunk/src/main/schemas/License.xsd"> <id>def84811-de69-4054-8224-bbb207cf441a</id> <name>Heather License Test Create</name> <description>TestWriteAPI POST i.e. CREATE</description> <active>false</active> <dateCreated>10/31/2012 13:28:44</dateCreated> <createdBy> <id>56d4d714-8162-4855-a8bf-9e2f5011f93f</id> <institutionId>128807</institutionId> </createdBy> <starts>02/01/2012 00:00:00</starts> <expires>04/24/2012 00:00:00</expires> <signed>false</signed> <licensor> <id>c387fde6-2f18-42a5-bf46-d7c447cc0e58</id> <name>Neil's Automated Vendor Safari</name> </licensor> <collections> <collection> <id>EBSCOhost.28h</id> <name>Violence and Abuse Abstracts</name> <link>http://worldcat.org/webservices/kb/rest/collections/EBSCOhost.28h</link> <provider>EBSCO Host</provider> </collection> </collections> <terms> <term> <type>Interlibrary_Loan</type> <termValue>silent</termValue> <subTerms> <subTerm> <subTermName>Methods_Supported</subTermName> <options> <option> <name>Electronic_Copy</name> <value>false</value> </option> <option> <name>Secure_Electronic</name> <value>false</value> </option> <option> <name>Print_or_Fax</name> <value>false</value> </option> </options> </subTerm> <subTerm> <subTermName>Additional_Rights_and_Restrictions</subTermName> <options> <option> <name>Loansome_Doc_Required</name> <value>false</value> </option> <option> <name>Same_Country_Only</name> <value>false</value> </option> <option> <name>Record_Keeping_Required</name> <value>false</value> </option> <option> <name>Non-Profit_Only</name> <value>false</value> </option> </options> </subTerm> </subTerms> </term> </terms> <documents> <document> <id>c2778805-81ea-4957-bdf1-14ee047e5edc</id> <dateCreated>10/31/2012 13:28:44</dateCreated> <fileName>Short Wavy Haircuts.docx</fileName> <url>unknown</url> <description>Short Wavy Haircuts.docx</description> <notes /> <includesSignature>false</includesSignature> </document> </documents> </license> </content> </entry>
PUT a license
Request:
https://beta-lman.sd00.worldcat.org/license-manager/licenses/def84811-de69-4054-8224-bbb207cf441a
POST Body:
<entry xmlns="http://www.w3.org/2005/Atom"> <title type="text">Heather License 2</title> <link rel="alternate" type="application/atom+xml"/> <modified>2012-08-28T18:06:58.466Z</modified> <content type="application/xml"> <license xmlns="http://worldcat.org/xmlschemas/LicenseManager"> <name>Heather License Test Create</name> <description>I AM EDITING THE DESCRIPTION</description> <active>false</active> <dateCreated>02/22/2012 02:38:17</dateCreated> <createdBy> <id>660ecd7d-3d1b-4433-abcd-ae843b716ecd</id> <institutionId>91475</institutionId> <name>Heather Dudash</name> </createdBy> <starts>02/01/2012 00:00:00</starts> <expires>04/24/2012 00:00:00</expires> <signed>false</signed> <licensor> <id>c387fde6-2f18-42a5-bf46-d7c447cc0e58</id> <name>Neil's Automated Vendor Safari</name> </licensor> <collections> <collection> <id>EBSCOhost.28h</id> <link>http://worldcat.org/webservices/kb/rest/collections/EBSCOhost.28h</link> <name>Violence and Abuse Abstracts</name> <provider>EBSCO Host</provider> </collection> </collections> <terms> <term> <type>Interlibrary_Loan</type> <termValue>silent</termValue> <subTerms> <subTerm> <subTermName>Methods_Supported</subTermName> <options> <option> <name>Electronic_Copy</name> <value>false</value> </option> <option> <name>Secure_Electronic</name> <value>false</value> </option> <option> <name>Print_or_Fax</name> <value>false</value> </option> </options> </subTerm> <subTerm> <subTermName>Additional_Rights_and_Restrictions</subTermName> <options> <option> <name>Loansome_Doc_Required</name> <value>false</value> </option> <option> <name>Same_Country_Only</name> <value>false</value> </option> <option> <name>Record_Keeping_Required</name> <value>false</value> </option> <option> <name>Non-Profit_Only</name> <value>false</value> </option> </options> </subTerm> </subTerms> </term> </terms> <comments> <comment> <content>new comment</content> <createdBy> <id>660ecd7d-3d1b-4433-abcd-ae843b716ecd</id> <institutionId>91475</institutionId> <name>Heather Dudash</name> </createdBy> <dateCreated>02/22/2012 13:57:59</dateCreated> </comment> </comments> <documents> <document> <dateCreated>05/24/2012 18:49:32</dateCreated> <description>Short Wavy Haircuts.docx</description> <fileName>Short Wavy Haircuts.docx</fileName> <includesSignature>false</includesSignature> <notes/> <url>unknown</url> </document> </documents> </license> </content> </entry>
Response:
<entry xmlns="http://www.w3.org/2005/Atom"> <title type="text">Heather License Test Create</title> <id>https://lmanapi.sd00-dev.ent.oclc.org/licenses/def84811-de69-4054-8224-bbb207cf441a</id> <link href="https://lmanapi.sd00-dev.ent.oclc.org/licenses/def84811-de69-4054-8224-bbb207cf441a" rel="self" type="application/atom+xml" /> <updated>2012-10-31T13:28:45.504Z</updated> <content type="application/xml"> <license xmlns="http://worldcat.org/xmlschemas/LicenseManager" xmlns:ns2="http://worldcat.org/xmlschemas/LicenseManager" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://worldcat.org/xmlschemas/LicenseManager http://svn.dev.oclc.org/svn/XMLSchemas/LicenseManager/trunk/src/main/schemas/License.xsd"> <id>def84811-de69-4054-8224-bbb207cf441a</id> <name>Heather License Test Create</name> <description>I AM EDITING THE DESCRIPTION</description> <active>false</active> <dateCreated>10/31/2012 13:28:44</dateCreated> <createdBy> <id>56d4d714-8162-4855-a8bf-9e2f5011f93f</id> <institutionId>128807</institutionId> </createdBy> <starts>02/01/2012 00:00:00</starts> <expires>04/24/2012 00:00:00</expires> <signed>false</signed> <licensor> <id>c387fde6-2f18-42a5-bf46-d7c447cc0e58</id> <name>Neil's Automated Vendor Safari</name> </licensor> <collections> <collection> <id>EBSCOhost.28h</id> <name>Violence and Abuse Abstracts</name> <link>http://worldcat.org/webservices/kb/rest/collections/EBSCOhost.28h</link> <provider>EBSCO Host</provider> </collection> </collections> <terms> <term> <type>Interlibrary_Loan</type> <termValue>silent</termValue> <subTerms> <subTerm> <subTermName>Methods_Supported</subTermName> <options> <option> <name>Electronic_Copy</name> <value>false</value> </option> <option> <name>Secure_Electronic</name> <value>false</value> </option> <option> <name>Print_or_Fax</name> <value>false</value> </option> </options> </subTerm> <subTerm> <subTermName>Additional_Rights_and_Restrictions</subTermName> <options> <option> <name>Loansome_Doc_Required</name> <value>false</value> </option> <option> <name>Same_Country_Only</name> <value>false</value> </option> <option> <name>Record_Keeping_Required</name> <value>false</value> </option> <option> <name>Non-Profit_Only</name> <value>false</value> </option> </options> </subTerm> </subTerms> </term> </terms> <documents> <document> <id>c2778805-81ea-4957-bdf1-14ee047e5edc</id> <dateCreated>10/31/2012 13:28:44</dateCreated> <fileName>Short Wavy Haircuts.docx</fileName> <url>unknown</url> <description>Short Wavy Haircuts.docx</description> <notes /> <includesSignature>false</includesSignature> </document> </documents> </license> </content> </entry>
DELETE a license by ID
Request:
https://beta-lman.sd00.worldcat.org/license-manager/licenses/def84811-de69-4054-8224-bbb207cf441a
Response:
Empty 200 Response
The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »
© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates
Follow the OCLC Developer Network: