Tasks Web Service Protocol ActiveSync
Tasks Web Service Protocol ActiveSync
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.
1 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Revision Summary
Revision Revision
Date History Class Comments
2 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Revision Revision
Date History Class Comments
3 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Table of Contents
1 Introduction ............................................................................................................ 6
1.1 Glossary ........................................................................................................... 6
1.2 References ........................................................................................................ 7
1.2.1 Normative References ................................................................................... 7
1.2.2 Informative References ................................................................................. 8
1.3 Overview .......................................................................................................... 8
1.4 Relationship to Other Protocols ............................................................................ 8
1.5 Prerequisites/Preconditions ................................................................................. 9
1.6 Applicability Statement ....................................................................................... 9
1.7 Versioning and Capability Negotiation ................................................................... 9
1.8 Vendor-Extensible Fields ................................................................................... 10
1.9 Standards Assignments..................................................................................... 10
2 Messages ............................................................................................................... 11
2.1 Transport ........................................................................................................ 11
2.2 Common Message Syntax ................................................................................. 11
2.2.1 Namespaces .............................................................................................. 11
2.2.2 Messages................................................................................................... 11
2.2.3 Elements ................................................................................................... 11
2.2.4 Complex Types ........................................................................................... 12
2.2.4.1 t:DailyRegeneratingPatternType Complex Type ......................................... 12
2.2.4.2 t:MonthlyRegeneratingPatternType Complex Type ..................................... 12
2.2.4.3 t:RegeneratingPatternBaseType Complex Type ......................................... 13
2.2.4.4 t:TaskRecurrenceType Complex Type ...................................................... 13
2.2.4.5 t:TasksFolderType Complex Type ............................................................ 13
2.2.4.6 t:TaskType Complex Type ...................................................................... 14
2.2.4.7 t:WeeklyRegeneratingPatternType Complex Type ...................................... 17
2.2.4.8 t:YearlyRegeneratingPatternType Complex Type ....................................... 17
2.2.5 Simple Types ............................................................................................. 17
2.2.5.1 t:TaskDelegateStateType Simple Type ..................................................... 18
2.2.5.2 t:TaskStatusType Simple Type................................................................ 18
2.2.6 Attributes .................................................................................................. 19
2.2.7 Groups ...................................................................................................... 19
2.2.7.1 TaskRecurrencePatternTypes Group ........................................................ 19
2.2.8 Attribute Groups ......................................................................................... 21
2.2.9 Common Data Structures ............................................................................ 21
3 Protocol Details ..................................................................................................... 22
3.1 ExchangeServicePortType Server Details............................................................. 22
3.1.1 Abstract Data Model .................................................................................... 22
3.1.2 Timers ...................................................................................................... 22
3.1.3 Initialization ............................................................................................... 22
3.1.4 Message Processing Events and Sequencing Rules .......................................... 22
3.1.4.1 CopyItem Operation .............................................................................. 22
3.1.4.1.1 Messages ....................................................................................... 23
3.1.4.1.2 Elements ........................................................................................ 23
3.1.4.1.3 Complex Types ............................................................................... 23
3.1.4.1.4 Simple Types .................................................................................. 23
3.1.4.1.5 Attributes ....................................................................................... 23
3.1.4.1.6 Groups ........................................................................................... 23
3.1.4.1.7 Attribute Groups.............................................................................. 24
3.1.4.2 CreateItem Operation ............................................................................ 24
3.1.4.2.1 Messages ....................................................................................... 24
3.1.4.2.2 Elements ........................................................................................ 24
3.1.4.2.3 Complex Types ............................................................................... 24
4 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
3.1.4.2.4 Simple Types .................................................................................. 25
3.1.4.2.5 Attributes ....................................................................................... 25
3.1.4.2.6 Groups ........................................................................................... 25
3.1.4.2.7 Attribute Groups.............................................................................. 25
3.1.4.3 DeleteItem Operation ............................................................................ 25
3.1.4.3.1 Messages ....................................................................................... 26
3.1.4.3.2 Elements ........................................................................................ 26
3.1.4.3.3 Complex Types ............................................................................... 26
3.1.4.3.4 Simple Types .................................................................................. 26
3.1.4.3.4.1 t:AffectedTaskOccurrencesType Simple Type ................................. 26
3.1.4.3.5 Attributes ....................................................................................... 27
3.1.4.3.6 Groups ........................................................................................... 27
3.1.4.3.7 Attribute Groups.............................................................................. 27
3.1.4.4 GetItem Operation ................................................................................ 27
3.1.4.4.1 Messages ....................................................................................... 28
3.1.4.4.2 Elements ........................................................................................ 28
3.1.4.4.3 Complex Types ............................................................................... 28
3.1.4.4.4 Simple Types .................................................................................. 28
3.1.4.4.5 Attributes ....................................................................................... 28
3.1.4.4.6 Groups ........................................................................................... 28
3.1.4.4.7 Attribute Groups.............................................................................. 28
3.1.4.5 MoveItem Operation .............................................................................. 28
3.1.4.5.1 Messages ....................................................................................... 29
3.1.4.5.2 Elements ........................................................................................ 29
3.1.4.5.3 Complex Types ............................................................................... 29
3.1.4.5.4 Simple Types .................................................................................. 29
3.1.4.5.5 Attributes ....................................................................................... 29
3.1.4.5.6 Groups ........................................................................................... 29
3.1.4.5.7 Attribute Groups.............................................................................. 29
3.1.4.6 UpdateItem Operation ........................................................................... 30
3.1.4.6.1 Messages ....................................................................................... 30
3.1.4.6.2 Elements ........................................................................................ 30
3.1.4.6.3 Complex Types ............................................................................... 30
3.1.4.6.4 Simple Types .................................................................................. 30
3.1.4.6.5 Attributes ....................................................................................... 30
3.1.4.6.6 Groups ........................................................................................... 31
3.1.4.6.7 Attribute Groups.............................................................................. 31
3.1.5 Timer Events .............................................................................................. 31
3.1.6 Other Local Events ...................................................................................... 31
4 Protocol Examples ................................................................................................. 32
5 Security ................................................................................................................. 33
5.1 Security Considerations for Implementers ........................................................... 33
5.2 Index of Security Parameters ............................................................................ 33
6 Appendix A: Full WSDL .......................................................................................... 34
7 Appendix B: Full XML Schema ................................................................................ 38
7.1 Messages Schema ............................................................................................ 38
7.2 Types Schema ................................................................................................. 38
8 Appendix C: Product Behavior ............................................................................... 41
9 Change Tracking .................................................................................................... 42
10 Index ..................................................................................................................... 43
5 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
1 Introduction
The Tasks Web Service Protocol enables clients to create, update, move, copy, and delete task items
on a server. The protocol also enables clients to get the properties of an existing task item.
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
delegate: A user or resource that has permissions to act on behalf of another user or resource.
endpoint: A communication port that is exposed by an application server for a specific shared
service and to which messages can be addressed.
Hypertext Transfer Protocol Secure (HTTPS): An extension of HTTP that securely encrypts and
decrypts web page requests. In some older protocols, "Hypertext Transfer Protocol over Secure
Sockets Layer" is still used (Secure Sockets Layer has been deprecated). For more information,
see [SSL3] and [RFC5246].
Inbox folder: A special folder that is the default location for Message objects received by a user or
resource.
mailbox: A message store that contains email, calendar items, and other Message objects for a
single recipient.
message store: A unit of containment for a single hierarchy of Folder objects, such as a mailbox
or public folders.
Sent Items folder: A special folder that is the default location for storing copies of Message
objects after they are submitted or sent.
SOAP message: An XML document consisting of a mandatory SOAP envelope, an optional SOAP
header, and a mandatory SOAP body. See [SOAP1.2-1/2007] section 5 for more information.
Uniform Resource Locator (URL): A string of characters in a standardized format that identifies
a document or resource on the World Wide Web. The format is as specified in [RFC1738].
web server: A server computer that hosts websites and responds to requests from applications.
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.
6 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
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.
WSDL port type: A named set of logically-related, abstract Web Services Description
Language (WSDL) operations and messages.
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 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.
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 [email protected]. We will
assist you in finding the relevant information.
[MS-OXWSFOLD] Microsoft Corporation, "Folders and Folder Permissions Web Service Protocol".
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC
2119, March 1997, http://www.rfc-editor.org/rfc/rfc2119.txt
[RFC2616] Fielding, R., Gettys, J., Mogul, J., et al., "Hypertext Transfer Protocol -- HTTP/1.1", RFC
2616, June 1999, http://www.rfc-editor.org/rfc/rfc2616.txt
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000, http://www.rfc-
editor.org/rfc/rfc2818.txt
7 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
[SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., et al., "Simple Object Access Protocol (SOAP) 1.1",
W3C Note, May 2000, http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description
Language (WSDL) 1.1", W3C Note, March 2001, http://www.w3.org/TR/2001/NOTE-wsdl-20010315
[XMLNS] Bray, T., Hollander, D., Layman, A., et al., Eds., "Namespaces in XML 1.0 (Third Edition)",
W3C Recommendation, December 2009, http://www.w3.org/TR/2009/REC-xml-names-20091208/
[XMLSCHEMA1/2] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema
Part 1: Structures Second Edition", W3C Recommendation, October 2004,
http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/
[XMLSCHEMA2/2] Biron, P., and Malhotra, A., Eds., "XML Schema Part 2: Datatypes Second Edition",
W3C Recommendation, October 2004, http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/
1.3 Overview
The Tasks Web Service Protocol provides clients with the ability to create, update, and delete task
items on the server. Clients create task items by using the CreateItem operation, as described in
[MS-OXWSCORE] section 3.1.4.2, or get properties of an existing task item by using the GetItem
operation, as described in [MS-OXWSCORE] section 3.1.4.4. Clients can update, delete, or copy tasks
on the server by using the UpdateItem operation [MS-OXWSCORE] section 3.1.4.9), the
DeleteItem operation ([MS-OXWSCORE] section 3.1.4.3), and the CopyItem operation ([MS-
OXWSCORE] section Error! Hyperlink reference not valid.), respectively. Clients can move task
items on the server by using the MoveItem operation, as described in [MS-OXWSCORE] section
3.1.4.7.
A client that implements this protocol can use the Autodiscover Publishing and Lookup SOAP-Based
Web Service Protocol, as described in [MS-OXWSADISC], or the Autodiscover Publishing and Lookup
Protocol, as described in [MS-OXDSCLI], to identify the target endpoint to use for each operation.
This protocol uses the SOAP Protocol, as described in [SOAP1.1], to specify the structure information
exchanged between the client and server. This protocol uses the XML Protocol, as described in
[XMLSCHEMA1/2] and [XMLSCHEMA2/2], to describe the message content sent to and from the
server.
The Tasks Web Service Protocol uses SOAP over HTTP, as described in [RFC2616], and SOAP over
HTTPS, as described in [RFC2818], as shown in the following layering diagram.
8 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Figure 1: This protocol in relation to other protocols.
When requests are made by using the Core Items Web Service Protocol [MS-OXWSCORE], the task
information that is returned by the Tasks Web Service Protocol will be used if the targets of the
requests are task items.
This protocol can use the Task item identifier returned by the Mailbox Search Web Service Protocol, as
described in [MS-OXWSSRCH], to manipulate the Task item.
For conceptual background information and overviews of the relationships and interactions between
this and other protocols, see [MS-OXPROTO].
1.5 Prerequisites/Preconditions
The endpoint URL that is returned by either the Autodiscover Publishing Lookup SOAP-Based Web
Service Protocol, as described in [MS-OXWSADISC], or the Autodiscover Publishing and Lookup
Protocol, as described in [MS-OXDSCLI], is required to form the HTTP request to the web server that
hosts this protocol. The operations that this protocol defines cannot be accessed unless the correct
endpoint is identified in the HTTP Web requests that target this protocol.
To access this protocol, all callers are authenticated. This protocol relies on the web server that hosts
the application to perform authentication.
The protocol specified in this document is applicable to environments that create, delete, and update
task items.
Supported Transports: This protocol uses multiple transports with SOAP 1.1, as specified in
section 2.1.
Protocol Versions: This protocol has only one WSDL port type version. The WSDL version of
the request is identified by using the t:RequestServerVersion element, as described in [MS-
OXWSCDATA] section 2.2.3.9, and the version of the server responding to the request is identified
by using the t:ServerVersionInfo element, as described in [MS-OXWSCDATA] section 2.2.3.10.
Security and Authentication Methods: This protocol relies on the Web server that is hosting it
to perform authentication.
Localization: This protocol includes text strings in various messages. Localization considerations
for such strings are specified in sections 2.2 and 3.1.4.
9 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
1.8 Vendor-Extensible Fields
None.
None.
10 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
2 Messages
In the following sections, the schema definition might differ from the processing rules imposed by the
protocol. The WSDL in this specification provides a base description of the protocol. The schema in
this specification provides a base description of the message syntax. The text that specifies the WSDL
and schema might specify restrictions that reflect actual protocol 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, or present.
2.1 Transport
The SOAP version supported is SOAP 1.1. For details, see [SOAP1.1].
This protocol relies on the web server that hosts the application to perform authentication. The
protocol SHOULD use secure communications by means of HTTPS, as specified in [RFC2818]. The
protocol server SHOULD additionally support SOAP over HTTP, as specified in [RFC2616], as a
transport means.
This section contains common definitions that are used by this protocol. The syntax of the definitions
uses XML schema as defined in [XMLSCHEMA1/2] and [XMLSCHEMA2/2], and WSDL as defined in
[WSDL].
2.2.1 Namespaces
This specification defines and references various XML namespaces by using the mechanisms that are
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.
tns http://schemas.microsoft.com/exchange/services/2006/messages
s http://www.w3.org/2001/XMLSchema [XMLSCHEMA1/2]
(none) http://schemas.microsoft.com/exchange/services/2006/messages
t http://schemas.microsoft.com/exchange/services/2006/types
2.2.2 Messages
This specification does not define any common WSDL message definitions.
2.2.3 Elements
This specification does not define any common XML schema element definitions.
11 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
2.2.4 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.
The DailyRegeneratingPatternType complex type specifies the interval, in days, at which a task is
regenerated. The DailyRegeneratingPatternType complex type extends the
RegeneratingPatternBaseType complex type, as specified in section 2.2.4.3.
<xs:complexType name="DailyRegeneratingPatternType">
<xs:complexContent>
<xs:extension
base="t:RegeneratingPatternBaseType"
/>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="MonthlyRegeneratingPatternType">
<xs:complexContent>
<xs:extension
base="t:RegeneratingPatternBaseType"
/>
</xs:complexContent>
</xs:complexType>
12 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
2.2.4.3 t:RegeneratingPatternBaseType Complex Type
The RegeneratingPatternBaseType complex type specifies the base type for all regenerating
patterns. The RegeneratingPatternBaseType complex type extends the
IntervalRecurrencePatternBaseType complex type, as specified in [MS-OXWSCDATA] section
2.2.4.42.
<xs:complexType name="RegeneratingPatternBaseType"
abstract="true"
>
<xs:complexContent>
<xs:extension
base="t:IntervalRecurrencePatternBaseType"
/>
</xs:complexContent>
</xs:complexType>
The TaskRecurrenceType complex type specifies the recurrence pattern for tasks.
<xs:complexType name="TaskRecurrenceType">
<xs:sequence>
<xs:group
ref="t:TaskRecurrencePatternTypes"
/>
<xs:group
ref="t:RecurrenceRangeTypes"
/>
</xs:sequence>
</xs:complexType>
The following table lists and describes the groups of the TaskRecurrenceType complex type.
The TasksFolderType complex type specifies a Tasks folder that is contained in a mailbox. The
TasksFolderType complex type extends the FolderType complex type, as specified in [MS-
OXWSFOLD] section 2.2.4.12.
<xs:complexType name="TasksFolderType">
<xs:complexContent>
<xs:extension
base="t:FolderType"
/>
</xs:complexContent>
</xs:complexType>
13 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
2.2.4.6 t:TaskType Complex Type
The TaskType complex type specifies a task in the message store. The TaskType complex type
extends the ItemType complex type, as specified in [MS-OXWSCORE] section 2.2.4.24.
<xs:complexType name="TaskType">
<xs:complexContent>
<xs:extension
base="t:ItemType"
>
<xs:sequence>
<xs:element name="ActualWork"
type="xs:int"
minOccurs="0"
/>
<xs:element name="AssignedTime"
type="xs:dateTime"
minOccurs="0"
/>
<xs:element name="BillingInformation"
type="xs:string"
minOccurs="0"
/>
<xs:element name="ChangeCount"
type="xs:int"
minOccurs="0"
/>
<xs:element name="Companies"
type="t:ArrayOfStringsType"
minOccurs="0"
/>
<xs:element name="CompleteDate"
type="xs:dateTime"
minOccurs="0"
/>
<xs:element name="Contacts"
type="t:ArrayOfStringsType"
minOccurs="0"
/>
<xs:element name="DelegationState"
type="t:TaskDelegateStateType"
minOccurs="0"
/>
<xs:element name="Delegator"
type="xs:string"
minOccurs="0"
/>
<xs:element name="DueDate"
type="xs:dateTime"
minOccurs="0"
/>
<xs:element name="IsAssignmentEditable"
type="xs:int"
minOccurs="0"
/>
<xs:element name="IsComplete"
type="xs:boolean"
minOccurs="0"
/>
<xs:element name="IsRecurring"
type="xs:boolean"
minOccurs="0"
/>
<xs:element name="IsTeamTask"
14 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
type="xs:boolean"
minOccurs="0"
/>
<xs:element name="Mileage"
type="xs:string"
minOccurs="0"
/>
<xs:element name="Owner"
type="xs:string"
minOccurs="0"
/>
<xs:element name="PercentComplete"
type="xs:double"
minOccurs="0"
/>
<xs:element name="Recurrence"
type="t:TaskRecurrenceType"
minOccurs="0"
/>
<xs:element name="StartDate"
type="xs:dateTime"
minOccurs="0"
/>
<xs:element name="Status"
type="t:TaskStatusType"
minOccurs="0"
/>
<xs:element name="StatusDescription"
type="xs:string"
minOccurs="0"
/>
<xs:element name="TotalWork"
type="xs:int"
minOccurs="0"
/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
The following table lists and describes the child elements of the TaskType complex type.
ActualWork xs:int [XMLSCHEMA2/2] section Specifies an integer value that specifies the
3.3.17 actual amount of time that is spent on a task.
15 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Element name Type Description
16 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Element name Type Description
task.
Setting CompleteDate has the same effect as setting PercentComplete to 100 or Status to
Completed. In a request that sets at least two of these properties, the last processed property will
determine the value that is set for these elements. For example, if PercentComplete is 100,
CompleteDate is January 1, 2007, and Status is NotStarted, and the properties are streamed in
that order, the effect will be to set the Status of the task to NotStarted, the CompleteDate to null,
and PercentComplete to 0.
<xs:complexType name="WeeklyRegeneratingPatternType">
<xs:complexContent>
<xs:extension
base="t:RegeneratingPatternBaseType"
/>
</xs:complexContent>
</xs:complexType>
The YearlyRegeneratingPatternType complex type specifies the interval, in years, at which a task
is regenerated. The YearlyRegeneratingPatternType complex type extends the
RegeneratingPatternBaseType complex type, as specified in section 2.2.4.3.
<xs:complexType name="YearlyRegeneratingPatternType">
<xs:complexContent>
<xs:extension
base="t:RegeneratingPatternBaseType"
/>
</xs:complexContent>
</xs:complexType>
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.
TaskDelegateStateType Specifies the status types of a delegated task. This enumeration is never set.
17 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
2.2.5.1 t:TaskDelegateStateType Simple Type
The TaskDelegateStateType simple type specifies the status types of a delegated task. The values
for this simple type are never set.
<xs:simpleType name="TaskDelegateStateType">
<xs:restriction
base="xs:string"
>
<xs:enumeration
value="Accepted"
/>
<xs:enumeration
value="Declined"
/>
<xs:enumeration
value="Max"
/>
<xs:enumeration
value="NoMatch"
/>
<xs:enumeration
value="Owned"
/>
<xs:enumeration
value="OwnNew"
/>
</xs:restriction>
</xs:simpleType>
The following table lists the values that are defined by the TaskDelegateStateType simple type.
Value
name Meaning
Owned Specifies that this is a new task request that has been sent, but the delegate has not yet
responded to the request.
OwnNew Specifies that this is not a delegated task or that the task request has been created but not sent.
This value is also used for a task request message, whether it's in the owner’s Sent Items folder
or the delegate's Inbox folder.
<xs:simpleType name="TaskStatusType">
<xs:restriction
base="xs:string"
>
<xs:enumeration
18 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
value="Completed"
/>
<xs:enumeration
value="Deferred"
/>
<xs:enumeration
value="InProgress"
/>
<xs:enumeration
value="NotStarted"
/>
<xs:enumeration
value="WaitingOnOthers"
/>
</xs:restriction>
</xs:simpleType>
The following table lists the values that are defined by the TaskStatusType simple type.
2.2.6 Attributes
This specification does not define any common XML schema attribute definitions.
2.2.7 Groups
The following table summarizes the set of common XML schema group definitions defined by this
specification. XML schema group definitions that are specific to a particular operation are described
with the operation.
<xs:group name="TaskRecurrencePatternTypes">
<xs:sequence>
<xs:choice>
<xs:element name="RelativeYearlyRecurrence"
type="t:RelativeYearlyRecurrencePatternType"
19 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
/>
<xs:element name="AbsoluteYearlyRecurrence"
type="t:AbsoluteYearlyRecurrencePatternType"
/>
<xs:element name="RelativeMonthlyRecurrence"
type="t:RelativeMonthlyRecurrencePatternType"
/>
<xs:element name="AbsoluteMonthlyRecurrence"
type="t:AbsoluteMonthlyRecurrencePatternType"
/>
<xs:element name="WeeklyRecurrence"
type="t:WeeklyRecurrencePatternType"
/>
<xs:element name="DailyRecurrence"
type="t:DailyRecurrencePatternType"
/>
<xs:element name="DailyRegeneration"
type="t:DailyRegeneratingPatternType"
/>
<xs:element name="WeeklyRegeneration"
type="t:WeeklyRegeneratingPatternType"
/>
<xs:element name="MonthlyRegeneration"
type="t:MonthlyRegeneratingPatternType"
/>
<xs:element name="YearlyRegeneration"
type="t:YearlyRegeneratingPatternType"
/>
</xs:choice>
</xs:sequence>
</xs:group>
The following table lists and describes the child elements of the TaskRecurrencePatternTypes
group.
20 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Element name Type Description
This specification does not define any common XML schema attribute group definitions.
This specification does not define any common XML schema data structures.
21 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
3 Protocol Details
The client side of this protocol is simply a pass-through. That is, no additional timers or other state is
required on the client side of this protocol. Calls made by the higher-layer protocol or application are
passed directly to the transport, and the results returned by the transport are passed directly back to
the higher-layer protocol or application.
The Tasks Web Service Protocol defines a single port type with six operations. The operations enable
client implementations to get, create, delete, update, move, and copy tasks on the server.
None.
3.1.2 Timers
None.
3.1.3 Initialization
None.
The following table summarizes the WSDL operations as defined by this specification.
This protocol uses the CopyItem operation, as specified in [MS-OXWSCORE] section 3.1.4.1, to copy
task items.
The following is the WSDL port type specification for the CopyItem operation.
<wsdl:operation name="CopyItem">
<wsdl:input message="tns:CopyItemSoapIn" />
<wsdl:output message="tns:CopyItemSoapOut" />
</wsdl:operation>
22 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
The following is the WSDL binding specification for the CopyItem operation.
<wsdl:operation name="CopyItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/CopyItem"/>
<wsdl:input>
<soap:header message="tns:CopyItemSoapIn" part="Impersonation" use="literal"/>
<soap:header message="tns:CopyItemSoapIn" part="MailboxCulture" use="literal"/>
<soap:header message="tns:CopyItemSoapIn" part="RequestVersion" use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="CopyItemResult" use="literal"/>
<soap:header message="tns:CopyItemSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
tns:CopyItemSoapIn ([MS- Specifies the SOAP message that defines the task item to be copied. The
OXWSCORE] section CopyItem operation (as specified in [MS-OXWSCORE] section 3.1.4.1) that
3.1.4.1.1.1) specifies the XML request MUST contain the t:TargetFolderIdType complex
type (as specified in [MS-OXWSFOLD] section 2.2.4.16) and the t:ItemIdType
complex type (as specified in [MS-OXWSCORE] section 2.2.4.25). All other type
elements in t:NonEmptyArrayOfBaseItemIdsType element MUST NOT be
included.
tns:CopyItemSoapOut Specifies the SOAP message that is returned by the server in response.
([MS-OXWSCORE] section
3.1.4.1.1.2)
3.1.4.1.1 Messages
None.
3.1.4.1.2 Elements
None.
None.
None.
3.1.4.1.5 Attributes
None.
3.1.4.1.6 Groups
None.
23 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
3.1.4.1.7 Attribute Groups
None.
This protocol uses the CreateItem operation, as specified in [MS-OXWSCORE] section 3.1.4.2, to
create task items.
The following is the WSDL port type specification for the CreateItem operation.
<wsdl:operation name="CreateItem">
<wsdl:input message="tns:CreateItemSoapIn" />
<wsdl:output message="tns:CreateItemSoapOut" />
</wsdl:operation>
The following is the WSDL binding specification for the CreateItem operation.
<wsdl:operation name="CreateItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/CreateItem"/>
<wsdl:input>
<soap:header message="tns:CreateItemSoapIn" part="Impersonation" use="literal"/>
<soap:header message="tns:CreateItemSoapIn" part="MailboxCulture" use="literal"/>
<soap:header message="tns:CreateItemSoapIn" part="RequestVersion" use="literal"/>
<soap:header message="tns:CreateItemSoapIn" part="TimeZoneContext" use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="CreateItemResult" use="literal"/>
<soap:header message="tns:CreateItemSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
tns:CreateItemSoapIn Specifies the SOAP message that defines the task item to be created. The
([MS-OXWSCORE] section t:NonEmptyArrayOfAllItemsType complex type (as specified in [MS-
3.1.4.2.1.1) OXWSCDATA] section 2.2.4.48) of the CreateItem operation (as specified in
[MS-OXWSCORE] section 3.1.4.2) that specifies the XML request MUST contain
one or more t:TaskType complex types( as specified in section 2.2.4.6). All
other elements MUST be empty.
tns:CreateItemSoapOut Specifies the SOAP message that is returned by the server in response.
([MS-OXWSCORE] section
3.1.4.2.1.2)
3.1.4.2.1 Messages
None.
3.1.4.2.2 Elements
None.
24 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
None.
None.
3.1.4.2.5 Attributes
None.
3.1.4.2.6 Groups
None.
None.
This protocol uses the DeleteItem operation, as specified in [MS-OXWSCORE] section 3.1.4.3, to
delete task items.
The following is the WSDL port type specification for the DeleteItem operation.
<wsdl:operation name="DeleteItem">
<wsdl:input message="tns:DeleteItemSoapIn" />
<wsdl:output message="tns:DeleteItemSoapOut" />
</wsdl:operation>
The following is the WSDL binding specification for the DeleteItem operation.
<wsdl:operation name="DeleteItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/DeleteItem"/>
<wsdl:input>
<soap:header message="tns:DeleteItemSoapIn" part="Impersonation" use="literal"/>
<soap:header message="tns:DeleteItemSoapIn" part="MailboxCulture" use="literal"/>
<soap:header message="tns:DeleteItemSoapIn" part="RequestVersion" use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="DeleteItemResult" use="literal"/>
<soap:header message="tns:DeleteItemSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
tns:DeleteItemSoapIn Specifies the SOAP message that defines the task item to be deleted. The
([MS-OXWSCORE] section t:NonEmptyArrayOfBaseItemIdsType complex type (as specified in [MS-
3.1.4.3.1.1) OXWSCORE] section 2.2.4.31) of the DeleteItem operation (as specified in
[MS-OXWSCORE] section 3.1.4.3) that specifies the XML request MUST contain
one or more t:ItemIdType complex type elements (as specified in [MS-
OXWSCORE] section 2.2.4.25). All other elements MUST be empty.
tns:DeleteItemSoapOut Specifies the SOAP message that is returned by the server in response.
([MS-OXWSCORE] section
25 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Message format Description
3.1.4.3.1.2)
3.1.4.3.1 Messages
None.
3.1.4.3.2 Elements
None.
None.
The following table lists and describes the XML schema simple type definitions that are specific to the
DeleteItem operation.
AffectedTaskOccurrencesType Specifies whether an occurrence of a task or a master task with all recurring
tasks associated with the master task is deleted.
<xs:simpleType name="AffectedTaskOccurrencesType">
<xs:restriction
base="xs:string"
>
<xs:enumeration
value="AllOccurrences"
/>
<xs:enumeration
value="SpecifiedOccurrenceOnly"
/>
</xs:restriction>
</xs:simpleType>
The following table lists and describes the values that are defined by the
AffectedTaskOccurrencesType simple type.
26 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Value name Description
3.1.4.3.5 Attributes
None.
3.1.4.3.6 Groups
None.
None.
This protocol uses the GetItem operation, as specified in [MS-OXWSCORE] section 3.1.4.4, to get
task items.
The following is the WSDL port type specification for the GetItem operation.
<wsdl:operation name="GetItem">
<wsdl:input message="tns:GetItemSoapIn" />
<wsdl:output message="tns:GetItemSoapOut" />
</wsdl:operation>
The following is the WSDL binding specification for the GetItem operation.
<wsdl:operation name="GetItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/GetItem"/>
<wsdl:input>
<soap:header message="tns:GetItemSoapIn" part="Impersonation" use="literal"/>
<soap:header message="tns:GetItemSoapIn" part="MailboxCulture" use="literal"/>
<soap:header message="tns:GetItemSoapIn" part="RequestVersion" use="literal"/>
<soap:header message="tns:GetItemSoapIn" part="TimeZoneContext" use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="GetItemResult" use="literal"/>
<soap:header message="tns:GetItemSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
tns:GetItemSoapIn Specifies the SOAP message that defines the task item to be retrieved. The
([MS-OXWSCORE] section t:NonEmptyArrayOfBaseItemIdsType complex type (as specified in [MS-
3.1.4.4.1.1) OXWSCORE] section 2.2.4.31) of the GetItem operation (as specified in [MS-
OXWSCORE] section 3.1.4.4) that specifies the XML request MUST contain the
t:ItemResponseShapeType complex type element (as specified in [MS-
OXWSCDATA] section 2.2.4.44) and the t:ItemIdType complex type element (as
specified in [MS-OXWSCORE] section 2.2.4.25).
27 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
Message format Description
tns:GetItemSoapOut Specifies the SOAP message that is returned by the server in response. The server
([MS-OXWSCORE] section returns a t:GetItemResponseType complex type element, which extends the
3.1.4.4.1.2) BaseResponseMessageType complex type, as specified in [MS-OXWSCDATA]
section 2.2.4.18, that contains properties associated with the task item.
3.1.4.4.1 Messages
None.
3.1.4.4.2 Elements
None.
None.
None.
3.1.4.4.5 Attributes
None.
3.1.4.4.6 Groups
None.
None.
This protocol uses the MoveItem operation, as specified in [MS-OXWSCORE] section 3.1.4.7, to move
task item elements.
The following is the WSDL port type specification for the MoveItem operation.
<wsdl:operation name="MoveItem">
<wsdl:input message="tns:MoveItemSoapIn" />
<wsdl:output message="tns:MoveItemSoapOut" />
</wsdl:operation>
The following is the WSDL binding specification for the MoveItem operation.
<wsdl:operation name="MoveItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/MoveItem"/>
<wsdl:input>
<soap:header message="tns:MoveItemSoapIn" part="Impersonation" use="literal"/>
<soap:header message="tns:MoveItemSoapIn" part="MailboxCulture" use="literal"/>
28 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
<soap:header message="tns:MoveItemSoapIn" part="RequestVersion" use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="MoveItemResult" use="literal"/>
<soap:header message="tns:MoveItemSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
tns:MoveItemSoapIn ([MS- Specifies the SOAP message that defines the task item to be moved. The
OXWSCORE] section MoveItem operation (as specified in [MS-OXWSCORE] section 3.1.4.7) that
3.1.4.7.1.1) specifies the XML request MUST contain the t:TargetFolderIdType complex
type element (as specified in [MS-OXWSFOLD] section 2.2.4.16) and
t:ItemIdType complex type element (as specified in [MS-OXWSCORE] section
2.2.4.25). All other type elements in t:NonEmptyArrayOfBaseItemIdsType
element MUST be empty.
tns:MoveItemSoapOut Specifies the SOAP message that is returned by the server in response.
([MS-OXWSCORE] section
3.1.4.7.1.2)
3.1.4.5.1 Messages
None.
3.1.4.5.2 Elements
None.
None.
None.
3.1.4.5.5 Attributes
None.
3.1.4.5.6 Groups
None.
None.
This protocol uses the UpdateItem operation, as specified in [MS-OXWSCORE] section 3.1.4.9, to
update task item elements.
29 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
The following is the WSDL port type specification for the UpdateItem operation.
<wsdl:operation name="UpdateItem">
<wsdl:input message="tns:UpdateItemSoapIn" />
<wsdl:output message="tns:UpdateItemSoapOut" />
</wsdl:operation>
The following is the WSDL binding specification for the UpdateItem operation.
<wsdl:operation name="UpdateItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/UpdateItem"/>
<wsdl:input>
<soap:header message="tns:UpdateItemSoapIn" part="Impersonation" use="literal"/>
<soap:header message="tns:UpdateItemSoapIn" part="MailboxCulture" use="literal"/>
<soap:header message="tns:UpdateItemSoapIn" part="RequestVersion" use="literal"/>
<soap:header message="tns:UpdateItemSoapIn" part="TimeZoneContext" use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="UpdateItemResult" use="literal"/>
<soap:header message="tns:UpdateItemSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
tns:UpdateItemSoapIn ([MS-OXWSCORE] section Specifies the SOAP message that defines the task
3.1.4.9.1.1) item to be updated.
tns:UpdateItemSoapOut ([MS-OXWSCORE] section Specifies the SOAP message that is returned by the
3.1.4.9.1.2) server in response.
3.1.4.6.1 Messages
None.
3.1.4.6.2 Elements
None.
None.
None.
3.1.4.6.5 Attributes
None.
3.1.4.6.6 Groups
None.
30 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
3.1.4.6.7 Attribute Groups
None.
None.
None.
31 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
4 Protocol Examples
None.
32 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
5 Security
None.
None.
33 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
6 Appendix A: Full WSDL
The XML files that are listed in the following table are required in order to implement the functionality
described in this document.
MS-OXWSTASK-types.xsd Contains the XML schema type definitions that are used in this protocol. 7.2
These files have to be placed in a common folder in order for the WSDL to validate and operate. Also,
any schema files that are included in or imported into the MS-OXWSTASK-types.xsd schema have to
be placed in the common folder along with the files listed in the table.
34 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
<wsdl:message name="CreateItemSoapOut">
<wsdl:part name="CreateItemResult" element="tns:CreateItemResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
<wsdl:message name="DeleteItemSoapIn">
<wsdl:part name="request" element="tns:DeleteItem"/>
<wsdl:part name="Impersonation" element="t:ExchangeImpersonation"/>
<wsdl:part name="MailboxCulture" element="t:MailboxCulture"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
</wsdl:message>
<wsdl:message name="DeleteItemSoapOut">
<wsdl:part name="DeleteItemResult" element="tns:DeleteItemResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
<wsdl:message name="UpdateItemSoapIn">
<wsdl:part name="request" element="tns:UpdateItem"/>
<wsdl:part name="Impersonation" element="t:ExchangeImpersonation"/>
<wsdl:part name="MailboxCulture" element="t:MailboxCulture"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
<wsdl:part name="TimeZoneContext" element="t:TimeZoneContext"/>
</wsdl:message>
<wsdl:message name="UpdateItemSoapOut">
<wsdl:part name="UpdateItemResult" element="tns:UpdateItemResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
<wsdl:message name="MoveItemSoapIn">
<wsdl:part name="request" element="tns:MoveItem"/>
<wsdl:part name="Impersonation" element="t:ExchangeImpersonation"/>
<wsdl:part name="MailboxCulture" element="t:MailboxCulture"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
</wsdl:message>
<wsdl:message name="MoveItemSoapOut">
<wsdl:part name="MoveItemResult" element="tns:MoveItemResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
<wsdl:message name="CopyItemSoapIn">
<wsdl:part name="request" element="tns:CopyItem"/>
<wsdl:part name="Impersonation" element="t:ExchangeImpersonation"/>
<wsdl:part name="MailboxCulture" element="t:MailboxCulture"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
</wsdl:message>
<wsdl:message name="CopyItemSoapOut">
<wsdl:part name="CopyItemResult" element="tns:CopyItemResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
<wsdl:portType name="ExchangeServicePortType">
<wsdl:operation name="GetItem">
<wsdl:input message="tns:GetItemSoapIn"/>
<wsdl:output message="tns:GetItemSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CreateItem">
<wsdl:input message="tns:CreateItemSoapIn"/>
<wsdl:output message="tns:CreateItemSoapOut"/>
</wsdl:operation>
<wsdl:operation name="DeleteItem">
<wsdl:input message="tns:DeleteItemSoapIn"/>
<wsdl:output message="tns:DeleteItemSoapOut"/>
</wsdl:operation>
<wsdl:operation name="UpdateItem">
<wsdl:input message="tns:UpdateItemSoapIn"/>
<wsdl:output message="tns:UpdateItemSoapOut"/>
</wsdl:operation>
<wsdl:operation name="MoveItem">
<wsdl:input message="tns:MoveItemSoapIn"/>
<wsdl:output message="tns:MoveItemSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CopyItem">
<wsdl:input message="tns:CopyItemSoapIn"/>
<wsdl:output message="tns:CopyItemSoapOut"/>
35 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="ExchangeServiceBinding" type="tns:ExchangeServicePortType">
<wsdl:documentation>
<wsi:Claim conformsTo="http://ws-i.org/profiles/basic/1.0"
xmlns:wsi="http://ws-i.org/schemas/conformanceClaim/"/>
</wsdl:documentation>
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="GetItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/GetItem"/>
<wsdl:input>
<soap:header message="tns:GetItemSoapIn" part="Impersonation"
use="literal"/>
<soap:header message="tns:GetItemSoapIn" part="MailboxCulture"
use="literal"/>
<soap:header message="tns:GetItemSoapIn" part="RequestVersion"
use="literal"/>
<soap:header message="tns:GetItemSoapIn" part="TimeZoneContext"
use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="GetItemResult" use="literal"/>
<soap:header message="tns:GetItemSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/CreateItem"/>
<wsdl:input>
<soap:header message="tns:CreateItemSoapIn" part="Impersonation"
use="literal"/>
<soap:header message="tns:CreateItemSoapIn" part="MailboxCulture"
use="literal"/>
<soap:header message="tns:CreateItemSoapIn" part="RequestVersion"
use="literal"/>
<soap:header message="tns:CreateItemSoapIn" part="TimeZoneContext"
use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="CreateItemResult" use="literal"/>
<soap:header message="tns:CreateItemSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="DeleteItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/DeleteItem"/>
<wsdl:input>
<soap:header message="tns:DeleteItemSoapIn" part="Impersonation"
use="literal"/>
<soap:header message="tns:DeleteItemSoapIn" part="MailboxCulture"
use="literal"/>
<soap:header message="tns:DeleteItemSoapIn" part="RequestVersion"
use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="DeleteItemResult" use="literal"/>
<soap:header message="tns:DeleteItemSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/UpdateItem"/>
36 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
<wsdl:input>
<soap:header message="tns:UpdateItemSoapIn" part="Impersonation"
use="literal"/>
<soap:header message="tns:UpdateItemSoapIn" part="MailboxCulture"
use="literal"/>
<soap:header message="tns:UpdateItemSoapIn" part="RequestVersion"
use="literal"/>
<soap:header message="tns:UpdateItemSoapIn" part="TimeZoneContext"
use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="UpdateItemResult" use="literal"/>
<soap:header message="tns:UpdateItemSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="MoveItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/MoveItem"/>
<wsdl:input>
<soap:header message="tns:MoveItemSoapIn" part="Impersonation"
use="literal"/>
<soap:header message="tns:MoveItemSoapIn" part="MailboxCulture"
use="literal"/>
<soap:header message="tns:MoveItemSoapIn" part="RequestVersion"
use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="MoveItemResult" use="literal"/>
<soap:header message="tns:MoveItemSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CopyItem">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/CopyItem"/>
<wsdl:input>
<soap:header message="tns:CopyItemSoapIn" part="Impersonation"
use="literal"/>
<soap:header message="tns:CopyItemSoapIn" part="MailboxCulture"
use="literal"/>
<soap:header message="tns:CopyItemSoapIn" part="RequestVersion"
use="literal"/>
<soap:body parts="request" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body parts="CopyItemResult" use="literal"/>
<soap:header message="tns:CopyItemSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
</wsdl:definitions>
37 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
7 Appendix B: Full XML Schema
For ease of implementation, the following sections provide the full XML schema for this protocol.
This file has to be placed in a common folder in order for the WSDL to validate and operate. Also, any
schema files that are included in or imported into the MS-OXWSNTIF-types.xsd schema have to be
placed in the common folder along with the files listed in the table.
This section contains the contents of the MS-OXWSTASK-types.xsd file and information about
additional files that this schema file requires in order to operate correctly.
MS-OXWSTASK-types.xsd includes the file listed in the following table. To operate correctly, this file
has to be present in the folder that contains the WSDL and the types schema file for this protocol.
38 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
<xs:complexType name="YearlyRegeneratingPatternType">
<xs:complexContent>
<xs:extension base="t:RegeneratingPatternBaseType"/>
</xs:complexContent>
</xs:complexType>
<xs:simpleType name="TaskStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotStarted"/>
<xs:enumeration value="InProgress"/>
<xs:enumeration value="Completed"/>
<xs:enumeration value="WaitingOnOthers"/>
<xs:enumeration value="Deferred"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TaskDelegateStateType">
<xs:restriction base="xs:string">
<xs:enumeration value="NoMatch"/>
<xs:enumeration value="OwnNew"/>
<xs:enumeration value="Owned"/>
<xs:enumeration value="Accepted"/>
<xs:enumeration value="Declined"/>
<xs:enumeration value="Max"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="TaskType">
<xs:complexContent>
<xs:extension base="t:ItemType">
<xs:sequence>
<xs:element name="ActualWork" type="xs:int" minOccurs="0"/>
<xs:element name="AssignedTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="BillingInformation" type="xs:string"
minOccurs="0"/>
<xs:element name="ChangeCount" type="xs:int" minOccurs="0"/>
<xs:element name="Companies" type="t:ArrayOfStringsType"
minOccurs="0"/>
<xs:element name="CompleteDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="Contacts" type="t:ArrayOfStringsType"
minOccurs="0"/>
<xs:element name="DelegationState" type="t:TaskDelegateStateType"
minOccurs="0"/>
<xs:element name="Delegator" type="xs:string" minOccurs="0"/>
<xs:element name="DueDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="IsAssignmentEditable" type="xs:int"
minOccurs="0"/>
<xs:element name="IsComplete" type="xs:boolean" minOccurs="0"/>
<xs:element name="IsRecurring" type="xs:boolean" minOccurs="0"/>
<xs:element name="IsTeamTask" type="xs:boolean" minOccurs="0"/>
<xs:element name="Mileage" type="xs:string" minOccurs="0"/>
<xs:element name="Owner" type="xs:string" minOccurs="0"/>
<xs:element name="PercentComplete" type="xs:double" minOccurs="0"/>
<xs:element name="Recurrence" type="t:TaskRecurrenceType"
minOccurs="0"/>
<xs:element name="StartDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="Status" type="t:TaskStatusType" minOccurs="0"/>
<xs:element name="StatusDescription" type="xs:string"
minOccurs="0"/>
<xs:element name="TotalWork" type="xs:int" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="TaskRecurrenceType">
<xs:sequence>
<xs:group ref="t:TaskRecurrencePatternTypes"/>
<xs:group ref="t:RecurrenceRangeTypes"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TasksFolderType">
<xs:complexContent>
39 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
<xs:extension base="t:FolderType"/>
</xs:complexContent>
</xs:complexType>
</xs:schema>
40 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
8 Appendix C: Product Behavior
The information in this specification is applicable to the following Microsoft products or supplemental
software. References to product versions include updates to those products.
Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base
(KB) number appears with a product name, the behavior changed in that update. The new behavior
also applies to subsequent updates unless otherwise specified. If a product edition appears with the
product version, behavior is different in that product edition.
Unless otherwise specified, any statement of optional behavior in this specification that is prescribed
using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the
SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the
product does not follow the prescription.
<1> Section 2.2.4.6: The Owner element is read-only for the client on Exchange 2007 and Exchange
2010.
41 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
9 Change Tracking
This section identifies changes that were made to this document since the last release. Changes are
classified as Major, Minor, or None.
The revision class Major means that the technical content in the document was significantly revised.
Major changes affect protocol interoperability or implementation. Examples of major changes are:
The revision class Minor means that the meaning of the technical content was clarified. Minor changes
do not affect protocol interoperability or implementation. Examples of minor changes are updates to
clarify ambiguity at the sentence, paragraph, or table level.
The revision class None means that no new technical changes were introduced. Minor editorial and
formatting changes may have been made, but the relevant technical content is identical to the last
released version.
The changes made to this document are listed in the following table. For more information, please
contact [email protected].
Revision
Section Description
class
42 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
10 Index
A Local events
server 31
Abstract data model
server 22 M
Applicability 9
Attribute groups 21 Message processing
Attributes 19 server 22
Messages
C attribute groups 21
attributes 19
Capability negotiation 9 common data structures 21
Change tracking 42 complex types 12
Common data structures 21 elements 11
Complex types 12 enumerated 11
t:DailyRegeneratingPatternType Complex Type 12 groups 19
t:MonthlyRegeneratingPatternType Complex Type namespaces 11
12 simple types 17
t:RegeneratingPatternBaseType Complex Type 13 syntax 11
t:TaskRecurrenceType Complex Type 13 t:DailyRegeneratingPatternType Complex Type
t:TasksFolderType Complex Type 13 complex type 12
t:TaskType Complex Type 14 t:MonthlyRegeneratingPatternType Complex Type
t:WeeklyRegeneratingPatternType Complex Type complex type 12
17 t:RegeneratingPatternBaseType Complex Type
t:YearlyRegeneratingPatternType Complex Type 17 complex type 13
t:TaskDelegateStateType Simple Type simple type
D 18
t:TaskRecurrenceType Complex Type complex type
Data model - abstract 13
server 22 t:TasksFolderType Complex Type complex type 13
t:TaskStatusType Simple Type simple type 18
E t:TaskType Complex Type complex type 14
t:WeeklyRegeneratingPatternType Complex Type
Events complex type 17
local - server 31 t:YearlyRegeneratingPatternType Complex Type
timer - server 31 complex type 17
TaskRecurrencePatternTypes Group group 19
transport 11
F
Fields - vendor-extensible 10 N
Full WSDL 34
Full XML schema 38 Namespaces 11
Messages Schema 38 Normative references 7
Types Schema 38
O
G
Operations
Glossary 6 CopyItem Operation 22
Groups 19 CreateItem Operation 24
TaskRecurrencePatternTypes Group 19 DeleteItem Operation 25
GetItem Operation 27
MoveItem Operation 28
I
UpdateItem Operation 30
Overview (synopsis) 8
Implementer - security considerations 33
Index of security parameters 33
Informative references 8 P
Initialization
server 22 Parameters - security index 33
Introduction 6 Preconditions 9
Prerequisites 9
Product behavior 41
L
Protocol Details
43 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018
overview 22 simple 17
R V
S WSDL 34
Security X
implementer considerations 33
parameter index 33 XML schema 38
Sequencing rules Messages Schema 38
server 22 Types Schema 38
Server
abstract data model 22
CopyItem Operation operation 22
CreateItem Operation operation 24
DeleteItem Operation operation 25
GetItem Operation operation 27
initialization 22
local events 31
message processing 22
MoveItem Operation operation 28
sequencing rules 22
timer events 31
timers 22
UpdateItem Operation operation 30
Simple types 17
t:TaskDelegateStateType Simple Type 18
t:TaskStatusType Simple Type 18
Standards assignments 10
Syntax
messages - overview 11
44 / 44
[MS-OXWSTASK] - v20181211
Tasks Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: December 11, 2018