PublicAPIService


Click here for a complete list of operations.

getEquipmentsFromSerialNumber

Returns all equipment records matching the information from the specified parameters. Make and Model are optional fields.

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: langcompany.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getEquipmentsFromSerialNumber"

<?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>
    <getEquipmentsFromSerialNumber xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SerialNumber>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </SerialNumber>
      <optMake>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </optMake>
      <optModel>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </optModel>
    </getEquipmentsFromSerialNumber>
  </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>
    <getEquipmentsFromSerialNumberResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getEquipmentsFromSerialNumberResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <EquipmentData>
            <EquipmentNumber xsi:nil="true" />
            <ItemNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <ResponseTime xsi:nil="true" />
            <LocationNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Location xsi:nil="true" />
            <OfficeOpen xsi:nil="true" />
            <OfficeClose xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <ContactFax xsi:nil="true" />
            <DecisionMaker xsi:nil="true" />
            <DecisionMakerPhone xsi:nil="true" />
            <DecisionMakerFax xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <WarrantyMeter xsi:nil="true" />
            <PMMeterDue xsi:nil="true" />
            <PMDateDue xsi:nil="true" />
            <PMUseMeter xsi:nil="true" />
            <PMUseDate xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <Active xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <ConditionCode xsi:nil="true" />
            <ParentNumber xsi:nil="true" />
            <Hosting xsi:nil="true" />
            <Attached xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <ModelDescription xsi:nil="true" />
            <MakeNumber xsi:nil="true" />
            <MakeDescription xsi:nil="true" />
            <IsMetered xsi:nil="true" />
            <RequireMeteronServiceCalls xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PriorityWeight xsi:nil="true" />
            <EquipmentContactNumber xsi:nil="true" />
            <DecisionContactNumber xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <EinfoEnabled xsi:nil="true" />
            <MACAddress xsi:nil="true" />
            <IPAddress xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Meters xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </EquipmentData>
          <EquipmentData>
            <EquipmentNumber xsi:nil="true" />
            <ItemNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <ResponseTime xsi:nil="true" />
            <LocationNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Location xsi:nil="true" />
            <OfficeOpen xsi:nil="true" />
            <OfficeClose xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <ContactFax xsi:nil="true" />
            <DecisionMaker xsi:nil="true" />
            <DecisionMakerPhone xsi:nil="true" />
            <DecisionMakerFax xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <WarrantyMeter xsi:nil="true" />
            <PMMeterDue xsi:nil="true" />
            <PMDateDue xsi:nil="true" />
            <PMUseMeter xsi:nil="true" />
            <PMUseDate xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <Active xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <ConditionCode xsi:nil="true" />
            <ParentNumber xsi:nil="true" />
            <Hosting xsi:nil="true" />
            <Attached xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <ModelDescription xsi:nil="true" />
            <MakeNumber xsi:nil="true" />
            <MakeDescription xsi:nil="true" />
            <IsMetered xsi:nil="true" />
            <RequireMeteronServiceCalls xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PriorityWeight xsi:nil="true" />
            <EquipmentContactNumber xsi:nil="true" />
            <DecisionContactNumber xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <EinfoEnabled xsi:nil="true" />
            <MACAddress xsi:nil="true" />
            <IPAddress xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Meters xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </EquipmentData>
        </Details>
      </getEquipmentsFromSerialNumberResult>
    </getEquipmentsFromSerialNumberResponse>
  </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: langcompany.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>
    <getEquipmentsFromSerialNumber xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SerialNumber>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </SerialNumber>
      <optMake>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </optMake>
      <optModel>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </optModel>
    </getEquipmentsFromSerialNumber>
  </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>
    <getEquipmentsFromSerialNumberResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getEquipmentsFromSerialNumberResult>
        <TimeStamp>string</TimeStamp>
        <Details>
          <EquipmentData>
            <EquipmentNumber xsi:nil="true" />
            <ItemNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <ResponseTime xsi:nil="true" />
            <LocationNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Location xsi:nil="true" />
            <OfficeOpen xsi:nil="true" />
            <OfficeClose xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <ContactFax xsi:nil="true" />
            <DecisionMaker xsi:nil="true" />
            <DecisionMakerPhone xsi:nil="true" />
            <DecisionMakerFax xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <WarrantyMeter xsi:nil="true" />
            <PMMeterDue xsi:nil="true" />
            <PMDateDue xsi:nil="true" />
            <PMUseMeter xsi:nil="true" />
            <PMUseDate xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <Active xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <ConditionCode xsi:nil="true" />
            <ParentNumber xsi:nil="true" />
            <Hosting xsi:nil="true" />
            <Attached xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <ModelDescription xsi:nil="true" />
            <MakeNumber xsi:nil="true" />
            <MakeDescription xsi:nil="true" />
            <IsMetered xsi:nil="true" />
            <RequireMeteronServiceCalls xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PriorityWeight xsi:nil="true" />
            <EquipmentContactNumber xsi:nil="true" />
            <DecisionContactNumber xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <EinfoEnabled xsi:nil="true" />
            <MACAddress xsi:nil="true" />
            <IPAddress xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Meters xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </EquipmentData>
          <EquipmentData>
            <EquipmentNumber xsi:nil="true" />
            <ItemNumber xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <CustomerNumber xsi:nil="true" />
            <BillToNumber xsi:nil="true" />
            <BillCode xsi:nil="true" />
            <ResponseTime xsi:nil="true" />
            <LocationNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Location xsi:nil="true" />
            <OfficeOpen xsi:nil="true" />
            <OfficeClose xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Contact xsi:nil="true" />
            <ContactPhone xsi:nil="true" />
            <ContactFax xsi:nil="true" />
            <DecisionMaker xsi:nil="true" />
            <DecisionMakerPhone xsi:nil="true" />
            <DecisionMakerFax xsi:nil="true" />
            <TerritoryCode xsi:nil="true" />
            <TechnicianNumber xsi:nil="true" />
            <WarrantyDate xsi:nil="true" />
            <WarrantyMeter xsi:nil="true" />
            <PMMeterDue xsi:nil="true" />
            <PMDateDue xsi:nil="true" />
            <PMUseMeter xsi:nil="true" />
            <PMUseDate xsi:nil="true" />
            <Remarks xsi:nil="true" />
            <Active xsi:nil="true" />
            <StatusCode xsi:nil="true" />
            <ConditionCode xsi:nil="true" />
            <ParentNumber xsi:nil="true" />
            <Hosting xsi:nil="true" />
            <Attached xsi:nil="true" />
            <ModelNumber xsi:nil="true" />
            <ModelDescription xsi:nil="true" />
            <MakeNumber xsi:nil="true" />
            <MakeDescription xsi:nil="true" />
            <IsMetered xsi:nil="true" />
            <RequireMeteronServiceCalls xsi:nil="true" />
            <PriorityCode xsi:nil="true" />
            <PriorityWeight xsi:nil="true" />
            <EquipmentContactNumber xsi:nil="true" />
            <DecisionContactNumber xsi:nil="true" />
            <AllowAutoMeterRequests xsi:nil="true" />
            <EinfoEnabled xsi:nil="true" />
            <MACAddress xsi:nil="true" />
            <IPAddress xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Meters xsi:nil="true" />
            <CustomProperties xsi:nil="true" />
          </EquipmentData>
        </Details>
      </getEquipmentsFromSerialNumberResult>
    </getEquipmentsFromSerialNumberResponse>
  </soap12:Body>
</soap12:Envelope>