[MS-ADS]: Access Services Data Server Protocol. Intellectual Property Rights Notice for Open Specifications Documentation

Transcription

1 [MS-ADS]: Intellectual Property Rights Notice for Open Specifications Documentation Technical Documentation. Microsoft publishes Open Specifications documentation ( this documentation ) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation. Patents. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting iplg@microsoft.com. License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map. Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit Fictitious Names. The example companies, organizations, products, domain names, addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, address, logo, person, place, or event is intended or should be inferred. Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. Support. For questions and support, please contact dochelp@microsoft.com. 1 / 127

2 Revision Summary Date Revision History Revision Class Comments 7/13/ Major Initial Availability 8/28/ Editorial Revised and edited the technical content 11/6/ Editorial Revised and edited the technical content 2/19/ Major Updated and revised the technical content 3/31/ Editorial Revised and edited the technical content 4/30/ Editorial Revised and edited the technical content 6/7/ Editorial Revised and edited the technical content 6/29/ Editorial Changed language and formatting in the technical content. 7/23/ Minor Clarified the meaning of the technical content. 9/27/ None 11/15/ None 12/17/ None No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. 3/18/ Major Significantly changed the technical content. 6/10/ None No changes to the meaning, language, or formatting of the technical content. 1/20/ Minor Clarified the meaning of the technical content. 4/11/ None 7/16/ None 9/12/ None No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. 10/8/ Minor Clarified the meaning of the technical content. 2/11/ Minor Clarified the meaning of the technical content. 7/30/ Minor Clarified the meaning of the technical content. 11/18/ Minor Clarified the meaning of the technical content. 2/10/ None No changes to the meaning, language, or formatting of the technical content. 4/30/ Minor Clarified the meaning of the technical content. 7/31/ None No changes to the meaning, language, or formatting of the technical content. 10/30/ None No changes to the meaning, language, or formatting of the 2 / 127

3 Date Revision History Revision Class Comments technical content. 2/26/ Major Significantly changed the technical content. 7/15/ None 9/14/ None 10/17/ None 9/19/ None No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. No changes to the meaning, language, or formatting of the technical content. 3 / 127

4 Table of Contents 1 Introduction Glossary References Normative References Informative References Protocol Overview (Synopsis) Session-based Protocol Protocol Operations Relationship to Other Protocols Prerequisites/Preconditions Applicability Statement Versioning and Capability Negotiation Vendor-Extensible Fields Standards Assignments Messages Transport Common Message Syntax Namespaces Messages Elements Complex Types AccessServerMessage ArrayOfAnyType ArrayOfKeyValuePair CommandParameter CommandResult KeyValuePair ServerHealthInformation ServerHealthInformation WorkOnBehalf Simple Types AccessServerMessageButtons AccessServerMessageId AccessServerMessageSeverity AccessServerMessageType CommandParameterFlags guid ServerStateFlags ServerStateFlags SessionIdentifier Attributes Groups Attribute Groups Faults Common Fault Identifiers Query Fault Identifiers Protocol Details Server Details Abstract Data Model Timers Session Timeout Initialization Message Processing Events and Sequencing Rules / 127

5 CloseSession Messages AccessServiceSoap_CloseSession_InputMessage AccessServiceSoap_CloseSession_OutputMessage Elements CloseSession CloseSessionResponse Complex Types Simple Types Attributes Groups Attribute Groups DeleteData Messages AccessServiceSoap_DeleteData_InputMessage AccessServiceSoap_DeleteData_OutputMessage Elements DeleteData DeleteDataResponse Complex Types Simple Types Attributes Groups Attribute Groups FixupRow Messages AccessServiceSoap_FixupRow_InputMessage AccessServiceSoap_FixupRow_OutputMessage Elements FixupRow FixupRowResponse Complex Types Simple Types Attributes Groups Attribute Groups GetData Messages AccessServiceSoap_GetData_InputMessage AccessServiceSoap_GetData_OutputMessage Elements GetData GetDataResponse Complex Types Simple Types CacheCommands Attributes Groups Attribute Groups GetDistinctValues Messages AccessServiceSoap_GetDistinctValues_InputMessage AccessServiceSoap_GetDistinctValues_OutputMessage Elements GetDistinctValues GetDistinctValuesResponse Complex Types Simple Types / 127

