Special Cases

• Read Folder Operation

NEWS & TIPS

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

Read Folder Operation

Like all other read operations, reading a folder returns the information about that folder. However, in the read folder operation, the folder's child assets are also returned in an array called "children". Here we can see that in the WSDL that defines the "folder" complex type:

<complexType name="folder"> <complexContent> <extension base="impl:publishable-asset"> <sequence> <!-- the array of children --> <element maxOccurs="1" minOccurs="0" name="children" nillable="true" type="impl:container-children"/> </sequence> </extension> </complexContent> </complexType>

The WSDL for the "container-children" complex type is:

<!-- wrapper for an array of folder children (identifiers) --><complexType name="container-children"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="child" type="impl:identifier"/> </sequence> </complexType>

Here we see that the "container-children" complex type is simply a wrapper for an array of identifiers, each containing the id, path, and type of that particular child.

A sample response from a read-folder operation looks like:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> <readResponse xmlns="http://www.hannonhill.com/ws/ns/AssetOperationService"> <readReturn> <asset> <assetFactory xsi:nil="true"/> <assetFactoryContainer xsi:nil="true"/> <destination xsi:nil="true"/> <feedBlock xsi:nil="true"/> <file xsi:nil="true"/> <fileSystemTransport xsi:nil="true"/> <folder> <children> <children> <id>bce56f407f000001003f5cc301f6662e</id> <path>intranet/logo.png</path> <type>file</type> </children> <children> <id>506a1cbec0a8001e01b9e7df4fdf0672</id> <path>intranet/default</path> <type>page</type> </children> <children> <id>c1a89e880a000182015a0bc0015baa75</id> <path>intranet/privacy-policy</path> <type>page</type> </children> <children> <id>5fecb34a0a00018200b95569bcbd1fa0</id> <path>intranet/site-map</path> <type>page</type> </children> <children> <id>9944cdb00a00018201e6ddebe521f877</id> <path>intranet/site-index</path> <type>page</type> </children> <children> <id>a9e06dc10a00018200cb94b7df19201f</id> <path>intranet/_internal</path> <type>folder</type> </children> <children> <id>4fa1ca2b0a00018200de8d9dc86b4ff5</id> <path>intranet/news</path> <type>folder</type> </children> <children> <id>ae359da70a000182015a0bc07bbbff5c</id> <path>intranet/courses</path> <type>folder</type> </children> <children> <id>333278be0a00018201ff597667a7f711</id> <path>intranet/segments</path> <type>folder</type> </children> <children> <id>4f9ca16e0a00018200de8d9d5cc728b8</id> <path>intranet/documents</path> <type>folder</type> </children> <children> <id>5ebb6af8c0a8016800354949b8ad3375</id> <path>intranet/programs</path> <type>folder</type> </children> <children> <id>1021335a0a000182013d8fb0d5c936ad</id> <path>intranet/files</path> <type>folder</type> </children> </children> <entityType> <name>folder</name> </entityType> <expirationFolderId xsi:nil="true"/> <expirationFolderPath xsi:nil="true"/> <id>506a1a1fc0a8001e01b9e7dfec2f63db</id> <metadata> <author/> <displayName>Home</displayName> <endDate xsi:nil="true"/> <keywords/> <metaDescription/> <reviewDate xsi:nil="true"/> <startDate xsi:nil="true"/> <summary/> <teaser/> <title></title> </metadata> <metadataSetId>9203255e0a00018201efbbb1f4264b36</metadataSetId> <metadataSetPath>Types/Calendar Event</metadataSetPath> <name>intranet</name> <parentFolderId>ROOT</parentFolderId> <parentFolderPath>/</parentFolderPath> <path>intranet</path> <shouldBeIndexed>true</shouldBeIndexed> <shouldBePublished>true</shouldBePublished> </folder> <ftpTransport xsi:nil="true"/> <group xsi:nil="true"/> <indexBlock xsi:nil="true"/> <metadataSet xsi:nil="true"/> <metadataSetContainer xsi:nil="true"/> <page xsi:nil="true"/> <pageConfigurationSet xsi:nil="true"/> <pageConfigurationSetContainer xsi:nil="true"/> <publishSet xsi:nil="true"/> <publishSetContainer xsi:nil="true"/> <reference xsi:nil="true"/> <structuredDataDefinition xsi:nil="true"/> <structuredDataDefinitionContainer xsi:nil="true"/> <stylesheet xsi:nil="true"/> <symlink xsi:nil="true"/> <target xsi:nil="true"/> <template xsi:nil="true"/> <textBlock xsi:nil="true"/> <user xsi:nil="true"/> <workflowConfiguration xsi:nil="true"/> <workflowDefinition xsi:nil="true"/> <workflowDefinitionContainer xsi:nil="true"/> <xhtmlBlock xsi:nil="true"/> <xmlBlock xsi:nil="true"/> </asset> <message xsi:nil="true"/> <success>true</success> </readReturn> </readResponse> </soapenv:Body> </soapenv:Envelope>

Comments

Wiki | Edit