PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

saveEquipment

Updates the specified equipment.

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

<?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>
    <saveEquipment xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Equipment>
        <EquipmentNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentNumber>
        <ItemNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ItemNumber>
        <SerialNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </SerialNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <BillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillToNumber>
        <BillCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillCode>
        <ResponseTime>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ResponseTime>
        <LocationNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </OfficeOpen>
        <OfficeClose>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </OfficeClose>
        <InstallDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TerritoryCode>
        <TechnicianNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TechnicianNumber>
        <WarrantyDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <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>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </StatusCode>
        <ConditionCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ConditionCode>
        <ParentNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ParentNumber>
        <Hosting>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Hosting>
        <Attached>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Attached>
        <ModelNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ModelNumber>
        <ModelDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ModelDescription>
        <MakeNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PriorityCode>
        <PriorityWeight>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </PriorityWeight>
        <EquipmentContactNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentContactNumber>
        <DecisionContactNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipToContact>
        <Meters>
          <Details>
            <EquipmentMeterDetail xsi:nil="true" />
            <EquipmentMeterDetail xsi:nil="true" />
          </Details>
        </Meters>
        <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>
      </Equipment>
    </saveEquipment>
  </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>
    <saveEquipmentResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <saveEquipmentResult>
        <ApiResult>boolean</ApiResult>
        <Details>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
        </Details>
      </saveEquipmentResult>
    </saveEquipmentResponse>
  </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>
    <saveEquipment xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Equipment>
        <EquipmentNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentNumber>
        <ItemNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ItemNumber>
        <SerialNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </SerialNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <BillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillToNumber>
        <BillCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillCode>
        <ResponseTime>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ResponseTime>
        <LocationNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </OfficeOpen>
        <OfficeClose>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </OfficeClose>
        <InstallDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TerritoryCode>
        <TechnicianNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TechnicianNumber>
        <WarrantyDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <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>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </StatusCode>
        <ConditionCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ConditionCode>
        <ParentNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ParentNumber>
        <Hosting>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Hosting>
        <Attached>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Attached>
        <ModelNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ModelNumber>
        <ModelDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ModelDescription>
        <MakeNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PriorityCode>
        <PriorityWeight>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </PriorityWeight>
        <EquipmentContactNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </EquipmentContactNumber>
        <DecisionContactNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipToContact>
        <Meters>
          <Details>
            <EquipmentMeterDetail xsi:nil="true" />
            <EquipmentMeterDetail xsi:nil="true" />
          </Details>
        </Meters>
        <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>
      </Equipment>
    </saveEquipment>
  </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>
    <saveEquipmentResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <saveEquipmentResult>
        <ApiResult>boolean</ApiResult>
        <Details>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
          <ResultDetail>
            <ResultType>int</ResultType>
            <ResultCode>int</ResultCode>
            <ResultString>string</ResultString>
          </ResultDetail>
        </Details>
      </saveEquipmentResult>
    </saveEquipmentResponse>
  </soap12:Body>
</soap12:Envelope>