PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

setExportModule

Inserts or updates an ExportModule, depending on whether or not the ExportModuleID was supplied.

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

<?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>
    <setExportModule xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ExportModule>
        <ExportModule>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ExportModule>
        <Name>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Name>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <ConfigureCall>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ConfigureCall>
        <ExportCall>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ExportCall>
        <FileName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </FileName>
        <ConfigString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ConfigString>
        <TypeID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </TypeID>
        <ExportModes>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ExportModes>
        <Configurable>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Configurable>
        <BatchCapable>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </BatchCapable>
      </ExportModule>
    </setExportModule>
  </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>
    <setExportModuleResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService" />
  </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>
    <setExportModule xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ExportModule>
        <ExportModule>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ExportModule>
        <Name>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Name>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <ConfigureCall>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ConfigureCall>
        <ExportCall>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ExportCall>
        <FileName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </FileName>
        <ConfigString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ConfigString>
        <TypeID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </TypeID>
        <ExportModes>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ExportModes>
        <Configurable>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Configurable>
        <BatchCapable>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </BatchCapable>
      </ExportModule>
    </setExportModule>
  </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>
    <setExportModuleResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService" />
  </soap12:Body>
</soap12:Envelope>