3.1.4.4.2.1 GetData

  • 2 minutes to read

The GetData element specifies the input data for the GetData WSDL operation.

 <xs:element name="GetData" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexType>
     <xs:sequence>
       <xs:element xmlns:tns="http://schemas.microsoft.com/office/Access/2010/11/Server/WebServices/AccessServerInternalService/" minOccurs="0" name="parameter" nillable="true" type="tns:CommandParameter"/>
       <xs:element minOccurs="0" name="cacheId" nillable="true" type="xs:string"/>
       <xs:element minOccurs="0" name="startRowIndex" type="xs:int"/>
       <xs:element minOccurs="0" name="rowKey" type="xs:int"/>
       <xs:element minOccurs="0" name="maximumRows" type="xs:int"/>
       <xs:element xmlns:tns1="http://schemas.datacontract.org/2004/07/Microsoft.Office.Access.Services.Data" minOccurs="0" name="cacheCommands" type="tns1:CacheCommands"/>
       <xs:element minOccurs="0" name="sortExpression" nillable="true" type="xs:string"/>
       <xs:element xmlns:tns6="http://schemas.datacontract.org/2004/07/Microsoft.Office.Access.SharedClient" minOccurs="0" name="filter" nillable="true" type="tns6:FilterInfo"/>
       <xs:element minOccurs="0" name="userCookieId" type="ser:guid"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

parameter: A CommandParameter, as specified by section 2.2.4.3. MUST be present.

cacheId:  cacheId uniquely identifies a result set in the cache.

startRowIndex: An int ([XMLSCHEMA2] section 3.3.17) that specifies the index of the first row to return from the result set.

  • MUST be nonnegative.

  • MUST be less than the total number of rows in the result set.

rowKey: An int ([XMLSCHEMA2] section 3.3.17) that specifies the value of the primary key of a record from the result set. The protocol server uses this value to identify the record from the result set, which needs to be refreshed.

  • If cacheCommands contains RefreshData, MUST NOT be less than zero.

maximumRows: An int ([XMLSCHEMA2] section 3.3.17) that specifies the maximum number of rows to return.

  • MUST be greater than zero.

  • If cacheCommands contains RetrieveImage, MUST be "1".

  • If cacheCommands contains RefreshData, MUST be "1".

cacheCommands: A CacheCommands (section 2.2.5.7) that specifies a list of actions to perform on the result set. If both ApplyFilter and ClearFilter are specified, the protocol server MUST return a SOAP fault, as specified by section 3.1.4.4.

sortExpression: A string ([XMLSCHEMA2] section 3.2.1) that specifies the sort order to apply to the result set. If cacheCommands contains ApplySort:

  • MUST be present.

  • MUST contain a CT_AdHocOrdering, as specified by [MS-AXL2] section 2.2.3.5.

The protocol server MUST ignore this element if cacheCommands does not contain ApplySort.

filter: A FilterInfo (section 2.2.4.8) that specifies the filter criteria to apply to the result set. The protocol server MUST ignore this element if cacheCommands does not contain ApplyFilter.

userCookieId: A guid (section 2.2.5.11) that specifies an identifier for the operation. MUST be present. SHOULD be ignored by the protocol server.