6 Attributes Groups Attribute Groups GetHealthScore Messages AccessServiceSoap_GetHealthScore_InputMessage AccessServiceSoap_GetHealthScore_OutputMessage Elements GetHealthScore GetHealthScoreResponse Complex Types Simple Types Attributes Groups Attribute Groups GetMacroState Messages AccessServiceSoap_GetMacroState_InputMessage AccessServiceSoap_GetMacroState_OutputMessage Elements GetMacroState GetMacroStateResponse Complex Types DataMacroInstanceState Simple Types DataMacroState Attributes Groups Attribute Groups InsertData Messages AccessServiceSoap_InsertData_InputMessage AccessServiceSoap_InsertData_OutputMessage Elements InsertData InsertDataResponse Complex Types Simple Types Attributes Groups Attribute Groups KeepAlive Messages AccessServiceSoap_KeepAlive_InputMessage AccessServiceSoap_KeepAlive_OutputMessage Elements KeepAlive KeepAliveResponse Complex Types Simple Types Attributes Groups Attribute Groups OpenResultSet Messages AccessServiceSoap_OpenResultSet_InputMessage AccessServiceSoap_OpenResultSet_OutputMessage Elements / 127

7 OpenResultSet OpenResultSetResponse Complex Types ArrayOfString Simple Types Attributes Groups Attribute Groups OpenSession Messages AccessServiceSoap_OpenSession_InputMessage AccessServiceSoap_OpenSession_OutputMessage Elements OpenSession OpenSessionResponse Complex Types CultureCommandParameter Simple Types Attributes Groups Attribute Groups RunDataMacro Messages AccessServiceSoap_RunDataMacro_InputMessage AccessServiceSoap_RunDataMacro_OutputMessage Elements RunDataMacro RunDataMacroResponse Complex Types Simple Types Attributes Groups Attribute Groups UpdateCache Messages AccessServiceSoap_UpdateCache_InputMessage AccessServiceSoap_UpdateCache_OutputMessage Elements UpdateCache UpdateCacheResponse Complex Types Simple Types Attributes Groups Attribute Groups UpdateData Messages AccessServiceSoap_UpdateData_InputMessage AccessServiceSoap_UpdateData_OutputMessage Elements UpdateData UpdateDataResponse Complex Types Simple Types Attributes Groups Attribute Groups Timer Events / 127

8 Session Timeout Other Local Events Protocol Examples Security Security Considerations for Implementers Index of Security Parameters Appendix A: Full WSDL Appendix B: Full XML Schema Schema Schema Schema Service/ Schema vice/ Schema Appendix C: Product Behavior Change Tracking Index / 127

9 1 Introduction The enables a protocol client to execute and monitor tasks on a server application. Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative. 1.1 Glossary This document uses the following terms: absolute URL: The full Internet address of a page or other World Wide Web resource. The absolute URL includes a protocol, such as "http," a network location, and an optional path and file name for example, alert: A message that is passed to a protocol client to notify it when specific criteria are met. Augmented Backus-Naur Form (ABNF): A modified version of Backus-Naur Form (BNF), commonly used by Internet specifications. ABNF notation balances compactness and simplicity with reasonable representational power. ABNF differs from standard BNF in its definitions and uses of naming rules, repetition, alternatives, order-independence, and value ranges. For more information, see [RFC5234]. caption: One or more characters that can be used as a label for display purposes or as an identifier. content database: A database that is stored on a back-end database server and contains stored procedures, site collections, and the contents of those site collections. control button: A button in the user interface. data culture: The language that is used to specify number formatting for data. data macro: A component that implements application logic and enables recognition of built-in actions and tasks for list items. data source: A database, web service, disk, file, or other collection of information from which data is queried or submitted. Supported data sources vary based on application and data provider. data type: A property of a field that defines the kind of data that is stored in the field, or defines the kind of data returned by an expression when the expression is evaluated. expression: A combination of operators, symbols, constants, literal values, functions, names of fields or columns, controls, and properties that evaluates to a single value. fallback data culture: A data culture that is selected through an algorithm as a substitute for a data culture that is not installed or is otherwise unavailable. fallback UI culture: A user interface (UI) culture that is selected through an algorithm as a substitute for a UI culture that is not installed or is otherwise unavailable. field: A container for metadata within a SharePoint list and associated list items. filter: A mechanism by which a set of data is scoped to display only those entries that meet specified logical criteria. globally unique identifier (GUID): A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. 9 / 127

