getLibraryItemRequest

Returns the document and version from the specified library. The library ID and document number are required. The version number is optional.

Request

<getLibraryItemRequest>
   <library type="types:uid"/>
   <documentNumber type="unsignedInt"/>
   <versionNumber type="string"/>
</getLibraryItemRequest>

Response

<getLibraryItemResponse>
   <item type="types:Item"/>
   <status type="types:Status"/>
</getLibraryItemResponse>

Elements

library

Specifies the library ID for the document and version.

documentNumber

Specifies the the document number.

versionNumber

Specifies the the version number. To get a version of a document, the document number is required:

  • current

  • official

  • a specific version number

item

Specifies the document details.

code

Returns the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Example

<getLibraryItemRequest> 
   <library>domain1.po1.po1 Library@67</library> 
   <documentNumber>5</documentNumber> 
   <versionNumber>current</versionNumber> 
</getLibraryItemRequest>

<getLibraryItemResponse> 
   <item type="version"> 
      <id>domain1.po1.po1 Library:5:1@69</id> 
      <version>3</version> 
      <container>domain1.po1.po1 Library:5@67</container> 
      <created>2012-09-13T10:45:49Z</created> 
      <library> 
         <displayName>po1 Library</displayName> 
         <email>po1 Library@phantom.com</email> 
      </library> 
      <documentNumber>5</documentNumber> 
      <versionCreator> 
         <displayName>u1</displayName> 
         <email>u1@phantom.com</email> 
         <uuid>1DEB6970-175B-0000-890F-6E00D5004E00</uuid> 
      </versionCreator> 
      <retrievedBy> 
         <displayName>u1</displayName> 
         <email>u1@phantom.com</email> 
         <uuid>1DEB6970-175B-0000-890F-6E00D5004E00</uuid> 
      </retrievedBy> 
      <retrievedDate>2012-09-13T10:45:50Z</retrievedDate> 
      <versionNumber>1</versionNumber> 
      <versionDescription>Original</versionDescription> 
      <versionStatus>available</versionStatus> 
      <life>0</life> 
      <ageAction>archive</ageAction> 
      <fileSize>2212871</fileSize> 
      <filename>zip</filename> 
   </item> 
   <status> 
      <code>0</code> 
   </status> 
</getLibraryItemResponse>