Share via

3.1.4.1 GetItem

  • Article

The GetItem operation retrieves content and metadata for a file that is stored in a source location.

 <wsdl:operation name="GetItem">
     <wsdl:input message="tns:GetItemSoapIn" />
     <wsdl:output message="tns:GetItemSoapOut" />
 </wsdl:operation>

The protocol client sends a GetItemSoapIn request message (section 3.1.4.1.1.1) and the protocol server responds with a GetItemSoapOut response message (section 3.1.4.1.1.2) as follows:

  • The protocol client prepares a request with the source location to retrieve content and metadata for the file.

  • The protocol server receives the request and provides the content and metadata for the file specified in the source location.

The protocol server returns results based on the following conditions:

  • If the source location URL is in an invalid format, the protocol server MUST report a SOAP exception.<3>

  • If the source location points to a different server or uses a different HTTP or HTTPS protocol, the protocol server MUST report a SOAP exception.

  • If the source location does not point to an existing file on the protocol server, the protocol server MUST omit the Fields and Stream elements in the GetItemResponse element (section 3.1.4.1.2.2).

  • If the protocol server implements permission settings for files and the file at the source location cannot be read based on the permission settings for the file, the protocol server MUST report a failure by using HTTP Status-Code 401 Unauthorized, as defined in [RFC2616].

  • If the source location points to an existing file in the source location and the file can be read based on the permission settings for the file, the source location MUST return the content and metadata of the file.