10 Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the GUID. See also universally unique identifier (UUID). Help topic identifier: A unique identifier for an article that contains Help content. host data language: The data culture of a site. license key: An array of bytes that enables access to a control according to the usage policies for that control. list: A container within a SharePoint site that stores list items. A list has a customizable schema that is composed of one or more fields. list item: An individual entry within a SharePoint list. Each list item has a schema that maps to fields in the list that contains the item, depending on the content type of the item. primary key: A field or set of fields that uniquely identifies each record in a table. A primary key cannot contain a null value. result set: A list of records that results from running a stored procedure or query, or applying a filter. The structure and content of the data in a result set varies according to the implementation. root element: The top-level element in an XML document. It contains all other elements and is not contained by any other element, as described in [XML]. row: A collection of columns that contains property values that describe a single item in a set of items that match the restriction specified in a query. session: A representation of application data in system memory. It is used to maintain state for application data that is being manipulated or monitored on a protocol server by a user. session identifier: A key that enables an application to make reference to a session. site: A group of related pages and data within a SharePoint site collection. The structure and content of a site is based on a site definition. Also referred to as SharePoint site and web site. site identifier: A GUID that is used to identify a site in a site collection. SOAP action: The HTTP request header field used to indicate the intent of the SOAP request, using a URI value. See [SOAP1.1] section for more information. SOAP body: A container for the payload data being delivered by a SOAP message to its recipient. See [SOAP1.2-1/2007] section 5.3 for more information. SOAP fault: A container for error and status information within a SOAP message. See [SOAP1.2-1/2007] section 5.4 for more information. SOAP fault detail: A string containing a human-readable explanation of a SOAP fault, which is not intended for algorithmic processing. See [SOAP1.2-1/2007] section for more information. state changing: A type of operation that changes the state of a session. time zone: A geographical area that observes the same local time. The local time has a positive, zero, or negative offset from Coordinated Universal Time (UTC). The offset can be different during standard time and daylight saving time. time zone bias: The positive, zero, or negative offset in minutes from Coordinated Universal Time (UTC). For example, Middle European Time (MET, GMT+01:00) has a time zone bias of "-60" 10 / 127

11 because it is one hour ahead of UTC. Pacific Standard Time (PST, GMT-08:00) has a time zone bias of "+480" because it is eight hours behind UTC. time zone daylight bias: The positive, zero, or negative offset in minutes that is added to the time zone bias during daylight saving time. For example, daylight saving time advances the clock by one hour. The time zone daylight bias is set to "-60". time zone daylight date: The date and time when the change from standard time to daylight saving time occurs. time zone standard bias: A positive, zero, or negative offset in minutes that is added to the time zone bias outside daylight saving time. time zone standard date: The date and time when the change from daylight saving time to standard time occurs. UI culture: The language that is used to display strings and graphical elements in a user interface. user display name: A user profile property that contains the preferred name of a user. See also display name. Web Services Description Language (WSDL): An XML format for describing network services as a set of endpoints that operate on messages that contain either document-oriented or procedure-oriented information. The operations and messages are described abstractly and are bound to a concrete network protocol and message format in order to define an endpoint. Related concrete endpoints are combined into abstract endpoints, which describe a network service. WSDL is extensible, which allows the description of endpoints and their messages regardless of the message formats or network protocols that are used. WSDL message: An abstract, typed definition of the data that is communicated during a WSDL operation [WSDL]. Also, an element that describes the data being exchanged between web service providers and clients. WSDL operation: A single action or function of a web service. The execution of a WSDL operation typically requires the exchange of messages between the service requestor and the service provider. XML: The Extensible Markup Language, as described in [XML1.0]. XML namespace: A collection of names that is used to identify elements, types, and attributes in XML documents identified in a URI reference [RFC3986]. A combination of XML namespace and local name allows XML documents to use elements, types, and attributes that have the same names but come from different sources. For more information, see [XMLNS-2ED]. XML namespace prefix: An abbreviated form of an XML namespace, as described in [XML]. XML schema: A description of a type of XML document that is typically expressed in terms of constraints on the structure and content of documents of that type, in addition to the basic syntax constraints that are imposed by XML itself. An XML schema provides a view of a document type at a relatively high level of abstraction. MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. 1.2 References Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata. 11 / 127

