LiveService


Click here for a complete list of operations.

GetModuleItems

Returns module items for highlighting.

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 /LiveService.asmx HTTP/1.1
Host: api.lingulab.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.lingulab.net/LiveService.asmx/GetModuleItems"

<?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>
    <GetModuleItems xmlns="https://api.lingulab.net/LiveService.asmx">
      <authenticationKey>string</authenticationKey>
      <resultKey>int</resultKey>
      <moduleKey>string</moduleKey>
      <versionNumber>int</versionNumber>
    </GetModuleItems>
  </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>
    <GetModuleItemsResponse xmlns="https://api.lingulab.net/LiveService.asmx">
      <GetModuleItemsResult>
        <Items>
          <AnalysisItem>
            <Text>string</Text>
            <PreContext>string</PreContext>
            <Description>string</Description>
            <Explanation>string</Explanation>
            <Suggestions xsi:nil="true" />
            <SuggHint>string</SuggHint>
            <ItemType>string</ItemType>
            <RemoveOptionEnabled>boolean</RemoveOptionEnabled>
            <IgnoreNowEnabled>boolean</IgnoreNowEnabled>
            <AddToWordlistEnabled>boolean</AddToWordlistEnabled>
          </AnalysisItem>
          <AnalysisItem>
            <Text>string</Text>
            <PreContext>string</PreContext>
            <Description>string</Description>
            <Explanation>string</Explanation>
            <Suggestions xsi:nil="true" />
            <SuggHint>string</SuggHint>
            <ItemType>string</ItemType>
            <RemoveOptionEnabled>boolean</RemoveOptionEnabled>
            <IgnoreNowEnabled>boolean</IgnoreNowEnabled>
            <AddToWordlistEnabled>boolean</AddToWordlistEnabled>
          </AnalysisItem>
        </Items>
        <Rating>Red or Yellow or Green</Rating>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <HelpTip>string</HelpTip>
      </GetModuleItemsResult>
    </GetModuleItemsResponse>
  </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 /LiveService.asmx HTTP/1.1
Host: api.lingulab.net
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>
    <GetModuleItems xmlns="https://api.lingulab.net/LiveService.asmx">
      <authenticationKey>string</authenticationKey>
      <resultKey>int</resultKey>
      <moduleKey>string</moduleKey>
      <versionNumber>int</versionNumber>
    </GetModuleItems>
  </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>
    <GetModuleItemsResponse xmlns="https://api.lingulab.net/LiveService.asmx">
      <GetModuleItemsResult>
        <Items>
          <AnalysisItem>
            <Text>string</Text>
            <PreContext>string</PreContext>
            <Description>string</Description>
            <Explanation>string</Explanation>
            <Suggestions xsi:nil="true" />
            <SuggHint>string</SuggHint>
            <ItemType>string</ItemType>
            <RemoveOptionEnabled>boolean</RemoveOptionEnabled>
            <IgnoreNowEnabled>boolean</IgnoreNowEnabled>
            <AddToWordlistEnabled>boolean</AddToWordlistEnabled>
          </AnalysisItem>
          <AnalysisItem>
            <Text>string</Text>
            <PreContext>string</PreContext>
            <Description>string</Description>
            <Explanation>string</Explanation>
            <Suggestions xsi:nil="true" />
            <SuggHint>string</SuggHint>
            <ItemType>string</ItemType>
            <RemoveOptionEnabled>boolean</RemoveOptionEnabled>
            <IgnoreNowEnabled>boolean</IgnoreNowEnabled>
            <AddToWordlistEnabled>boolean</AddToWordlistEnabled>
          </AnalysisItem>
        </Items>
        <Rating>Red or Yellow or Green</Rating>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <HelpTip>string</HelpTip>
      </GetModuleItemsResult>
    </GetModuleItemsResponse>
  </soap12:Body>
</soap12:Envelope>