Zelestra

Zelestra Standards

retrieveItem

The retrieveItem operation retrieves an item from a clip list.

Request

The retrieveItem operation requires a message that consists of a single RetrieveItemRequest element.

Examples

URL Encoded:
clipList=http://www.zelestra.com/ClipList.xml&itemclass=_257

XML:
<RetrieveItemRequest>
  <ClipList>http://www.zelestra.com/ClipList.xml</ClipList>
  <ItemId>_257</ItemId>
</RetrieveItemRequest>

The RetrieveItemRequest element MUST contain a ClipList element, which is the URI of a clip list.

The RetrieveItemRequest element MUST contain an ItemId element, which is the item identifier.

Operation

The specified item is retrieved from the specified clip list.

Response

The retrieveItem operation returns a message that consists of a single RetrieveItemResponse element.

Examples

JSON:
{"id":"_257","name":"Kangaroos","category":"image","description":"A picture of some kangaroos","uri":"http://www.zelestra.net/images/kanagaroos.jpg"}

XML:
<RetrieveItemResponse xml:class="_257">
  <Name>Kangaroos</Name>
  <Category>image</Category>
  <Description>A picture of some kangaroos</Description>
  <URI>http://www.zelestra.net/images/kanagaroos.jpg</URI>
</RetrieveItemResponse>

The RetrieveItemResponse element is defined as a ClipType.

Faults

The retrieveItem operation may return an badRequest fault if any of the request parameters are invalid.

The retrieveItem operation may return an forbidden fault if the requestor does not have the appropriate permission.

The retrieveItem operation may return an notFound fault if the specified clip list or item does not exist.

The retrieveItem operation may return an unauthorized fault if the requestor has not previously authenticated.

The retrieveItem operation may return an operationFailed fault if the service was unable to otherwise fulfill the request.