LiveService


Click here for a complete list of operations.

GetHelp

Get help data of module.

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

<?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>
    <GetHelp xmlns="https://api.lingulab.net/LiveService.asmx">
      <languageKey>string</languageKey>
      <moduleKey>string</moduleKey>
    </GetHelp>
  </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>
    <GetHelpResponse xmlns="https://api.lingulab.net/LiveService.asmx">
      <GetHelpResult>
        <HelpData>
          <Title>string</Title>
          <Intro>string</Intro>
          <HelpText>string</HelpText>
          <ExampleText>string</ExampleText>
          <BackgroundText>string</BackgroundText>
          <CustomTitle>string</CustomTitle>
          <CustomText>string</CustomText>
          <VideoHtml1>string</VideoHtml1>
          <VideoHtml2>string</VideoHtml2>
        </HelpData>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
      </GetHelpResult>
    </GetHelpResponse>
  </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>
    <GetHelp xmlns="https://api.lingulab.net/LiveService.asmx">
      <languageKey>string</languageKey>
      <moduleKey>string</moduleKey>
    </GetHelp>
  </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>
    <GetHelpResponse xmlns="https://api.lingulab.net/LiveService.asmx">
      <GetHelpResult>
        <HelpData>
          <Title>string</Title>
          <Intro>string</Intro>
          <HelpText>string</HelpText>
          <ExampleText>string</ExampleText>
          <BackgroundText>string</BackgroundText>
          <CustomTitle>string</CustomTitle>
          <CustomText>string</CustomText>
          <VideoHtml1>string</VideoHtml1>
          <VideoHtml2>string</VideoHtml2>
        </HelpData>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
      </GetHelpResult>
    </GetHelpResponse>
  </soap12:Body>
</soap12:Envelope>