The addItem operation adds a new item to a clip list.
The addItem operation requires a message that consists of a single AddItemRequest element.
Examples
URL Encoded:
clipList=http://www.zelestra.com/ClipList.xml&name=Kangaroos&category=image&uri=http://www.zelestra.com/kanga203.jpg
XML:
<AddItemRequest>
<ClipList>http://www.zelestra.com/ClipList.xml</ClipList>
<Name>Kangaroos</Name>
<Category>image</Category>
<URI>http://www.zelestra.com/kanga203.jpg</URI>
</AddItemRequest>
The AddItemRequest element MUST contain a ClipList element, which is the URI of a clip list.
The AddItemRequest element MAY contain a Name element, which is the item name. The value of this element overrides the name associated with the clip specified by the Uri element, if any. Maximum length is 255 characters.
The AddItemRequest element MAY contain a Category element, which is the item category. The value of this element overrides the category associated with the clip specified by the Uri element, if any. Maximum length is 31 characters.
The AddItemRequest element MAY contain a Description element, which is the item description. The value of this element overrides the description associated with the clip specified by the Uri element, if any. Maximum length is 8191 characters.
The AddItemRequest 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 clip specified by the Uri element, if any. Maximum length is 1023 characters.
The AddItemRequest element MAY contain a Services element, which is the item services URI. The value of this element overrides the services associated with the clip specified by the Uri element, if any. Maximum length is 1023 characters.
The AddItemRequest element MAY contain a URI element, which is the item clip URI. The URI MUST have metadata associated with it. Maximum length is 1023 characters.
The AddItemRequest element MAY contain a Parent element, which is an item identifier reference which is the logical parent of this element. Maximum length is 31 characters.
The AddItemRequest element MAY contain a Target element, which is the item target. Maximum length is 1023 characters.
The AddItemRequest element MAY contain an Attractor element, which is the item attractor. If no element is specified, then (0,0) is assumed.
The AddItemRequest 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.
The item is added to the specified clip list.
The addItem operation returns a message that consists of a single AddItemResponse element.
Examples
JSON:
"_257"
XML:
<AddItemResponse>
<ItemId>_257</ItemId>
</AddItemResponse>
The AddItemResponse element MUST contain an ItemId element. This element is the item identifier for the newly added item.
The addItem operation may return an badRequest fault if any of the request parameters are invalid.
The addItem operation may return an forbidden fault if the requestor does not have the appropriate permission.
The addItem operation may return an notFound fault if the specified clip list does not exist.
The addItem operation may return an unauthorized fault if the requestor has not previously authenticated.
The addItem operation may return an operationFailed fault if the service was unable to otherwise fulfill the request.