Zelestra

Zelestra Standards

updateItem

The updateItem operation updates an item within a clip list.

Request

The updateItem operation requires a message that consists of a single UpdateItemRequest element.

Examples

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

XML:
<UpdateItemRequest>
  <ClipList>http://www.zelestra.com/ClipList.xml</ClipList>
  <ItemId>_257</ItemId>
  <URI>http://www.zelestra.com/kanga203.jpg</URI>
</UpdateItemRequest>

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

The UpdateItemRequest element MUST contain a ItemId element, which is the list item identifier.

The UpdateItemRequest element MAY contain a Name element, which is the item name. The value of this element overrides the name associated with the item's clip URI, if any. Maximum length is 255 characters.

The UpdateItemRequest element MAY contain a Category element, which is the item category. The value of this element overrides the category associated with the item's clip URI, if any. Maximum length is 31 characters.

The UpdateItemRequest element MAY contain a Description element, which is the item description. The value of this element overrides the description associated with the item's clip URI, if any. Maximum length is 8191 characters.

The UpdateItemRequest element MAY contain a HomePage element, which is the item home page URL. The value of this element overrides the home page associated with the item's clip URI, if any. Maximum length is 1023 characters.

The UpdateItemRequest element MAY contain a Services element, which is the item services URI. The value of this element overrides the services associated with the item's clip URI, if any. Maximum length is 1023 characters.

The UpdateItemRequest element MAY contain a URI element, which is the item clip URI. When specified, this element MAY cause (unless overriden by other specified elements) the name, category, description, home page, and services of the item to be updated from the specified clip's metadata. The URI MUST have metadata associated with it. Maximum length is 1023 characters.

The UpdateItemRequest element MAY contain a Target element, which is the item target. Maximum length is 31 characters.

The UpdateItemRequest element MAY contain an Attractor element, which is the item attractor. If no element is specified, then (0,0) is assumed.

The UpdateItemRequest element MAY contain an OnResource element, which may be set to true or false. A true value indicates that the operation is to be performed on the resource. Otherwise, the operation is performed on the instance. If no element is specified, then false is assumed.

Operation

The specified clip list item's elements are updated.

Response

The updateItem operation does not return any data.

Faults

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

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

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

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

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