PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getContractByBillGroup

Returns the extended details for contracts by BillGroup

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

<?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>
    <getContractByBillGroup xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <BillGroup>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </BillGroup>
      <optGetSince>
        <Value>dateTime</Value>
        <ValueAsString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ValueAsString>
        <Valid>boolean</Valid>
      </optGetSince>
      <GetNew>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </GetNew>
      <GetModified>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </GetModified>
      <optContract>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </optContract>
    </getContractByBillGroup>
  </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>
    <getContractByBillGroupResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContractByBillGroupResult>
        <ContractDataExt>
          <CustomerInfo>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Attn xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Active xsi:nil="true" />
            <Prospect xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <AllowAutoOnHoldUpdates xsi:nil="true" />
            <ShipTo xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <RequirePONum xsi:nil="true" />
            <OnHold xsi:nil="true" />
            <ParentLocationNumber xsi:nil="true" />
            <MailToNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerTypeCode xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <ShipMethodCode xsi:nil="true" />
            <InvoiceMethod xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TaxCode xsi:nil="true" />
            <Taxable xsi:nil="true" />
            <TaxCodeDescription xsi:nil="true" />
            <TaxRate xsi:nil="true" />
            <ARContact xsi:nil="true" />
            <DecisionContact xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <MeterContact xsi:nil="true" />
            <UseBillToAddress xsi:nil="true" />
            <BillToAttn xsi:nil="true" />
            <BillToAddress xsi:nil="true" />
            <BillToCity xsi:nil="true" />
            <BillToCounty xsi:nil="true" />
            <BillToState xsi:nil="true" />
            <BillToZip xsi:nil="true" />
            <BillToCountry xsi:nil="true" />
            <OnHoldCode xsi:nil="true" />
            <BranchNumber xsi:nil="true" />
            <County xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </CustomerInfo>
          <BillingCycleInfo>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </BillingCycleInfo>
          <ChargeDueDay>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </ChargeDueDay>
          <OverageLastBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageLastBillingDate>
          <OverageNextBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageNextBillingDate>
          <OverageBillingCycle>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </OverageBillingCycle>
          <CreateDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </CreateDate>
          <LastUpdate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </LastUpdate>
          <MeterGroups>
            <ContractMeterGroupData xsi:nil="true" />
            <ContractMeterGroupData xsi:nil="true" />
          </MeterGroups>
          <ExtDetails>
            <ContractDetailExt xsi:nil="true" />
            <ContractDetailExt xsi:nil="true" />
          </ExtDetails>
          <ContractMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </ContractMasterRateSchedules>
          <MeterGroupMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </MeterGroupMasterRateSchedules>
        </ContractDataExt>
        <ContractDataExt>
          <CustomerInfo>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Attn xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Active xsi:nil="true" />
            <Prospect xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <AllowAutoOnHoldUpdates xsi:nil="true" />
            <ShipTo xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <RequirePONum xsi:nil="true" />
            <OnHold xsi:nil="true" />
            <ParentLocationNumber xsi:nil="true" />
            <MailToNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerTypeCode xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <ShipMethodCode xsi:nil="true" />
            <InvoiceMethod xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TaxCode xsi:nil="true" />
            <Taxable xsi:nil="true" />
            <TaxCodeDescription xsi:nil="true" />
            <TaxRate xsi:nil="true" />
            <ARContact xsi:nil="true" />
            <DecisionContact xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <MeterContact xsi:nil="true" />
            <UseBillToAddress xsi:nil="true" />
            <BillToAttn xsi:nil="true" />
            <BillToAddress xsi:nil="true" />
            <BillToCity xsi:nil="true" />
            <BillToCounty xsi:nil="true" />
            <BillToState xsi:nil="true" />
            <BillToZip xsi:nil="true" />
            <BillToCountry xsi:nil="true" />
            <OnHoldCode xsi:nil="true" />
            <BranchNumber xsi:nil="true" />
            <County xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </CustomerInfo>
          <BillingCycleInfo>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </BillingCycleInfo>
          <ChargeDueDay>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </ChargeDueDay>
          <OverageLastBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageLastBillingDate>
          <OverageNextBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageNextBillingDate>
          <OverageBillingCycle>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </OverageBillingCycle>
          <CreateDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </CreateDate>
          <LastUpdate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </LastUpdate>
          <MeterGroups>
            <ContractMeterGroupData xsi:nil="true" />
            <ContractMeterGroupData xsi:nil="true" />
          </MeterGroups>
          <ExtDetails>
            <ContractDetailExt xsi:nil="true" />
            <ContractDetailExt xsi:nil="true" />
          </ExtDetails>
          <ContractMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </ContractMasterRateSchedules>
          <MeterGroupMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </MeterGroupMasterRateSchedules>
        </ContractDataExt>
      </getContractByBillGroupResult>
    </getContractByBillGroupResponse>
  </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>
    <getContractByBillGroup xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <BillGroup>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </BillGroup>
      <optGetSince>
        <Value>dateTime</Value>
        <ValueAsString>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ValueAsString>
        <Valid>boolean</Valid>
      </optGetSince>
      <GetNew>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </GetNew>
      <GetModified>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </GetModified>
      <optContract>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </optContract>
    </getContractByBillGroup>
  </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>
    <getContractByBillGroupResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContractByBillGroupResult>
        <ContractDataExt>
          <CustomerInfo>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Attn xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Active xsi:nil="true" />
            <Prospect xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <AllowAutoOnHoldUpdates xsi:nil="true" />
            <ShipTo xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <RequirePONum xsi:nil="true" />
            <OnHold xsi:nil="true" />
            <ParentLocationNumber xsi:nil="true" />
            <MailToNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerTypeCode xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <ShipMethodCode xsi:nil="true" />
            <InvoiceMethod xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TaxCode xsi:nil="true" />
            <Taxable xsi:nil="true" />
            <TaxCodeDescription xsi:nil="true" />
            <TaxRate xsi:nil="true" />
            <ARContact xsi:nil="true" />
            <DecisionContact xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <MeterContact xsi:nil="true" />
            <UseBillToAddress xsi:nil="true" />
            <BillToAttn xsi:nil="true" />
            <BillToAddress xsi:nil="true" />
            <BillToCity xsi:nil="true" />
            <BillToCounty xsi:nil="true" />
            <BillToState xsi:nil="true" />
            <BillToZip xsi:nil="true" />
            <BillToCountry xsi:nil="true" />
            <OnHoldCode xsi:nil="true" />
            <BranchNumber xsi:nil="true" />
            <County xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </CustomerInfo>
          <BillingCycleInfo>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </BillingCycleInfo>
          <ChargeDueDay>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </ChargeDueDay>
          <OverageLastBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageLastBillingDate>
          <OverageNextBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageNextBillingDate>
          <OverageBillingCycle>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </OverageBillingCycle>
          <CreateDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </CreateDate>
          <LastUpdate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </LastUpdate>
          <MeterGroups>
            <ContractMeterGroupData xsi:nil="true" />
            <ContractMeterGroupData xsi:nil="true" />
          </MeterGroups>
          <ExtDetails>
            <ContractDetailExt xsi:nil="true" />
            <ContractDetailExt xsi:nil="true" />
          </ExtDetails>
          <ContractMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </ContractMasterRateSchedules>
          <MeterGroupMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </MeterGroupMasterRateSchedules>
        </ContractDataExt>
        <ContractDataExt>
          <CustomerInfo>
            <CustomerNumber xsi:nil="true" />
            <CustomerName xsi:nil="true" />
            <Attn xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Phone1 xsi:nil="true" />
            <Phone2 xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Active xsi:nil="true" />
            <Prospect xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <AllowAutoOnHoldUpdates xsi:nil="true" />
            <ShipTo xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <RequirePONum xsi:nil="true" />
            <OnHold xsi:nil="true" />
            <ParentLocationNumber xsi:nil="true" />
            <MailToNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <CustomerTypeCode xsi:nil="true" />
            <SalesRep xsi:nil="true" />
            <ShipMethodCode xsi:nil="true" />
            <InvoiceMethod xsi:nil="true" />
            <TermCode xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TaxCode xsi:nil="true" />
            <Taxable xsi:nil="true" />
            <TaxCodeDescription xsi:nil="true" />
            <TaxRate xsi:nil="true" />
            <ARContact xsi:nil="true" />
            <DecisionContact xsi:nil="true" />
            <EquipmentContact xsi:nil="true" />
            <MeterContact xsi:nil="true" />
            <UseBillToAddress xsi:nil="true" />
            <BillToAttn xsi:nil="true" />
            <BillToAddress xsi:nil="true" />
            <BillToCity xsi:nil="true" />
            <BillToCounty xsi:nil="true" />
            <BillToState xsi:nil="true" />
            <BillToZip xsi:nil="true" />
            <BillToCountry xsi:nil="true" />
            <OnHoldCode xsi:nil="true" />
            <BranchNumber xsi:nil="true" />
            <County xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </CustomerInfo>
          <BillingCycleInfo>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </BillingCycleInfo>
          <ChargeDueDay>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </ChargeDueDay>
          <OverageLastBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageLastBillingDate>
          <OverageNextBillingDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OverageNextBillingDate>
          <OverageBillingCycle>
            <Name xsi:nil="true" />
            <Description xsi:nil="true" />
            <Days xsi:nil="true" />
            <Months xsi:nil="true" />
            <Years xsi:nil="true" />
          </OverageBillingCycle>
          <CreateDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </CreateDate>
          <LastUpdate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </LastUpdate>
          <MeterGroups>
            <ContractMeterGroupData xsi:nil="true" />
            <ContractMeterGroupData xsi:nil="true" />
          </MeterGroups>
          <ExtDetails>
            <ContractDetailExt xsi:nil="true" />
            <ContractDetailExt xsi:nil="true" />
          </ExtDetails>
          <ContractMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </ContractMasterRateSchedules>
          <MeterGroupMasterRateSchedules>
            <ContractRateScheduleData xsi:nil="true" />
            <ContractRateScheduleData xsi:nil="true" />
          </MeterGroupMasterRateSchedules>
        </ContractDataExt>
      </getContractByBillGroupResult>
    </getContractByBillGroupResponse>
  </soap12:Body>
</soap12:Envelope>