LexisNexis Academic URL API Specification

From LexisNexis Academic Knowledge Center
(Difference between revisions)
Jump to: navigation, search
(Legal Cases)
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
You can create permanent links to search forms, sources, and even documents through URL API specification.  
+
LexisNexis Academic does not display durable links for each document. The URL displayed in the browser address window is not stable and should not be stored as a link. However, it is relatively easy to make a durable URL (also known as Persistent URL or PURL), and many popular links have been created by LexisNexis staff ready for your use.  
  
Note: If you're looking for quick links to search particular sources in LexisNexis Academic, many of the links are already on the wiki. Click the Academic Links category below for a list of URL API links that have already been created and posted here for you.
+
==Before You Start==
 +
The [[LexisNexis_Academic_URL_API_Specification | URL API]] allows users to build several types of URLs that are suitable for use in course syllabi, assignments, research guides, and bookmarks.
  
==Current Interface==
+
*Article-level durable links to specific full-text documents
The directions below apply to the LexisNexis Academic interface that was released January 8, 2010.  Please see the end of this page for directions related to the [[LexisNexis_Academic_URL_API_Specification#Old_Interface|Old Interface]].
+
*Source-level durable links to search within specific LexisNexis sources
 +
*URLs that function as saved searches
  
=== Download the Specification ===
+
===User Authentication===
[http://www.amdev.net/docs/LexisNexis_Academic_URL_API_Specification_ver2010.pdf]
+
See the article [[About Subscription Links]] for user authentication issues.
  
===Frequently Asked Questions===
+
===Shortcut: Lists of Links===
 +
Instead of building your own links, you may be able to simply copy the link you want from one of these sources.
 +
*See [[:Category:Academic Links]] for pages on this wiki that include lists of links.
 +
*Go to http://www.delicious.com/lnacademic to see our Delicious bookmarks, including topical and geographic lists.
 +
 
 +
==Resources==
 +
===URL API Specification===
 +
Download the URL API Specification. [http://www.amdev.net/docs/LexisNexis_Academic_URL_API_Specification_ver2010.pdf Click here for .pdf]
 +
 
 +
===Tools===
 +
A wizard type tool for creating the links described below is available in Beta release on our site for [http://www.amdev.net Subscriber Tools]
 +
 
 +
===Direct Link To Search Any Source===
 +
See the article on [[Finding a Source CSI]]
 +
 
 +
==Examples==
 +
For more examples and complete descriptions of these types of links, please download and read the URL API Specification provided above.
 +
 +
===Document-Level Links===
 +
Run a search that retrieves a specific document.<br/>
 +
====News and Periodical Documents====
 +
The link must use the constant source identifier (CSI) for the particular publication.
 +
'''Example:''' Link to an article in Chronicle of Higher Education <br/>
 +
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=171267&sr=BYLINE(Lila+w/3+Guterman)+AND+HLEAD(Journal+Eases+AND+Policy)+AND+DATE+IS+June+28+2002
 +
 
 +
====Legal Cases====
 +
All links to U.S. Federal and State legal cases can use the constant source identifier (CSI) for the U.S. and State Cases combined source. The CSI is 6496. Use the "CITE" segment to search for the legal citation in standard [[Legal_Citation_Formats | legal citation format]]. '''Example:''' Link to U.S. Supreme Court decision Brown v. Board of Education<br/>
 +
[http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6496&sr=CITE(347+U.S.+483) http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6496&sr=CITE(347 U.S. 483)]
 +
 
 +
===Source-Level Link===
 +
Also called "title-level links." Opens the Power Search form, with the specified source already selected and ready to search.<br/>
 +
'''Example:''' Search within the New York Times <br/>
 +
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6742
 +
 
 +
Note:  The LexisNexis A-Z Title list on the [http://www.amdev.net/rpt_std_content.php Subscriber Tools] site includes links to all individual titles. You can create a link for any source (including group sources which are not included in the A-Z Title List). All you need is the CSI (Constant Source Identifier) to add after the "csi=" part of the URL. In the New York Times example above, the CSI is 6742.
 +
 
 +
You can use the Source Directory to get CSIs. See the article on [[Finding a Source CSI]]
 +
 
 +
===Table of Contents Links===
 +
LexisNexis has created an advanced Table of Content (TOC) search form for legal materials that supports both browsing and searching. TOC view is available for 200+ sources, including the United States Code and all state codes.<br/>
 +
'''Example:''' Link to TOC view of the United States Code<br/>
 +
http://www.lexisnexis.com/hottopics/lnacademic/?verb=toc&csi=6362
 +
 
 +
Note: As with the Source-Level links, there is no need to construct your own TOC links. A list of all TOC links is available at [http://www.amdev.net/rpt_std_content.php Subscriber Tools]
 +
 
 +
===Search Form Link===
 +
Open a specific search form. See the complete list of direct links at [[Academic URLs for Search Forms]]<br/>
 +
'''Example: ''' Open the Federal and State Cases Search Form.<br/>
 +
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sf?&sfi=AC07STCseCmnSrch
 +
 
 +
===Saved Searches===
 +
Run the specified search in LexisNexis Academic<br/>
 +
'''Example:''' Finds all stories in the “Business” section of today's New York Times.<br/>
 +
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6742&sr=SECTION(business)+AND+DATE=%25CURRDATE%2
 +
 
 +
==Frequently Asked Questions==
 
   
 
   
 
What’s an “API”?
 
What’s an “API”?
Line 25: Line 82:
 
   
 
   
 
When Will My Link Resolver Work with LexisNexis Academic?
 
When Will My Link Resolver Work with LexisNexis Academic?
That depends on how quickly your provider is able to incorporate the URL API into its service.  LexisNexis is currently working with the following companies and organizations to support their link resolver systems. If your provider is not on this list, please direct them to this webpage to obtain the Specification and LexisNexis contact information.
+
That depends on whether the company or in-house team that provides your link resolver has incorporated the LexisNexis A-Z Title List and the URL API into its service.  LexisNexis is currently working with the following companies and organizations to support their link resolver systems. If your provider is not on this list, please direct them to this webpage to obtain the Specification and LexisNexis contact information.
 
<ul>
 
<ul>
 
<li>CSA</li>
 
<li>CSA</li>
Line 35: Line 92:
 
</ul>
 
</ul>
  
 +
==Terms of Use==
 +
The LexisNexis® Academic URL API Specification is subject to the following Terms of Use.
  
 +
LexisNexis provides this Specification to promote alternative means of accessing LexisNexis Academic. LexisNexis grants you a limited, personal, non-exclusive, non-transferable license to download, copy, and use this Specification subject to the following terms:
 +
#You may use the Specification to develop applications that access LexisNexis Academic via the API for use by you and third parties. You may not use the Specification for any other purpose.
 +
#Access to LexisNexis Academic requires a separate subscription and is governed by the user's applicable LexisNexis Subscription Agreement. Use of the API does not amend or supplement any such Subscription Agreement. You may only use this Specification and the API to facilitate legitimate use of LexisNexis Academic. Without limitation, you acknowledge that LexisNexis prohibits the use of scripts and other automated means of conducting multiple searches on LexisNexis Academic, and you understand that use of this Specification and the API in that manner will result in termination of this license and may also result in suspension or termination of access to LexisNexis Academic.
 +
#LexisNexis may choose to provide support to you in connection with your use of this Specification, however LexisNexis is not obligated to provide support.
 +
#LexisNexis reserves the right to change or discontinue the API and this Specification at any time without advance notice. Please refer to this web site regularly for information about updates to the Specification.
 +
#LexisNexis provides this Specification and access to LexisNexis Academic through the API on an "as is" basis, without warranty of any kind, and disclaims all express and implied warranties.
 +
#LexisNexis provides this Specification and access to the API without additional charge. Accordingly, you agree that LexisNexis will have no liability arising from or based on the use of or inability to use this Specification or the API, including without limitation consequential, incidental, or other indirect damages.
 +
#LexisNexis retains ownership of and all intellectual property rights in the Specification and the API.
 +
#These Terms state the complete agreement between you and LexisNexis concerning this Specification and your use of the API.
  
===Examples===
+
It is the policy of LexisNexis to improve its products and services as new technology and content become available. LexisNexis therefore reserves the right to change these specifications without prior notice.
If you are an authorized user currently connected to your institution’s network, you should be able to try out the three different function by below by clicking on the URLs below.
+
+
'''Document-Level Link''' <br/>
+
Link to an article in Chronicle of Higher Education <br/>
+
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=171267&sr=BYLINE(Lila+w/3+Guterman)+AND+HLEAD(Journal+Eases+AND+Policy)+AND+DATE+IS+June+28+2002
+
  
'''Source-Level (aka "Title-Level") Link'''  <br/>
 
Search within the New York Times <br/>
 
http://www.lexisnexis.com/us/lnacademic/api/version1/sf?shr=t&sfi=AC00NBGenSrch&csi=6742
 
 
'''Search Form Link'''  <br/>
 
Open the Federal and State Cases Search Form. See also the complete list of [[Academic URLs for Search Forms]]  <br/>
 
http://www.lexisnexis.com/us/lnacademic/api/version1/sf?shr=t&sfi=AC07STCseCmnSrch
 
 
 
 
Return back to the [[Academic]] page.
 
  
 
[[Category: Academic Links]]
 
[[Category: Academic Links]]
Line 60: Line 112:
 
[[Category: FAQ]]
 
[[Category: FAQ]]
 
[[Category: Instruction Tools]]
 
[[Category: Instruction Tools]]
 
==URL Update Guide==
 
Please see the [[Migration Guide]] article for an explanation of your options for moving to the new interface.  Please note that it is not absolutely necessary for your institution to do anything other than test its access to the new interface. At the end of the migration period in summer 2010, all URLs pointing to the old interface will be automatically redirected to point to the new interface.  This the deep links to specific search forms, sources, and documents.
 
 
Subscribing institutions that wish to begin using the new interface before the end of the migration period will need to update the URL for the product home page.  They will also have the option of updating their deep links to point to the new interface as well.  Some subscribers may choose to point to the new interface for general use without updating their deep links.  This is perfectly reasonable approach. Other subscribers may prefer to update their deep links to make a complete transition to the new interface and avoid adding an extra redirect jump in the user's connection to LexisNexis Academic.
 
 
===Updating Links to the Home Page and Specific Search Forms===
 
The basic URL for the new interface is http://www.lexisnexis.com/hottopics/lnacademic/ which will open the product home page. Direct links to each search form in the new interface are listed in the article on [[Academic_URLs_for_Search_Forms]]
 
 
===Updating Source-Level Links===
 
Links to specific sources, sometimes referred to as Title-Level Links or Journal-Level Links, can be updating using the migration spreadsheet or the find and replace rules listed below.
 
 
====Migration Spreadsheet====
 
This spreadsheet lists each source in the December 2009 version of the A-Z List, with the URL for the source-level link to the old interface and corresponding URL for the new interface.  The list is intended to be used as an input for a batch update process. 
 
 
*
 
 
 
 
 
*Do nothing.  All links into the old interface will be automatically redirected to the new interface in summer 2010.  Deep links to specific search forms, sources, and documents will all be redirected. As a fail-safe, deep links that cannot be successfully translated to the new interface will take the user to the home page of the new interface.
 
*Use the A-Z Migration spreadsheet to update your records.  This spreadsheet contains the old version of the URL and new version of the URL for l
 
 
==Old Interface==
 
The directions below apply to the older version of the LexisNexis Academic interface which will be phased out in summer 2010.
 
 
=== Download the Specification ===
 
 
[http://www.amdev.net/docs/LexisNexisAcademicURLAPISpecification2007_12_12.pdf PDF 97K]
 
 
 
===Frequently Asked Questions===
 
 
What’s an “API”?
 
The acronym stands for “application programming interface.” It’s a mechanism that allows programmers to call functions within another application. In this case, you will be constructing a URL rather than writing a computer program. The application you will send instructions to is the LexisNexis Academic service itself, and you will be able to call the following three functions.
 
 
<ul>
 
<li>Document-level link – retrieves a specific document.</li>
 
<li>Source-level link – opens the Power Search form and populates the source selection options to facilitate user-initiated searching of a specific source.</li>
 
<li>[[Academic URLs for Search Forms]]– open any search form in LexisNexis Academic.</li>
 
</ul>
 
The URL API is also used to support third-party vendors who provide article linking and federated search software to academic libraries. The developers of these systems can use the API to link authorized user automatically to full text documents in the LexisNexis Academic service. In the case of link resolvers, the required document is identified from a citation in a source database and, once LexisNexis Academic is identified as an appropriate target database, the API is used to deliver the full text document. Federated search services can use the API in a similar way, to link from a citation in their results list to the full-text document in LexisNexis Academic.
 
 
Do I Have To Install Anything?
 
No. The URL API Specification simply provides directions for constructing URLs. The API does all the work of interpreting these URLs within LexisNexis Academic.
 
 
===Examples===
 
If you are an authorized user currently connected to your institution’s network, you should be able to try out the three different function by below by clicking on the URLs below.
 
 
'''Document-Level Link''' <br/>
 
Link to an article in Chronicle of Higher Education <br/>
 
http://www.lexisnexis.com/us/lnacademic/api/version1/sr?shr=t&csi=171267&sr=BYLINE(Guterman)+AND+HLEAD(Journal+Eases+AND+Policy)+AND+DATE+IS+June+28+2002
 
 
'''Source-Level (aka "Title-Level") Link'''  <br/>
 
Search within the New York Times <br/>
 
http://www.lexisnexis.com/us/lnacademic/api/version1/sf?shr=t&sfi=AC00NBGenSrch&csi=6742
 
 
'''Search Form Link'''  <br/>
 
Open the Federal and State Cases Search Form. See also the complete list of [[Academic URLs for Search Forms]]  <br/>
 
http://www.lexisnexis.com/us/lnacademic/api/version1/sf?shr=t&sfi=AC07STCseCmnSrch
 

Latest revision as of 08:41, 4 January 2011

LexisNexis Academic does not display durable links for each document. The URL displayed in the browser address window is not stable and should not be stored as a link. However, it is relatively easy to make a durable URL (also known as Persistent URL or PURL), and many popular links have been created by LexisNexis staff ready for your use.

Contents

[edit] Before You Start

The URL API allows users to build several types of URLs that are suitable for use in course syllabi, assignments, research guides, and bookmarks.

  • Article-level durable links to specific full-text documents
  • Source-level durable links to search within specific LexisNexis sources
  • URLs that function as saved searches

[edit] User Authentication

See the article About Subscription Links for user authentication issues.

[edit] Shortcut: Lists of Links

Instead of building your own links, you may be able to simply copy the link you want from one of these sources.

[edit] Resources

[edit] URL API Specification

Download the URL API Specification. Click here for .pdf

[edit] Tools

A wizard type tool for creating the links described below is available in Beta release on our site for Subscriber Tools

[edit] Direct Link To Search Any Source

See the article on Finding a Source CSI

[edit] Examples

For more examples and complete descriptions of these types of links, please download and read the URL API Specification provided above.

[edit] Document-Level Links

Run a search that retrieves a specific document.

[edit] News and Periodical Documents

The link must use the constant source identifier (CSI) for the particular publication. Example: Link to an article in Chronicle of Higher Education
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=171267&sr=BYLINE(Lila+w/3+Guterman)+AND+HLEAD(Journal+Eases+AND+Policy)+AND+DATE+IS+June+28+2002

[edit] Legal Cases

All links to U.S. Federal and State legal cases can use the constant source identifier (CSI) for the U.S. and State Cases combined source. The CSI is 6496. Use the "CITE" segment to search for the legal citation in standard legal citation format. Example: Link to U.S. Supreme Court decision Brown v. Board of Education
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6496&sr=CITE(347 U.S. 483)

[edit] Source-Level Link

Also called "title-level links." Opens the Power Search form, with the specified source already selected and ready to search.
Example: Search within the New York Times
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6742

Note: The LexisNexis A-Z Title list on the Subscriber Tools site includes links to all individual titles. You can create a link for any source (including group sources which are not included in the A-Z Title List). All you need is the CSI (Constant Source Identifier) to add after the "csi=" part of the URL. In the New York Times example above, the CSI is 6742.

You can use the Source Directory to get CSIs. See the article on Finding a Source CSI

[edit] Table of Contents Links

LexisNexis has created an advanced Table of Content (TOC) search form for legal materials that supports both browsing and searching. TOC view is available for 200+ sources, including the United States Code and all state codes.
Example: Link to TOC view of the United States Code
http://www.lexisnexis.com/hottopics/lnacademic/?verb=toc&csi=6362

Note: As with the Source-Level links, there is no need to construct your own TOC links. A list of all TOC links is available at Subscriber Tools

[edit] Search Form Link

Open a specific search form. See the complete list of direct links at Academic URLs for Search Forms
Example: Open the Federal and State Cases Search Form.
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sf?&sfi=AC07STCseCmnSrch

[edit] Saved Searches

Run the specified search in LexisNexis Academic
Example: Finds all stories in the “Business” section of today's New York Times.
http://www.lexisnexis.com/hottopics/lnacademic/?verb=sr&csi=6742&sr=SECTION(business)+AND+DATE=%25CURRDATE%2

[edit] Frequently Asked Questions

What’s an “API”? The acronym stands for “application programming interface.” It’s a mechanism that allows programmers to call functions within another application. In this case, you will be constructing a URL rather than writing a computer program. The application you will send instructions to is the LexisNexis Academic service itself, and you will be able to call the following three functions.

  • Document-level link – retrieves a specific document.
  • Source-level link – opens the Power Search form and populates the source selection options to facilitate user-initiated searching of a specific source.
  • Academic URLs for Search Forms– open any search form in LexisNexis Academic.

The URL API is also used to support third-party vendors who provide article linking and federated search software to academic libraries. The developers of these systems can use the API to link authorized user automatically to full text documents in the LexisNexis Academic service. In the case of link resolvers, the required document is identified from a citation in a source database and, once LexisNexis Academic is identified as an appropriate target database, the API is used to deliver the full text document. Federated search services can use the API in a similar way, to link from a citation in their results list to the full-text document in LexisNexis Academic.

Do I Have To Install Anything? No. The URL API Specification simply provides directions for constructing URLs. The API does all the work of interpreting these URLs within LexisNexis Academic.

When Will My Link Resolver Work with LexisNexis Academic? That depends on whether the company or in-house team that provides your link resolver has incorporated the LexisNexis A-Z Title List and the URL API into its service. LexisNexis is currently working with the following companies and organizations to support their link resolver systems. If your provider is not on this list, please direct them to this webpage to obtain the Specification and LexisNexis contact information.

  • CSA
  • Ex Libris/SFX
  • OCLC Openly Informatics
  • OhioLINK
  • Serials Solutions
  • TDNet

[edit] Terms of Use

The LexisNexis® Academic URL API Specification is subject to the following Terms of Use.

LexisNexis provides this Specification to promote alternative means of accessing LexisNexis Academic. LexisNexis grants you a limited, personal, non-exclusive, non-transferable license to download, copy, and use this Specification subject to the following terms:

  1. You may use the Specification to develop applications that access LexisNexis Academic via the API for use by you and third parties. You may not use the Specification for any other purpose.
  2. Access to LexisNexis Academic requires a separate subscription and is governed by the user's applicable LexisNexis Subscription Agreement. Use of the API does not amend or supplement any such Subscription Agreement. You may only use this Specification and the API to facilitate legitimate use of LexisNexis Academic. Without limitation, you acknowledge that LexisNexis prohibits the use of scripts and other automated means of conducting multiple searches on LexisNexis Academic, and you understand that use of this Specification and the API in that manner will result in termination of this license and may also result in suspension or termination of access to LexisNexis Academic.
  3. LexisNexis may choose to provide support to you in connection with your use of this Specification, however LexisNexis is not obligated to provide support.
  4. LexisNexis reserves the right to change or discontinue the API and this Specification at any time without advance notice. Please refer to this web site regularly for information about updates to the Specification.
  5. LexisNexis provides this Specification and access to LexisNexis Academic through the API on an "as is" basis, without warranty of any kind, and disclaims all express and implied warranties.
  6. LexisNexis provides this Specification and access to the API without additional charge. Accordingly, you agree that LexisNexis will have no liability arising from or based on the use of or inability to use this Specification or the API, including without limitation consequential, incidental, or other indirect damages.
  7. LexisNexis retains ownership of and all intellectual property rights in the Specification and the API.
  8. These Terms state the complete agreement between you and LexisNexis concerning this Specification and your use of the API.

It is the policy of LexisNexis to improve its products and services as new technology and content become available. LexisNexis therefore reserves the right to change these specifications without prior notice.