Cell Response SchemaThis is a featured page

Many service calls that interact with user-generated content return <cell> or <cells> elements.

Because this schema defines responses for a variety of calls, please see the documentation for individual service calls to see example xml responses.

The following schema describes this response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="cell" type="cell"/>

<xs:element name="cellRevision" type="cellRevision"/>

<xs:element name="cellRevisionDiff" type="cellRevisionDiff"/>

<xs:element name="cellRevisionDiffItem" type="cellRevisionDiffItem"/>

<xs:element name="cells" type="cells"/>

<xs:element name="response" type="response"/>

<xs:element name="tag" type="tag"/>

<xs:element name="tags" type="tags"/>

<xs:element name="user" type="user"/>

<xs:complexType name="response">
<xs:sequence>
<xs:any processContents="lax" namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="version" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="cell">
<xs:sequence>
<xs:element name="cellId" type="xs:string" minOccurs="0"/>
<xs:element name="children" type="cells" minOccurs="0"/>
<xs:element name="currentRevision" type="cellRevision" minOccurs="0"/>
<xs:element name="deleted" type="xs:boolean" minOccurs="0"/>
<xs:element name="displayName" type="xs:string" minOccurs="0"/>
<xs:element name="locked" type="xs:boolean" minOccurs="0"/>
<xs:element name="parent" type="cell" minOccurs="0"/>
<xs:element name="parentCellId" type="xs:string" minOccurs="0"/>
<xs:element ref="tags" minOccurs="0"/>
<xs:element name="url" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="cells">
<xs:complexContent>
<xs:extension base="scrollableModel">
<xs:sequence>
<xs:element ref="cell" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:complexType name="scrollableModel" abstract="true">
<xs:sequence/>
<xs:attribute name="total" type="xs:int" use="required"/>
</xs:complexType>

<xs:complexType name="cellRevision">
<xs:sequence>
<xs:element name="content" type="xs:string" minOccurs="0"/>
<xs:element name="date" type="xs:dateTime" minOccurs="0"/>
<xs:element name="deleted" type="xs:boolean" minOccurs="0"/>
<xs:element name="diff" type="cellRevisionDiff" minOccurs="0"/>
<xs:element name="editNote" type="xs:string" minOccurs="0"/>
<xs:element name="referencedRevision" type="cellRevision" minOccurs="0"/>
<xs:element name="renamedFrom" type="xs:string" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
<xs:element ref="user" minOccurs="0"/>
<xs:element name="version" type="xs:long" minOccurs="0"/>
<xs:element name="wordCount" type="xs:int" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="cellRevisionDiff">
<xs:sequence>
<xs:element name="addedImages" type="xs:int" minOccurs="0"/>
<xs:element name="addedWidgets" type="xs:int" minOccurs="0"/>
<xs:element name="addedWords" type="xs:int" minOccurs="0"/>
<xs:element name="deletedImages" type="xs:int" minOccurs="0"/>
<xs:element name="deletedWidgets" type="xs:int" minOccurs="0"/>
<xs:element name="deletedWords" type="xs:int" minOccurs="0"/>
<xs:element name="item" type="cellRevisionDiffItem" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="cellRevisionDiffItem">
<xs:sequence>
<xs:element name="content" type="xs:string" minOccurs="0"/>
<xs:element name="formatting" type="xs:boolean" minOccurs="0"/>
<xs:element name="type" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="user">
<xs:sequence>
<xs:element name="avatarUrl" type="xs:string" minOccurs="0"/>
<xs:element name="contributionCount" type="xs:int" minOccurs="0"/>
<xs:element name="displayName" type="xs:string" minOccurs="0"/>
<xs:element name="email" type="xs:string" minOccurs="0"/>
<xs:element name="emailOptIn" type="xs:boolean" minOccurs="0"/>
<xs:element name="profileUrl" type="xs:string" minOccurs="0"/>
<xs:element name="role" type="userRole" minOccurs="0"/>
<xs:element name="userId" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

<xs:complexType name="tags">
<xs:complexContent>
<xs:extension base="scrollableModel">
<xs:sequence>
<xs:element ref="tag" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:complexType name="tag">
<xs:sequence>
<xs:element name="name" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>

<xs:simpleType name="userRole">
<xs:restriction base="xs:string">
<xs:enumeration value="registered"/>
<xs:enumeration value="moderator"/>
<xs:enumeration value="banned"/>
</xs:restriction>
</xs:simpleType>

</xs:schema>




boe_wetpaint
boe_wetpaint
Latest page update: made by boe_wetpaint , Oct 7 2008, 2:47 PM EDT (about this update About This Update boe_wetpaint Edited by boe_wetpaint

No content added or deleted.

- complete history)
Keyword tags: None
More Info: links to this page
There are no threads for this page.  Be the first to start a new thread.