PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addCustomer

Adds a new customer.

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

<?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>
    <addCustomer xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <customer>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <CustomerName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </CustomerName>
        <Attn>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Attn>
        <Address>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Address>
        <City>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </City>
        <State>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </State>
        <Zip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Zip>
        <Country>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Country>
        <Phone1>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone1>
        <Phone2>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone2>
        <Fax>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Fax>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <WebSite>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </WebSite>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <Prospect>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Prospect>
        <AllowAutoMeterRequests>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </AllowAutoMeterRequests>
        <AllowAutoOnHoldUpdates>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </AllowAutoOnHoldUpdates>
        <ShipTo>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ShipTo>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <RequirePONum>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </RequirePONum>
        <OnHold>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </OnHold>
        <ParentLocationNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ParentLocationNumber>
        <MailToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MailToNumber>
        <BillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillToNumber>
        <CustomerTypeCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerTypeCode>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <ShipMethodCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipMethodCode>
        <InvoiceMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </InvoiceMethod>
        <TermCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TermCode>
        <TerritoryCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TerritoryCode>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <Taxable>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Taxable>
        <TaxCodeDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </TaxCodeDescription>
        <TaxRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </TaxRate>
        <ARContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ARContact>
        <DecisionContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </DecisionContact>
        <EquipmentContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentContact>
        <MeterContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MeterContact>
        <UseBillToAddress>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </UseBillToAddress>
        <BillToAttn>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToAttn>
        <BillToAddress>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToAddress>
        <BillToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToCity>
        <BillToCounty>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToCounty>
        <BillToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToState>
        <BillToZip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToZip>
        <BillToCountry>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToCountry>
        <OnHoldCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OnHoldCode>
        <BranchNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BranchNumber>
        <County>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </County>
        <CustomProperties>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
        </CustomProperties>
      </customer>
    </addCustomer>
  </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>
    <addCustomerResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addCustomerResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addCustomerResult>
    </addCustomerResponse>
  </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>
    <addCustomer xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <customer>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <CustomerName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </CustomerName>
        <Attn>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Attn>
        <Address>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Address>
        <City>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </City>
        <State>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </State>
        <Zip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Zip>
        <Country>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Country>
        <Phone1>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone1>
        <Phone2>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Phone2>
        <Fax>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Fax>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <WebSite>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </WebSite>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <Prospect>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Prospect>
        <AllowAutoMeterRequests>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </AllowAutoMeterRequests>
        <AllowAutoOnHoldUpdates>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </AllowAutoOnHoldUpdates>
        <ShipTo>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ShipTo>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <RequirePONum>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </RequirePONum>
        <OnHold>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </OnHold>
        <ParentLocationNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ParentLocationNumber>
        <MailToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MailToNumber>
        <BillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillToNumber>
        <CustomerTypeCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerTypeCode>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <ShipMethodCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipMethodCode>
        <InvoiceMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </InvoiceMethod>
        <TermCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TermCode>
        <TerritoryCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TerritoryCode>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <Taxable>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Taxable>
        <TaxCodeDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </TaxCodeDescription>
        <TaxRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </TaxRate>
        <ARContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ARContact>
        <DecisionContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </DecisionContact>
        <EquipmentContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentContact>
        <MeterContact>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </MeterContact>
        <UseBillToAddress>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </UseBillToAddress>
        <BillToAttn>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToAttn>
        <BillToAddress>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToAddress>
        <BillToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToCity>
        <BillToCounty>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToCounty>
        <BillToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToState>
        <BillToZip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToZip>
        <BillToCountry>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </BillToCountry>
        <OnHoldCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OnHoldCode>
        <BranchNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BranchNumber>
        <County>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </County>
        <CustomProperties>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
        </CustomProperties>
      </customer>
    </addCustomer>
  </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>
    <addCustomerResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addCustomerResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addCustomerResult>
    </addCustomerResponse>
  </soap12:Body>
</soap12:Envelope>