LCG WebDept Services Web Service

LCG WebDept Services

Click here for a complete list of operations.

RequestLiterature

Takes a bunch of options, and submits it to the LCG DB as a literature request. Returns a unique identifier for that request

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 /WebDept/Service.asmx HTTP/1.1
Host: soap-test.lcg.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://soap.lcg.org/RequestLiterature"

<?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>
    <RequestLiterature xmlns="https://soap.lcg.org/">
      <obnoxiouslyLongWebServicePassword>string</obnoxiouslyLongWebServicePassword>
      <PIN>string</PIN>
      <title>string</title>
      <first>string</first>
      <last>string</last>
      <suffix>string</suffix>
      <streetAddress>string</streetAddress>
      <address2>string</address2>
      <city>string</city>
      <stateProvince>string</stateProvince>
      <zipPostal>string</zipPostal>
      <country>string</country>
      <phone>string</phone>
      <TW>boolean</TW>
      <BC>boolean</BC>
      <item1>string</item1>
      <item2>string</item2>
      <item3>string</item3>
      <item4>string</item4>
      <media>string</media>
      <email>string</email>
      <source>string</source>
      <fromIP>string</fromIP>
      <webID>string</webID>
      <isTest>boolean</isTest>
      <method>string</method>
      <consent>string</consent>
      <utm>string</utm>
    </RequestLiterature>
  </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>
    <RequestLiteratureResponse xmlns="https://soap.lcg.org/">
      <RequestLiteratureResult>
        <ResultCode>int</ResultCode>
        <RequestIdentifier>long</RequestIdentifier>
        <IsEditable>boolean</IsEditable>
        <EditableDetails>
          <LitItemSpaceRemaining>unsignedByte</LitItemSpaceRemaining>
          <CurrentLitItems>
            <string>string</string>
            <string>string</string>
          </CurrentLitItems>
          <TomorrowsWorld>CannotBeAdded or CanBeAdded or IsAlreadySubscribed</TomorrowsWorld>
          <BibleStudyCourse>CannotBeAdded or CanBeAdded or IsAlreadySubscribed</BibleStudyCourse>
          <PossibleStations>
            <Station xsi:nil="true" />
            <Station xsi:nil="true" />
          </PossibleStations>
        </EditableDetails>
      </RequestLiteratureResult>
    </RequestLiteratureResponse>
  </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 /WebDept/Service.asmx HTTP/1.1
Host: soap-test.lcg.org
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>
    <RequestLiterature xmlns="https://soap.lcg.org/">
      <obnoxiouslyLongWebServicePassword>string</obnoxiouslyLongWebServicePassword>
      <PIN>string</PIN>
      <title>string</title>
      <first>string</first>
      <last>string</last>
      <suffix>string</suffix>
      <streetAddress>string</streetAddress>
      <address2>string</address2>
      <city>string</city>
      <stateProvince>string</stateProvince>
      <zipPostal>string</zipPostal>
      <country>string</country>
      <phone>string</phone>
      <TW>boolean</TW>
      <BC>boolean</BC>
      <item1>string</item1>
      <item2>string</item2>
      <item3>string</item3>
      <item4>string</item4>
      <media>string</media>
      <email>string</email>
      <source>string</source>
      <fromIP>string</fromIP>
      <webID>string</webID>
      <isTest>boolean</isTest>
      <method>string</method>
      <consent>string</consent>
      <utm>string</utm>
    </RequestLiterature>
  </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>
    <RequestLiteratureResponse xmlns="https://soap.lcg.org/">
      <RequestLiteratureResult>
        <ResultCode>int</ResultCode>
        <RequestIdentifier>long</RequestIdentifier>
        <IsEditable>boolean</IsEditable>
        <EditableDetails>
          <LitItemSpaceRemaining>unsignedByte</LitItemSpaceRemaining>
          <CurrentLitItems>
            <string>string</string>
            <string>string</string>
          </CurrentLitItems>
          <TomorrowsWorld>CannotBeAdded or CanBeAdded or IsAlreadySubscribed</TomorrowsWorld>
          <BibleStudyCourse>CannotBeAdded or CanBeAdded or IsAlreadySubscribed</BibleStudyCourse>
          <PossibleStations>
            <Station xsi:nil="true" />
            <Station xsi:nil="true" />
          </PossibleStations>
        </EditableDetails>
      </RequestLiteratureResult>
    </RequestLiteratureResponse>
  </soap12:Body>
</soap12:Envelope>