CONTENTdm® Online Help — Version 6
  Project
Client
  Compound
Objects
  Using
Collections
  Customizing
Website
  Server
Admin
  Collection
Admin
  Item
Admin
  Add Ons  
Topics
 

» Website Overview

» Configuring the Website

» Other Customizations

» About URLS

» Adding Stop Words

Glossary
Site Map
Contact Us
Tutorials
User Support Center
Support FAQs

PreviousNext
CONTENTdm API Reference

Overview

dmwebservices is a simple wrapper around the CONTENTdm Server API functions, with a few exceptions to improve error handling. A few additional API functions are handled by the utils controller on the CONTENTdm Website instead of by dmwebservices on the CONTENTdm Server. For more information, see the CONTENTdm Website API Reference below.

dmwebservices provides an interface to the CONTENTdm Server API functions, in the form:

http://CdmServer.com:port/dmwebservices/index.php?q=function/param1/param2/format
function
One of the CONTENTdm Server API functions.

param1, param2, and so on

Function-specific parameters documented in each function's Help. The number of parameters varies.

format

Either xml or json.

Note: There are some additional requirements when calling a CONTENTdm Server that is hosted by
CONTENTdm Hosting Services:
1. The Server URL must use "https://", not "http://".
2. Do not use a port number (":81") with the Server URL.
3. Do not use the loopback interface ("localhost") in place of the Server URL.
For details please see:
http://www.contentdm.org/USC/blog/blogs/blog4.php/2013/05/02/customization-updates-required-for-contentdm-server-urls

 

CONTENTdm Server API Functions — dmwebservices

application-level functions

server-level functions

collection-level functions

item-level functions

 

CONTENTdm Website API Reference — utils

The following API functions are handled by the utils controller on the CONTENTdm Website, instead of by dmwebservices on the CONTENTdm Server. The utils functions return binary data, where the dmwebservices functions return text in XML or JSON format. These functions also differ in that utils calls are relative to the URL of the CONTENTdm Website, but dmwebservices calls are absolute, requiring the full URL of the CONTENTdm Server.


Return to top of page

PreviousNext

CONTENTdm® is a registered trademark of OCLC
© 1997-2014 OCLC. All Rights Reserved