Web Services Operations

• Create and Edit Operation »
• Read Operation »
• Authentication
• Delete Operation
• Publish Operation
• Message Operations
• Read Audits Operation
• Access Rights Operations
• Batch Operation
• Workflow and Web Services Operations
• Introduction to Web Services Operations
• Authenticate Operation
• Search Operation

NEWS & TIPS

• Site Access Keys
• Top: Alt+t
  Previous: Alt+,
  Next: Alt+.
  Up: Alt+;
  (Note: use Ctrl on the Mac)

Message Operations

There are four operations for processing messages:

• Send - create and deliver a message
• List - Fetch a list of messages in the inbox
• Delete - Delete a message from the inbox
• Mark - Mark a message in the inbox as read or unread 

 The main type for message handling is the message type defined by the schema:

<complexType name="message"> <complexContent> <extension base="impl:base-asset"> <sequence> <!-- Who the message was/will be sent to. --> <element maxOccurs="1" minOccurs="1" name="to" nillable="false" type="xsd:string"/> <!-- Who sent the message - not necessary when sending a message --> <element maxOccurs="1" minOccurs="0" name="from" nillable="false" type="xsd:string"/> <!-- The subject - required --> <element maxOccurs="1" minOccurs="1" name="subject" nillable="false" type="xsd:string"/> <!-- The date the message was sent - not necessary when sending a message --> <element maxOccurs="1" minOccurs="0" name="date" nillable="false" type="xsd:dateTime"/> <!-- The body of the message --> <element maxOccurs="1" minOccurs="1" name="body" nillable="false" type="xsd:string"/> </sequence> </extension> </complexContent> </complexType>

The schema for the send operation is fairly straight-forward. While the message element follows the message schema described above, many of the parameters are nto requried for sending messages. Examine the comments in the message schema for more information.

<element name="sendMessage"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" nillable="false" type="impl:authentication"/> <element maxOccurs="1" minOccurs="1" name="message" nillable="false" type="impl:message"/> </sequence> </complexType> </element>

The schema for the list operation is shown below. The list operation will deliver the IDs of the messages it describes, which can be used in the delete and mark operations.

<element name="listMessages"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" nillable="false" type="impl:authentication"/> </sequence> </complexType> </element>

 The delete operation is similar to that for deleting a normal asset:

<element name="deleteMessage"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" nillable="false" type="impl:authentication"/> <element maxOccurs="1" minOccurs="1" name="identifier" nillable="false" type="impl:identifier"/> </sequence> </complexType> </element>

The mark operation is similar again, though with the addition of a markType attribute.

<element name="markMessage"> <complexType> <sequence> <element maxOccurs="1" minOccurs="1" name="authentication" nillable="false" type="impl:authentication"/> <element maxOccurs="1" minOccurs="1" name="identifier" nillable="false" type="impl:identifier"/> <element maxOccurs="1" minOccurs="1" name="markType" nillable="false" type="impl:message-mark-type"/> </sequence> </complexType> </element>

The markType attribute is defined with the following schema:

<!-- For marking messages - read or unread --><simpleType name="message-mark-type"> <restriction base="xsd:string"> <enumeration value="read"/> <enumeration value="unread"/> </restriction> </simpleType>

Wiki | Edit