2.2.4.3 BaseRequestContract

Namespace: http://schemas.datacontract.org/2004/07/Microsoft.Office.Visio.Server.GraphicsServer

The BaseRequestContract complex type contains information used to specify the request parameters for a protocol server operation to retrieve a VGSFF web drawing.

 <xs:complexType name="BaseRequestContract" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" name="DataSources" nillable="true" type="q1:ArrayOfAddonDataSource"/>
     <xs:element minOccurs="0" name="DisableRefresh" type="xs:boolean"/>
     <xs:element minOccurs="0" name="FileUri" nillable="true" type="xs:anyURI"/>
     <xs:element minOccurs="0" name="PageNumber" type="xs:int"/>
     <xs:element minOccurs="0" name="TimeLastModified" type="xs:dateTime"/>
   </xs:sequence>
 </xs:complexType>

DataSources:  An ArrayOfAddonDataSource element (section 2.2.4.2) that specifies the data providers implemented by a protocol client, and used in the web drawing. If there are no data providers, DataSources MUST have zero child elements. If DataSources has child elements, the Data field of each AddonDataSource element (section 2.2.4.1) MUST NOT be null.

DisableRefresh: A Boolean that specifies whether the requested drawing page (section 1.3.2) is refreshed by the protocol server. A value of "true" indicates that the returned drawing page is not refreshed; a value of "false" indicates that the returned drawing page is refreshed. There MUST be exactly one instance of this element.

FileUri: An anyURI element that specifies the URL of the file in a document repository that contains the VGSFF web drawing being requested. There MUST be exactly one instance of this element, and it MUST NOT be null.

PageNumber: An integer that specifies the one-based index of a drawing page in the web drawing. It MUST be greater than zero and less than or equal to the total number of drawing pages (section 1.3.2) in the requested web drawing.  There MUST be exactly one instance of this element.

TimeLastModified: An optional dateTime element that specifies the date and time, in Coordinated Universal Time (UTC) format, when the file in a document repository that contains the VGSFF web drawing, was last modified. If the attribute is present, there MUST be exactly one instance of this element.