3.1.4.4.3.2 GetAppInfoResult

  • Article

Namespace: http://schemas.microsoft.com/office/Access/2010/11/Server/WebServices/ApplicationDesignService

Specifies information about a database application.

 <xs:complexType name="GetAppInfoResult" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:ServiceResult">
       <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="Collation" type="tns:Collation"/>
         <xs:element minOccurs="0" maxOccurs="1" name="NewObjects" type="tns:AccessObjectList"/>
         <xs:element minOccurs="0" maxOccurs="1" name="UpdatedObjects" type="tns:AccessObjectList"/>
         <xs:element minOccurs="0" maxOccurs="1" name="DeletedObjects" type="tns:IDList"/>
       </xs:sequence>
       <xs:attribute name="ProtocolVersion" type="xs:string"/>
       <xs:attribute name="Name" type="xs:string"/>
       <xs:attribute name="AlternateUrl" type="xs:string"/>
       <xs:attribute name="Title" type="xs:string"/>
       <xs:attribute name="DatabaseName" type="xs:string"/>
       <xs:attribute name="DataServerName" type="xs:string"/>
       <xs:attribute name="ApplicationCulture" type="xs:string"/>
       <xs:attribute name="RequestIPAddress" type="xs:string"/>
       <xs:attribute name="IsDataMacroTracingOn" type="xs:boolean" use="required"/>
       <xs:attribute name="IsUserConnectionAllowed" type="xs:boolean" use="required"/>
       <xs:attribute name="IsFirewallRestricted" type="xs:boolean" use="required"/>
       <xs:attribute name="IsDataConnectivitySupported" type="xs:boolean" use="required"/>
       <xs:attribute name="IsSendEmailSupported" type="xs:boolean" use="required"/>
       <xs:attribute name="PackageAppTitle" type="xs:string"/>
       <xs:attribute name="PackageAppVersion" type="xs:string"/>
       <xs:attribute name="PackageIsLocked" type="xs:boolean" use="required"/>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

Collation: A Collation (section 3.1.4.4.3.3) element that specifies collation information about the backend database specified by DatabaseName and DataServerName. MUST be present.

NewObjects: An AccessObjectList (section 2.2.4.3) element that fully specifies a set of objects. MUST be present. This list MUST include all objects in the application that were not present in the KnownObjects element of the GetApplicationInformationParameters that was sent in the request from the protocol client. If there are no objects in the application that were not present in KnownObjects, then this element MUST NOT have child elements.

UpdatedObjects: An AccessObjectList (section 2.2.4.3) element that fully specifies a set of objects. MUST be present. This list MUST include all objects in the application that were present in the KnownObjects of the GetApplicationInformationParameters that was sent in the request from the protocol client, but which had a different version than the protocol client specified in the Version attribute of the ObjectIdentity element that had the same ID. If there are no objects in the application that were present in KnownObjects but now have a different version, then this element MUST NOT have child elements.

DeletedObjects: An IDList (section 3.1.4.4.3.5) element that specifies a set of objects. MUST be present. This list MUST include all objects that were present in the KnownObjects of the GetApplicationInformationParameters (section 3.1.4.4.3.1) that was sent in the request from the protocol client, but which are not present in the protocol server. If all objects in the application that were present in KnownObjects are also present in the protocol server, then this element MUST NOT have child elements.

ProtocolVersion: An Access Services Protocol Version ([MS-ASDT] section 3.1.1.1) token that specifies the best match between the versions supported by the protocol client and the version of the application on the protocol server, as determined by the protocol server implementation. MUST be one of the values in the ProtocolVersionOptions of the GetApplicationInformationParameters that is sent with the request from the protocol client. MUST also be one of the values that would be returned by the protocol server from a call to GetServerInformation ([MS-ASDT] section 3.1.4.2) in the AcceptedProtocolVersions of a GetServerInfoResult ([MS-ASDT] section 3.1.4.2.3.1). MUST be present.

Name: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the name of the application. MUST be present.

AlternateUrl: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies an alternate Uniform Resource Locator (URL) for accessing the application. MUST be present.

Title: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the title of the application. MUST be present.

DatabaseName: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the name of the backend database that contains the application. The database is located on the server specified by DataServerName. MUST be present.

DataServerName: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the name of the server on which the database specified by DatabaseName resides. MUST be present.

ApplicationCulture: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the culture name of the application. MUST be formatted as specified by [RFC4646]. MUST be present.

RequestIPAddress: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the IP address from which the protocol server received the GetApplicationInformation request. MUST be either an IPv6 address in string format ([RFC4291] section 2.2) or an IPv4 address in string format ([RFC1123] section 2.1). MUST be present.

IsDataMacroTracingOn: A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether data macro tracing (section 3.1.4.7) is enabled in the application. MUST be present.

IsUserConnectionAllowed: A boolean ([XMLSCHEMA2] section 3.2.2) attribute. MUST be present. MUST be ignored.

IsFirewallRestricted: A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether connections to the application are restricted by a firewall on the server. MUST be present.

IsDataConnectivitySupported: A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether external connections to the application are enabled. MUST be present.

IsSendEmailSupported: A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the SendEmail data macro action is enabled in the application. MUST be present.

PackageAppTitle: A string ([XMLSCHEMA2] section 3.2.1) attribute that specifies the title of the application package. MUST be present. If CreatePackage (section 3.1.4.2) has been called on this application with Option deployment, this MUST be the Title value stored during the most recent call of that type. Otherwise, it MUST be empty.

PackageAppVersion:  A string ([XMLSCHEMA2] section 3.2.1) that specifies the version of the application package. MUST be present. If CreatePackage (section 3.1.4.2) has been called on this application with Option deployment, this MUST be the AppVersion value stored during the most recent call of that type. Otherwise, it MUST be empty.

PackageIsLocked: A boolean ([XMLSCHEMA2] section 3.2.2) that specifies whether customization of the application package is disabled. MUST be present. If CreatePackage (section 3.1.4.2) has been called on this application with Option deployment, this MUST be the IsLocked value stored during the most recent call of that type. Otherwise, it MUST be false.