TimeBase Web Service

TimeBase

Click here for a complete list of operations.

DocumentGetLocks

Get document locks.

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

<?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>
    <DocumentGetLocks xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <DocumentId>int</DocumentId>
    </DocumentGetLocks>
  </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>
    <DocumentGetLocksResponse xmlns="http://www.timehouse.fi/">
      <DocumentGetLocksResult>
        <Lock>
          <Id>long</Id>
          <SessionId>long</SessionId>
          <UserId>int</UserId>
          <DocumentId>int</DocumentId>
          <FolderId>int</FolderId>
          <ElementPath>string</ElementPath>
          <Created>dateTime</Created>
          <DocumentInfo>
            <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" />
          </DocumentInfo>
          <FolderInfo>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </FolderInfo>
        </Lock>
        <Lock>
          <Id>long</Id>
          <SessionId>long</SessionId>
          <UserId>int</UserId>
          <DocumentId>int</DocumentId>
          <FolderId>int</FolderId>
          <ElementPath>string</ElementPath>
          <Created>dateTime</Created>
          <DocumentInfo>
            <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" />
          </DocumentInfo>
          <FolderInfo>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </FolderInfo>
        </Lock>
      </DocumentGetLocksResult>
    </DocumentGetLocksResponse>
  </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>
    <DocumentGetLocks xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <DocumentId>int</DocumentId>
    </DocumentGetLocks>
  </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>
    <DocumentGetLocksResponse xmlns="http://www.timehouse.fi/">
      <DocumentGetLocksResult>
        <Lock>
          <Id>long</Id>
          <SessionId>long</SessionId>
          <UserId>int</UserId>
          <DocumentId>int</DocumentId>
          <FolderId>int</FolderId>
          <ElementPath>string</ElementPath>
          <Created>dateTime</Created>
          <DocumentInfo>
            <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" />
          </DocumentInfo>
          <FolderInfo>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </FolderInfo>
        </Lock>
        <Lock>
          <Id>long</Id>
          <SessionId>long</SessionId>
          <UserId>int</UserId>
          <DocumentId>int</DocumentId>
          <FolderId>int</FolderId>
          <ElementPath>string</ElementPath>
          <Created>dateTime</Created>
          <DocumentInfo>
            <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" />
          </DocumentInfo>
          <FolderInfo>
            <Id>int</Id>
            <ParentId>int</ParentId>
            <SortOrder>int</SortOrder>
            <Name>string</Name>
            <FolderCount>int</FolderCount>
            <DocumentCount>int</DocumentCount>
            <Created>dateTime</Created>
            <Modified>dateTime</Modified>
          </FolderInfo>
        </Lock>
      </DocumentGetLocksResult>
    </DocumentGetLocksResponse>
  </soap12:Body>
</soap12:Envelope>