PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getEquipmentsByNumber

This function retrieves an array of the complete Customer Data for any Customer matching the CustomerName 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 /PublicAPIService.asmx HTTP/1.1
Host: pip.j2b.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getEquipmentsByNumber"

<?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>
    <getEquipmentsByNumber xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <EquipmentNumber>string</EquipmentNumber>
    </getEquipmentsByNumber>
  </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>
    <getEquipmentsByNumberResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getEquipmentsByNumberResult>
        <EquipmentData>
          <EquipmentNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </EquipmentNumber>
          <ItemNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ItemNumber>
          <SerialNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </SerialNumber>
          <CustomerNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </CustomerNumber>
          <BillToNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </BillToNumber>
          <BillCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </BillCode>
          <ResponseTime>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ResponseTime>
          <LocationNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </LocationNumber>
          <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>
          <Location>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Location>
          <OfficeOpen>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OfficeOpen>
          <OfficeClose>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OfficeClose>
          <InstallDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </InstallDate>
          <Contact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Contact>
          <ContactPhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ContactPhone>
          <ContactFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ContactFax>
          <DecisionMaker>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </DecisionMaker>
          <DecisionMakerPhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </DecisionMakerPhone>
          <DecisionMakerFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </DecisionMakerFax>
          <TerritoryCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </TerritoryCode>
          <TechnicianNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </TechnicianNumber>
          <WarrantyDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </WarrantyDate>
          <WarrantyMeter>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </WarrantyMeter>
          <PMMeterDue>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </PMMeterDue>
          <PMDateDue>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </PMDateDue>
          <PMUseMeter>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </PMUseMeter>
          <PMUseDate>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </PMUseDate>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <StatusCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </StatusCode>
          <ConditionCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ConditionCode>
          <ParentNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ParentNumber>
          <Hosting>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Hosting>
          <Attached>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Attached>
          <ModelNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ModelNumber>
          <ModelDescription>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ModelDescription>
          <MakeNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </MakeNumber>
          <MakeDescription>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </MakeDescription>
          <IsMetered>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </IsMetered>
          <RequireMeteronServiceCalls>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </RequireMeteronServiceCalls>
          <PriorityCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PriorityCode>
          <PriorityWeight>
            <Value>double</Value>
            <Valid>boolean</Valid>
          </PriorityWeight>
          <EquipmentContactNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </EquipmentContactNumber>
          <DecisionContactNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </DecisionContactNumber>
          <AllowAutoMeterRequests>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </AllowAutoMeterRequests>
          <EinfoEnabled>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </EinfoEnabled>
          <MACAddress>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </MACAddress>
          <IPAddress>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </IPAddress>
          <ShipToContact>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipToContact>
          <Meters>
            <Details xsi:nil="true" />
          </Meters>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </EquipmentData>
        <EquipmentData>
          <EquipmentNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </EquipmentNumber>
          <ItemNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ItemNumber>
          <SerialNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </SerialNumber>
          <CustomerNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </CustomerNumber>
          <BillToNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </BillToNumber>
          <BillCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </BillCode>
          <ResponseTime>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ResponseTime>
          <LocationNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </LocationNumber>
          <Address>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Address>
          <City>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </City>
          <State />
          <Zip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Zip>
          <Country>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Country>
          <Location>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Location>
          <OfficeOpen>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OfficeOpen>
          <OfficeClose>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </OfficeClose>
          <InstallDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </InstallDate>
          <Contact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Contact>
          <ContactPhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ContactPhone>
          <ContactFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ContactFax>
          <DecisionMaker>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </DecisionMaker>
          <DecisionMakerPhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </DecisionMakerPhone>
          <DecisionMakerFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </DecisionMakerFax>
          <TerritoryCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </TerritoryCode>
          <TechnicianNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </TechnicianNumber>
          <WarrantyDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </WarrantyDate>
          <WarrantyMeter>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </WarrantyMeter>
          <PMMeterDue>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </PMMeterDue>
          <PMDateDue>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </PMDateDue>
          <PMUseMeter>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </PMUseMeter>
          <PMUseDate>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </PMUseDate>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <StatusCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </StatusCode>
          <ConditionCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ConditionCode>
          <ParentNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ParentNumber>
          <Hosting>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Hosting>
          <Attached>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Attached>
          <ModelNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ModelNumber>
          <ModelDescription>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ModelDescription>
          <MakeNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </MakeNumber>
          <MakeDescription>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </MakeDescription>
          <IsMetered>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </IsMetered>
          <RequireMeteronServiceCalls>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </RequireMeteronServiceCalls>
          <PriorityCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PriorityCode>
          <PriorityWeight>
            <Value>double</Value>
            <Valid>boolean</Valid>
          </PriorityWeight>
          <EquipmentContactNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </EquipmentContactNumber>
          <DecisionContactNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </DecisionContactNumber>
          <AllowAutoMeterRequests>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </AllowAutoMeterRequests>
          <EinfoEnabled>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </EinfoEnabled>
          <MACAddress>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </MACAddress>
          <IPAddress>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </IPAddress>
          <ShipToContact>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipToContact>
          <Meters>
            <Details xsi:nil="true" />
          </Meters>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </EquipmentData>
      </getEquipmentsByNumberResult>
    </getEquipmentsByNumberResponse>
  </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 /PublicAPIService.asmx HTTP/1.1
Host: pip.j2b.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 />
</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 />
</soap12:Envelope>