TimeBase Web Service

TimeBase

Click here for a complete list of operations.

DocumentGet

Get information about document with given numeric identity.
Recomended: With parameter Extended as false, lock and parent folder information is omitted.

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/DocumentGet"

<?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>
    <DocumentGet xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <DocumentId>int</DocumentId>
      <Extended>boolean</Extended>
    </DocumentGet>
  </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>
    <DocumentGetResponse xmlns="http://www.timehouse.fi/">
      <DocumentGetResult>
        <Id>int</Id>
        <FolderId>int</FolderId>
        <SortOrder>int</SortOrder>
        <Name>string</Name>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <HasContent>boolean</HasContent>
        <Locks>
          <Lock>
            <Id>long</Id>
            <SessionId>long</SessionId>
            <UserId>int</UserId>
            <DocumentId>int</DocumentId>
            <FolderId>int</FolderId>
            <ElementPath>string</ElementPath>
            <Created>dateTime</Created>
            <DocumentInfo xsi:nil="true" />
            <FolderInfo xsi:nil="true" />
          </Lock>
          <Lock>
            <Id>long</Id>
            <SessionId>long</SessionId>
            <UserId>int</UserId>
            <DocumentId>int</DocumentId>
            <FolderId>int</FolderId>
            <ElementPath>string</ElementPath>
            <Created>dateTime</Created>
            <DocumentInfo xsi:nil="true" />
            <FolderInfo xsi:nil="true" />
          </Lock>
        </Locks>
        <Parents>
          <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>
          <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>
        </Parents>
      </DocumentGetResult>
    </DocumentGetResponse>
  </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>
    <DocumentGet xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <DocumentId>int</DocumentId>
      <Extended>boolean</Extended>
    </DocumentGet>
  </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>
    <DocumentGetResponse xmlns="http://www.timehouse.fi/">
      <DocumentGetResult>
        <Id>int</Id>
        <FolderId>int</FolderId>
        <SortOrder>int</SortOrder>
        <Name>string</Name>
        <Created>dateTime</Created>
        <Modified>dateTime</Modified>
        <HasContent>boolean</HasContent>
        <Locks>
          <Lock>
            <Id>long</Id>
            <SessionId>long</SessionId>
            <UserId>int</UserId>
            <DocumentId>int</DocumentId>
            <FolderId>int</FolderId>
            <ElementPath>string</ElementPath>
            <Created>dateTime</Created>
            <DocumentInfo xsi:nil="true" />
            <FolderInfo xsi:nil="true" />
          </Lock>
          <Lock>
            <Id>long</Id>
            <SessionId>long</SessionId>
            <UserId>int</UserId>
            <DocumentId>int</DocumentId>
            <FolderId>int</FolderId>
            <ElementPath>string</ElementPath>
            <Created>dateTime</Created>
            <DocumentInfo xsi:nil="true" />
            <FolderInfo xsi:nil="true" />
          </Lock>
        </Locks>
        <Parents>
          <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>
          <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>
        </Parents>
      </DocumentGetResult>
    </DocumentGetResponse>
  </soap12:Body>
</soap12:Envelope>