TNS Internal:NDR/API/3.0/lists

From NSDLWiki

Jump to: navigation, search

Contents

[hide]

List Type Annotations

List Oriented Annotations

  • List of Resource, Collections, etc.
  • Top 5
  • Pathways Top 10 for a Subject
  • My Favorites
  • Blacklist


API

API Call Inputs Processing Outputs Purpose/Comments

Lists

CreateList
  • name
  • <optional> List identifier - assigned generated handle if missing
  • Creates an Aggregator
  • returns identifier if successful (which is generated handle if identifier is not passed in)
  • returns error if identifier is not unique
  • may return general error if add fails
DeleteList
  • List identifier
  • SUCCESS
  • FAIL
AddToList
  • List identifier
  • handle/identifier to object to add to list
  • Establishes a relationship (name TBA) between List aggregator and object
  • SUCCESS
  • FAIL
RemoveFromList
  • List identifier
  • handle/identifier to object to remove from list
  • Removes the relationship (name TBA) between List aggregator and object
  • SUCCESS
  • FAIL
Personal tools