PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getTerm

Returns the term information for the specified term code.

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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getTerm"

<?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>
    <getTerm xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TermCode>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </TermCode>
    </getTerm>
  </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>
    <getTermResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getTermResult>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <optDiscountRate>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </optDiscountRate>
        <optDiscountPeriod>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </optDiscountPeriod>
        <optDuePeriod>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </optDuePeriod>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
      </getTermResult>
    </getTermResponse>
  </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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.com
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>
    <getTerm xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TermCode>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </TermCode>
    </getTerm>
  </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>
    <getTermResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getTermResult>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <optDiscountRate>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </optDiscountRate>
        <optDiscountPeriod>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </optDiscountPeriod>
        <optDuePeriod>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </optDuePeriod>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
      </getTermResult>
    </getTermResponse>
  </soap12:Body>
</soap12:Envelope>