TimeBase Web Service

TimeBase

Click here for a complete list of operations.

FolderHierarchy

Get Folder and Document hiearachy.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /IO/TimeBase.asmx HTTP/1.1
Host: almatimebase.almainsights.fi
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.timehouse.fi/FolderHierarchy"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FolderHierarchy xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <FolderId>int</FolderId>
      <Depth>int</Depth>
      <IncludeFolders>boolean</IncludeFolders>
      <IncludeDocuments>boolean</IncludeDocuments>
    </FolderHierarchy>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FolderHierarchyResponse xmlns="http://www.timehouse.fi/">
      <FolderHierarchyResult>
        <FolderHierarchyItem>
          <Path>string</Path>
          <Folder>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </Folder>
          <Document>
            <Id>int</Id>
            <FolderId>int</FolderId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <HasContent>boolean</HasContent>
            <Locks xsi:nil="true" />
            <Parents xsi:nil="true" />
          </Document>
        </FolderHierarchyItem>
        <FolderHierarchyItem>
          <Path>string</Path>
          <Folder>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </Folder>
          <Document>
            <Id>int</Id>
            <FolderId>int</FolderId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <HasContent>boolean</HasContent>
            <Locks xsi:nil="true" />
            <Parents xsi:nil="true" />
          </Document>
        </FolderHierarchyItem>
      </FolderHierarchyResult>
    </FolderHierarchyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /IO/TimeBase.asmx HTTP/1.1
Host: almatimebase.almainsights.fi
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FolderHierarchy xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <FolderId>int</FolderId>
      <Depth>int</Depth>
      <IncludeFolders>boolean</IncludeFolders>
      <IncludeDocuments>boolean</IncludeDocuments>
    </FolderHierarchy>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FolderHierarchyResponse xmlns="http://www.timehouse.fi/">
      <FolderHierarchyResult>
        <FolderHierarchyItem>
          <Path>string</Path>
          <Folder>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </Folder>
          <Document>
            <Id>int</Id>
            <FolderId>int</FolderId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <HasContent>boolean</HasContent>
            <Locks xsi:nil="true" />
            <Parents xsi:nil="true" />
          </Document>
        </FolderHierarchyItem>
        <FolderHierarchyItem>
          <Path>string</Path>
          <Folder>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </Folder>
          <Document>
            <Id>int</Id>
            <FolderId>int</FolderId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
            <HasContent>boolean</HasContent>
            <Locks xsi:nil="true" />
            <Parents xsi:nil="true" />
          </Document>
        </FolderHierarchyItem>
      </FolderHierarchyResult>
    </FolderHierarchyResponse>
  </soap12:Body>
</soap12:Envelope>