12 1.2.1 Normative References We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact dochelp@microsoft.com. We will assist you in finding the relevant information. [MS-ASWS] Microsoft Corporation, "Access Services Protocol". [MS-AXL] Microsoft Corporation, "Access Application Transfer Protocol Structure". [MS-DSDIFFGRAM] Microsoft Corporation, "SharePoint Web Services: DataSet DiffGram Structure". [MS-PWVPDP] Microsoft Corporation, "PowerPoint Web Viewer Presentation Data Protocol". [RFC1766] Alvestrand, H., "Tags for the Identification of Languages", RFC 1766, March 1995, [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [RFC2234] Crocker, D. and Overell, P., "Augmented BNF for Syntax Specifications: ABNF", RFC 2234, November 1997, [RFC3339] Klyne, G. and Newman, C., "Date and Time on the Internet: Timestamps", RFC 3339, July 2002, [RFC4122] Leach, P., Mealling, M., and Salz, R., "A Universally Unique Identifier (UUID) URN Namespace", RFC 4122, July 2005, [SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., et al., "Simple Object Access Protocol (SOAP) 1.1", W3C Note, May 2000, [SOAP1.2/1] Gudgin, M., Hadley, M., Mendelsohn, N., Moreau, J., and Nielsen, H.F., "SOAP Version 1.2 Part 1: Messaging Framework", W3C Recommendation, June 2003, [WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description Language (WSDL) 1.1", W3C Note, March 2001, [XMLNS] Bray, T., Hollander, D., Layman, A., et al., Eds., "Namespaces in XML 1.0 (Third Edition)", W3C Recommendation, December 2009, [XMLSCHEMA1] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema Part 1: Structures", W3C Recommendation, May 2001, [XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C Recommendation, May 2001, [XMLSchemaInstance] W3C, "XML Schema Instance", 1999, [XML] World Wide Web Consortium, "Extensible Markup Language (XML) 1.0 (Fourth Edition)", W3C Recommendation 16 August 2006, edited in place 29 September 2006, Informative References 12 / 127

13 1.3 Protocol Overview (Synopsis) This protocol is used for managing data maintained by a protocol server, which provides access to a protocol client, which renders the data provided by the protocol server. The communication is always initiated by the protocol client using different operations, whose functionality is outlined in section A typical scenario for this protocol is opening a result set and updating data Session-based Protocol The protocol is session based and uses a unique session identifier. This session identifier is generated when a new session is created and is used thereafter to refer to that particular session. Multiple sessions (2) can exist at the same time. Result sets are not shared across sessions. Sessions (2) can be created and closed independently Protocol Operations The protocol provides the following sets of functionality: Create, read, update and delete data. Get information about the protocol server. Trigger a data macro. Get information about a data macro. 1.4 Relationship to Other Protocols This protocol uses the SOAP message protocol for formatting request and response messages, as described in [SOAP1.1], [SOAP1.2/1] and [SOAP1.2/2]. It transmits those messages by using HTTP, as described in [RFC2616], or Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS), as described in [RFC2818]. The following diagram shows the underlying messaging and transport stack used by the protocol: Figure 1: This protocol in relation to other protocols 13 / 127

14 1.5 Prerequisites/Preconditions This protocol operates against a protocol server that exposes one or more endpoint URIs that are known by protocol clients. The endpoint URI of the protocol server and the transport that is used by the protocol server are either known by the protocol client or obtained by using the discovery mechanism that is described in [MS-SPTWS]. The protocol client obtains the requisite ApplicationClassId and ApplicationVersion values and the endpoint URI of the protocol server that provides the discovery mechanism, as described in [MS- SPTWS], by means that are independent of either protocol. This protocol requires the protocol client to have permission to call the methods on the protocol server. The protocol client implements the token-based security mechanisms that are required by the protocol server and related security protocols, as described in [MS-SPSTWS]. 1.6 Applicability Statement This protocol is applicable in the following scenarios: 1. Managing sessions between protocol client and protocol server. 2. Creating, reading, updating, or deleting data on the protocol server. 3. Executing a data macro on the protocol server. 4. Monitoring the health of the protocol server. 1.7 Versioning and Capability Negotiation This document covers versioning issues in the following areas: Supported Transports: This protocol can be implemented by using transports that support sending Simple Object Access Protocol (SOAP) messages, as described in section 2.1. Protocol Versions: This protocol is not versioned. Capability Negotiation: This protocol does not support version negotiation. 1.8 Vendor-Extensible Fields 1.9 Standards Assignments 14 / 127

15 2 Messages In the following sections, the schema definition might differ from the processing rules imposed by the protocol. The WSDL in this specification matches the WSDL that shipped with the product and provides a base description of the schema. The text that introduces the WSDL might specify differences that reflect actual Microsoft product behavior. For example, the schema definition might allow for an element to be empty, null, or not present but the behavior of the protocol as specified restricts the same elements to being non-empty, not null, and present. 2.1 Transport Protocol servers MUST support SOAP over HTTP or HTTPS. All protocol messages MUST be transported by using HTTP bindings at the transport level. Protocol messages MUST be formatted as specified in either [SOAP1.1] section 4 or [SOAP1.2/1] section 5. Protocol server faults MUST be returned by using either HTTP status codes, as specified in [RFC2616] section 10, or SOAP faults, as specified in [SOAP1.1] section 4.4 or [SOAP1.2/1] section 5.4. If the HTTPS transport is used, a server certificate MUST be deployed. This protocol MAY transmit an additional SOAP header, the ServiceContext header, as specified in [MS-SPSTWS]. This protocol does not define any means for activating a protocol server or protocol client. The protocol server MUST be configured and begin listening in an implementation-specific way. In addition, the protocol client MUST know the format and transport that is used by the protocol server, for example, the SOAP format over an HTTP transport. 2.2 Common Message Syntax This section contains common definitions used by this protocol. The syntax of the definitions uses XML Schema as defined in [XMLSCHEMA1] and [XMLSCHEMA2], and the WSDL as defined in [WSDL] Namespaces This specification defines and references various XML namespaces using the mechanisms specified in [XMLNS]. Although this specification associates a specific XML namespace prefix for each XML namespace that is used, the choice of any particular XML namespace prefix is implementation-specific and not significant for interoperability. Prefi x q1 q2 q3 Namespace URI ce/ Reference soap [SOAP1.1] tns ervice/ 15 / 127

16 Prefi x tns1 tns2 wsaw Namespace URI ervice/imports Reference wsdl [WSDL] xs [XMLSCHEMA 1] [XMLSCHEMA 2] Messages This specification does not define any common WSDL message definitions Elements This specification does not define any common XML schema element definitions Complex Types The following table summarizes the set of common XML schema complex type definitions defined by this specification. XML schema complex type definitions that are specific to a particular operation are described with the operation. Complex type AccessServerMessage ArrayOfAnyType ArrayOfKeyValuePair CommandParameter CommandResult KeyValuePair ServerHealthInformation ServerHealthInformation WorkOnBehalf Description The AccessServerMessage complex type is used to return alert information to the protocol client. An array of anytype ([MS-PWVPDP] section ) elements. An array of KeyValuePair elements. The CommandParameter complex type is an input used by some protocol server operations. The CommandResult complex type is an operation response message used by all protocol server operations. The KeyValuePair complex type is used as a container for a key and its associated value. The ServerHealthInformation complex type is used to return information about the health of the protocol server. The ServerHealthInformation complex type is used to return information about the health of the protocol server. 16 / 127

17 AccessServerMessage Namespace: The AccessServerMessage complex type is used to return alert information to the protocol client. <xs:complextype name="accessservermessage" xmlns:xs=" <xs:element minoccurs="0" name="buttons" type="q1:accessservermessagebuttons"/> <xs:element minoccurs="0" name="caption" nillable="true" type="xs:string"/> <xs:element minoccurs="0" name="description" nillable="true" type="xs:string"/> <xs:element minoccurs="0" name="errornumber" nillable="true" type="xs:int"/> <xs:element minoccurs="0" name="extendeddescription" nillable="true" type="xs:string"/> <xs:element minoccurs="0" name="healthinformation" nillable="true" type="q1:serverhealthinformation"/> <xs:element minoccurs="0" name="helpdisplaytext" nillable="true" type="xs:string"/> <xs:element minoccurs="0" name="helptopicid" nillable="true" type="xs:string"/> <xs:element minoccurs="0" name="id" type="q1:accessservermessageid"/> <xs:element minoccurs="0" name="severity" type="q1:accessservermessageseverity"/> <xs:element minoccurs="0" name="type" type="q1:accessservermessagetype"/> Buttons: The control buttons of the alert as specified in AccessServerMessageButtons (section ). MUST be present. Caption: A caption for the alert. MUST be present. MUST be in the language UI culture of the session. Description: A text description of the alert. MUST be present. MUST NOT be empty. MUST be in the language UI culture of the session. ErrorNumber: The error number returned by the data macro. See [MS-AXL] section ExtendedDescription: An extended description of the alert. MUST be present. MUST be in the language UI culture of the session. HealthInformation: The health information of the protocol server as specified in ServerHealthInformation (section ). MUST be present. HelpDisplayText: A description of the help topic MUST be present. MUST be in the language UI culture of the session. HelpTopicId: The Help topic identifier. Id: The identifier of the alert as specified in AccessServerMessageId (section ). MUST be present. Severity: The severity of the alert as specified in AccessServerMessageSeverity (section ). MUST be present. Type: The type of the alert as specified in AccessServerMessageType (section ). MUST be present ArrayOfAnyType Namespace: An array of anytype ([MS-PWVPDP] section ) elements. 17 / 127

18 <xs:complextype name="arrayofanytype" xmlns:xs=" <xs:element minoccurs="0" maxoccurs="unbounded" name="anytype" nillable="true"/> anytype: An anytype value ArrayOfKeyValuePair Namespace: An array of KeyValuePair elements. <xs:complextype name="arrayofkeyvaluepair" xmlns:xs=" <xs:element minoccurs="0" maxoccurs="unbounded" name="keyvaluepair" type="tns:keyvaluepair"/> KeyValuePair: A KeyValuePair as specified in section Each KeyValuePair in the ArrayOfKeyValuePair element MUST have a unique value in its Key element CommandParameter Namespace: The CommandParameter complex type is an input used by some protocol server operations. The following applies to the CommandParameter complex type, unless extended or overridden by an operation specification: <xs:complextype name="commandparameter" xmlns:xs=" <xs:element minoccurs="0" maxoccurs="1" name="workbookid" type="xs:string"/> <xs:element minoccurs="1" maxoccurs="1" name="stateid" type="xs:int"/> <xs:element minoccurs="0" maxoccurs="1" name="workonbehalfrequest" type="q2:workonbehalf"/> <xs:element minoccurs="0" maxoccurs="1" name="protocolclientid" type="xs:string"/> <xs:element minoccurs="0" maxoccurs="1" name="userfriendlydisplayname" type="xs:string"/> <xs:element minoccurs="0" maxoccurs="1" name="zone" type="xs:string"/> <xs:element xmlns:q3=" minoccurs="1" maxoccurs="1" name="requestsiteid" type="q3:guid"/> <xs:element xmlns:q3=" minoccurs="1" maxoccurs="1" name="correlationid" type="q3:guid"/> <xs:element minoccurs="0" maxoccurs="1" name="requestid" type="xs:string"/> <xs:element minoccurs="1" maxoccurs="1" name="completeresponsetimeout" type="xs:int"/> <xs:element minoccurs="1" maxoccurs="1" name="flags" type="q2:commandparameterflags"/> WorkbookId: The session identifier that is returned in the sessionid of the OpenSessionResponse element, as specified in section If present, MUST NOT be empty and MUST be as specified in section / 127

19 For all operations other than OpenSession (section ), MUST be present and MUST have a value that was obtained from a previous call to the OpenSession operation. StateId: MUST be "-1". WorkOnBehalfRequest: MUST NOT be present. ProtocolClientId: MUST NOT be present. UserFriendlyDisplayName: The user display name. MUST be present. Zone: MUST be present. MUST be empty. RequestSiteId: The site identifier. MUST be present. CorrelationId: An identifier for the operation. RequestId: MUST NOT be present. CompleteResponseTimeout: MUST be zero ("0"). Flags: MUST be present. Value MUST be ignored CommandResult Namespace: The CommandResult complex type is an operation response message used by all protocol server operations. The following applies to the CommandResult complex type, unless extended or overridden by an operation specification: <xs:complextype name="commandresult" xmlns:xs=" <xs:element minoccurs="0" maxoccurs="1" name="transienteditsessiontoken" type="xs:string"/> <xs:element minoccurs="1" maxoccurs="1" name="stateid" type="xs:int"/> <xs:element minoccurs="0" maxoccurs="1" name="spreadsheetdata" type="xs:string"/> <xs:element minoccurs="0" maxoccurs="1" name="healthinformation" type="q2:serverhealthinformation"/> <xs:element minoccurs="1" maxoccurs="1" name="secondsbeforenextpoll" type="xs:int"/> <xs:element minoccurs="1" maxoccurs="1" name="editsessionisdirty" type="xs:boolean"/> <xs:element minoccurs="1" maxoccurs="1" name="editsessionhasmultiplecollaborationusers" type="xs:boolean"/> <xs:element minoccurs="0" maxoccurs="1" name="requestid" type="xs:string"/> TransientEditSessionToken: StateId: MUST be zero ("0"). SpreadsheetData: HealthInformation: The health information of the protocol server, as specified in section SecondsBeforeNextPoll: MUST be zero ("0"). EditSessionIsDirty: MUST be "false". 19 / 127

20 EditSessionHasMultipleCollaborationUsers: MUST be "false". RequestId: KeyValuePair Namespace: The KeyValuePair complex type is used as a container for a key and its associated value. <xs:complextype name="keyvaluepair" xmlns:xs=" <xs:element minoccurs="0" maxoccurs="1" name="key"/> <xs:element minoccurs="1" maxoccurs="1" name="value" nillable="true"/> Key: Specifies a value that uniquely identifies the KeyValuePair within an ArrayOfKeyValuePair (section ). MUST be present. MUST be of type string ([XMLSCHEMA2] section 3.2.1) or int ([XMLSCHEMA2] section ) Value: Data associated with a given Key, which has any value as long as the document remains well formed, as specified in [XML] section 2. MUST be present. MUST be formatted in the data culture of the session ServerHealthInformation Namespace: The ServerHealthInformation complex type is used to return information about the health of the protocol server. <xs:complextype name="serverhealthinformation" xmlns:xs=" <xs:element minoccurs="0" name="healthscore" type="xs:float"/> <xs:element minoccurs="0" name="stateflags" type="q1:serverstateflags"/> HealthScore: An indication of the health of the protocol server. A float value that specifies the server performance health ranging between 0 and 100, wherein a score of 0 specifies excellent server health and a score of 100 specifies very poor server health. MUST be present. StateFlags: The state of the protocol server. MUST be present. MUST contain zero or more values from ServerStateFlags, as specified in section ServerHealthInformation Namespace: The ServerHealthInformation complex type is used to return information about the health of the protocol server. <xs:complextype name="serverhealthinformation" xmlns:xs=" 20 / 127

21 <xs:element minoccurs="1" maxoccurs="1" name="stateflags" type="q2:serverstateflags"/> <xs:element minoccurs="1" maxoccurs="1" name="healthscore" type="xs:float"/> StateFlags: The state of the protocol server. MUST be present. MUST contain zero or more values from ServerStateFlags, as specified in section HealthScore: An indication of the health of the protocol server. A float value that specifies the server performance health ranging between 0 and 100, wherein a score of 0 specifies excellent server health and a score of 100 specifies very poor server health. MUST be present WorkOnBehalf Namespace: <xs:complextype name="workonbehalf" xmlns:xs=" <xs:element minoccurs="0" maxoccurs="1" name="username" type="xs:string"/> <xs:element minoccurs="0" maxoccurs="1" name="usersid" type="xs:string"/> <xs:element minoccurs="0" maxoccurs="1" name="usertoken" type="xs:base64binary"/> <xs:element minoccurs="1" maxoccurs="1" name="usertokenttl" type="xs:int"/> UserName: UserSid: UserToken: UserTokenTtl: Simple Types The following table summarizes the set of common XML schema simple type definitions defined by this specification. XML schema simple type definitions that are specific to a particular operation are described with the operation. Simple type AccessServerMessageButtons AccessServerMessageId AccessServerMessageSeverity AccessServerMessageType CommandParameterFlags Description AccessServerMessageButtons specifies the control buttons associated with an alert that the protocol server returns to the protocol client. The list MUST contain only the value "OK". The AccessServerMessageId type is an enumeration of alerts returned from the protocol server. AccessServerMessageSeverity specifies the severity of the alert that the protocol server returns to the protocol client. AccessServerMessageType specifies the type of the alert that the protocol server returns to the protocol client. 21 / 127

22 Simple type guid ServerStateFlags ServerStateFlags SessionIdentifier Description The guid type specifies a GUID value, as specified in [RFC4122]. ServerStateFlags specifies the state of the protocol server. ServerStateFlags is an enumeration specifying the state of the protocol server. The SessionIdentifier string is used to uniquely identify a session on the protocol server, and to contain information about the session AccessServerMessageButtons Namespace: AccessServerMessageButtons specifies the control buttons associated with an alert that the protocol server returns to the protocol client. The list MUST contain only the value "OK". <xs:simpletype name="accessservermessagebuttons" xmlns:xs=" <xs:list> <xs:simpletype> <xs:restriction base="xs:string"> <xs:enumeration value="none"/> <xs:enumeration value="ok"/> <xs:enumeration value="cancel"/> <xs:enumeration value="yes"/> <xs:enumeration value="no"/> </xs:restriction> </xs:simpletype> </xs:list> </xs:simpletype> The following table specifies the allowable values for the AccessServerMessageButtons simple type. Value None OK Cancel Yes No Meaning An OK control button AccessServerMessageId Namespace: The AccessServerMessageId type is an enumeration of alerts returned from the protocol server. <xs:simpletype name="accessservermessageid" xmlns:xs=" <xs:restriction base="xs:string"> <xs:enumeration value="blank"/> 22 / 127

23 <xs:enumeration value="internalerror"/> <xs:enumeration value="managementuiinternalerror"/> <xs:enumeration value="getrecordspermissionsfailure"/> <xs:enumeration value="writerecordspermissionsfailure"/> <xs:enumeration value="editvaluelistpermissionsfailure"/> <xs:enumeration value="notmemberofrole"/> <xs:enumeration value="maxsessionsperuserexceeded"/> <xs:enumeration value="sitecollectioncpuquotaexceeded"/> <xs:enumeration value="sessionmemoryquotaexceeded"/> <xs:enumeration value="sitecollectionmemoryquotaexceeded"/> <xs:enumeration value="retryerror"/> <xs:enumeration value="maxrequestdurationexceeded"/> <xs:enumeration value="productexpired"/> <xs:enumeration value="newworkbooksessiontimeout"/> <xs:enumeration value="dataexception_dataoperationfailed"/> <xs:enumeration value="dataexception_cacheoperationinvalid"/> <xs:enumeration value="dataexception_validationfailed"/> <xs:enumeration value="dataexception_maxrecordsintableexceeded"/> <xs:enumeration value="dataexception_invalidpagenumber"/> <xs:enumeration value="dataexception_datamacronotfound"/> <xs:enumeration value="invalidfilterexpression"/> <xs:enumeration value="invalidaggregateexpression"/> <xs:enumeration value="invalidargument"/> <xs:enumeration value="nullargument"/> <xs:enumeration value="webserviceupdateidconflict"/> <xs:enumeration value="queryexception_ambiguousvaluesprovided"/> <xs:enumeration value="queryexception_invalidcompiledqueryversion"/> <xs:enumeration value="queryexception_invalidsourceusagewithoutjoin"/> <xs:enumeration value="queryexception_invalidexpression"/> <xs:enumeration value="queryexception_invalidlikeargumentsexpression"/> <xs:enumeration value="queryexception_invalidlikefieldtypeinexpression"/> <xs:enumeration value="queryexception_invalidinargumentsexpression"/> <xs:enumeration value="queryexception_invalidaxlencoding"/> <xs:enumeration value="queryexception_invalidorderpropertyname"/> <xs:enumeration value="queryexception_invalidordersourcename"/> <xs:enumeration value="queryexception_invalidjoinleftsourcename"/> <xs:enumeration value="queryexception_invalidjoinrightsourcename"/> <xs:enumeration value="queryexception_invalidjoinleftpropertyname"/> <xs:enumeration value="queryexception_invalidjoinrightpropertyname"/> <xs:enumeration value="queryexception_invalidjointype"/> <xs:enumeration value="queryexception_invalidjoinpropertytype"/> <xs:enumeration value="queryexception_invalidpropertyelement"/> <xs:enumeration value="queryexception_invalidresultpropertysource"/> <xs:enumeration value="queryexception_invalidresultpropertyname"/> <xs:enumeration value="queryexception_invalidresultpropertyalias"/> <xs:enumeration value="queryexception_invalidresultexpression"/> <xs:enumeration value="queryexception_duplicateresultaliases"/> <xs:enumeration value="queryexception_invalidparametername"/> <xs:enumeration value="queryexception_invalidparametertype"/> <xs:enumeration value="queryexception_invalidreferencesourcename"/> <xs:enumeration value="queryexception_invalidreferencesourcetype"/> <xs:enumeration value="queryexception_invalidrestrictionexpression"/> <xs:enumeration value="queryexception_invalidreferenceinexpression"/> <xs:enumeration value="queryexception_invalidreferenceinexpression_outsideofquery"/> <xs:enumeration value="queryexception_ambiguousreferenceinexpression"/> <xs:enumeration value="queryexception_failedfilteroperation"/> <xs:enumeration value="queryexception_failedfilterevaluation_calclibgeneral"/> <xs:enumeration value="queryexception_failedfilterevaluation_divzero"/> <xs:enumeration value="queryexception_failedsortorfilteroperation"/> <xs:enumeration value="queryexception_querynotcompiled"/> <xs:enumeration value="queryexception_invalidcompiledqueryformat"/> <xs:enumeration value="queryexception_invalidjoinusage"/> <xs:enumeration value="queryexception_invalidexecutionstate"/> <xs:enumeration value="queryexception_failedfetchlistdata"/> <xs:enumeration value="queryexception_failedcalculatedfieldevaluation"/> <xs:enumeration value="queryexception_requiredparameternotsupplied"/> <xs:enumeration value="queryexception_invalidlistorqueryreference"/> <xs:enumeration value="queryexception_bulkupdatesnotsupported"/> <xs:enumeration value="queryexception_missingkeycolumn"/> 23 / 127