TimeBase Web Service

TimeBase

Click here for a complete list of operations.

GetChapterMetaTypesForDocument

Returns information about allowed chapter-specific metadata for web editor document.

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

<?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>
    <GetChapterMetaTypesForDocument xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <DocumentId>int</DocumentId>
    </GetChapterMetaTypesForDocument>
  </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>
    <GetChapterMetaTypesForDocumentResponse xmlns="http://www.timehouse.fi/">
      <GetChapterMetaTypesForDocumentResult>
        <Meta>
          <ChapterMetaType>
            <Key>string</Key>
            <Description>string</Description>
            <Type>string</Type>
            <Choice xsi:nil="true" />
            <MinOccurs>int</MinOccurs>
            <MaxOccurs>int</MaxOccurs>
            <ReadOnly>boolean</ReadOnly>
            <DefaultValue>string</DefaultValue>
            <Tooltip>string</Tooltip>
            <AllowedPathXPath xsi:nil="true" />
            <OnList>boolean</OnList>
          </ChapterMetaType>
          <ChapterMetaType>
            <Key>string</Key>
            <Description>string</Description>
            <Type>string</Type>
            <Choice xsi:nil="true" />
            <MinOccurs>int</MinOccurs>
            <MaxOccurs>int</MaxOccurs>
            <ReadOnly>boolean</ReadOnly>
            <DefaultValue>string</DefaultValue>
            <Tooltip>string</Tooltip>
            <AllowedPathXPath xsi:nil="true" />
            <OnList>boolean</OnList>
          </ChapterMetaType>
        </Meta>
      </GetChapterMetaTypesForDocumentResult>
    </GetChapterMetaTypesForDocumentResponse>
  </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>
    <GetChapterMetaTypesForDocument xmlns="http://www.timehouse.fi/">
      <SessionId>long</SessionId>
      <DocumentId>int</DocumentId>
    </GetChapterMetaTypesForDocument>
  </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>
    <GetChapterMetaTypesForDocumentResponse xmlns="http://www.timehouse.fi/">
      <GetChapterMetaTypesForDocumentResult>
        <Meta>
          <ChapterMetaType>
            <Key>string</Key>
            <Description>string</Description>
            <Type>string</Type>
            <Choice xsi:nil="true" />
            <MinOccurs>int</MinOccurs>
            <MaxOccurs>int</MaxOccurs>
            <ReadOnly>boolean</ReadOnly>
            <DefaultValue>string</DefaultValue>
            <Tooltip>string</Tooltip>
            <AllowedPathXPath xsi:nil="true" />
            <OnList>boolean</OnList>
          </ChapterMetaType>
          <ChapterMetaType>
            <Key>string</Key>
            <Description>string</Description>
            <Type>string</Type>
            <Choice xsi:nil="true" />
            <MinOccurs>int</MinOccurs>
            <MaxOccurs>int</MaxOccurs>
            <ReadOnly>boolean</ReadOnly>
            <DefaultValue>string</DefaultValue>
            <Tooltip>string</Tooltip>
            <AllowedPathXPath xsi:nil="true" />
            <OnList>boolean</OnList>
          </ChapterMetaType>
        </Meta>
      </GetChapterMetaTypesForDocumentResult>
    </GetChapterMetaTypesForDocumentResponse>
  </soap12:Body>
</soap12:Envelope>