Add to the API Call's URLCustomize the CSSExpandable/Collapsible Subject MenuAdd Stripes to Rows
This is the "Add to the API Call's URL" page of the "Widgets & API Utility in LibGuides & LibGuides CMS (v1)" guide.
Alternate Page for Screenreader Users
Skip to Page Navigation
Skip to Page Content

Widgets & API Utility in LibGuides & LibGuides CMS (v1)  

Learn more about widgets and API calls available in LibGuides & LibGuides CMS.
Last Updated: Mar 21, 2015 URL: http://help.springshare.com/guidewidgets Print Guide RSS UpdatesEmail Alerts

Add to the API Call's URL Print Page
  Search: 
 
 

Adding More to the API URL

You have your API call...but you want to do more! Well, this section is for you.

Each of the items below are items you can add to the code you get from the API Utility. The table below does not have any of the items you choose from on the API Utility screen.

API Call:Addition/Modification to URLDescription
Lists of Guides/Pages API &proxy=true Adds proxy prefix (defined in system settings) to the beginning of any links in the output.
&search=sociology|social_work
Separate tags with | (pipe character).
Search across multiple tags at once.
You can also do this on the API screen - just add the pipe delimited tags to the search box.
&type=titlesearch Searches the guide title vs. the whole guide for matches.
Find type=guides in the URL and replace it with type=titlesearch.
&menutext=Please+make+a+selection... Sets the text of the first option if you choose the dropdown option for the list.
&noauto=1 Adds a "Go" button next to the dropdown list. Users must click this button to get to the guide.
&pf=true Links point to the printer friendly version of the guide.
&gid=n
&gid=x,y,z
Returns guides from that group / those groups. (LibGuides CMS only)
Find group IDs: head to Admin Stuff > Groups - the group IDs are in the left column.
Lists of Subjects API &iid=1,2,3
FAQ: Finding iids
Returns subject lists across multiple sites.
&exclude_ids=1,2,3 Excludes certain subjects, by category ID.
Find category IDs: go to http://yourlibguidessite/cat.php and click on a subject; note the cid in the URL.
&limit=5 Limits the number of subjects that are returned.
&more=true Display the "More Results" link.
&menutext=Please+make+a+selection... Sets the text of the first option if you choose the dropdown option for the list.
&noauto=1 Adds a "Go" button next to the dropdown list. Users must click this button to get to the subject info.
&target=_self Opens windows in the same window vs. a new window (which is the default).
&gid=n
&gid=x,y,z
Returns subjects from that group / those groups. (LibGuides CMS only)
Lists of Users API &iid=1,2,3
FAQ: Finding iids
Returns user lists across multiple sites.
&limit=5 Limits the number of users that are returned.
&more=true Display the "More Results" link.
&menutext=Please+make+a+selection... Sets the text of the first option if you choose the dropdown option for the list.
&noauto=1 Adds a "Go" button next to the dropdown list. Users must click this button to get to the user's profile page.
&target=_self Opens windows in the same window vs. a new widow (which is the default).
&gid=n
&gid=x,y,z
Returns users who have published guides in that group / those groups. (LibGuides CMS only)
Search Box API

&icon=off

Removes the LibGuides icon.
&size=n Changes the size of the text box
&css=0 Removes the default API stylesheet (add to end of http://api.libguides.com/css/libguides_api.css )
&target=_self Search results display in the same window. (New window is the default).

&btntext=Search+Guides

Changes the search button text
&gid=n Searches only that group. (LibGuides CMS only)
Content Box API &css=0 Removes the link to the default API stylesheet.
Tag Cloud API &pid=101296 Returns the tags from one guide (vs. your whole site, which is the default).
&gid=n
&gid=x,y,z
Returns tags from only that group / those groups. (LibGuides CMS only)
Description

Loading  Loading...

Tip