Doorgaan naar de website
OCLC Support

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.

GetFile
Signature Returns

/utils/getfile/collection/alias/id/pointer/filename/name

  • alias is the collection alias
  • pointer is the pointer to the item in the collection
  • name is the file name to use when saving the file

Returns the stored file for the specified item. The call will enforce access control defined for the item.

GetImage
Signature Returns

/utils/ajaxhelper/?CISOROOT=alias&CISOPTR=pointer&action=2&
DMSCALE=scale&DMWIDTH=width&DMHEIGHT=height&
DMX=x&DMY=y&DMTEXT=text&DMROTATE=degrees

  • alias is the collection alias
  • pointer is the pointer to the item in the collection
  • scale is the percentage to scale the image
  • width is the image width in pixels
  • height is the image height in pixels
  • x is the x-coordinate of the upper-left corner of the cropped-out region
  • y is the y-coordinate of the upper-left corner of the cropped-out region
  • text is the words to be highlighted in the image. Requires bounding box information to be stored for the item; otherwise no highlighting occurs
  • degrees is the number of degrees to rotate the image

Returns a scaled and cropped image for display. The specified item must be an image.

The returned image is in JPEG format.

GetStream
Signature Returns

utils/getstream/collection/alias/id/pointer

  • alias is the collection alias
  • pointer is the pointer to the item in the collection
Plays the stream for the specified item.
GetThumbnail
Signature Returns

/utils/getthumbnail/collection/alias/id/pointer

  • alias is the collection alias
  • pointer is the pointer to the item in the collection
Returns the thumbnail for the specified item. The thumbnail is a JPEG image
of maximum dimensions 160 x 120 pixels.

 

  • Heeft dit artikel u geholpen?