PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getContractLease

Returns the details for the specified ContractLease.

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

<?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>
    <getContractLease xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <LeaseNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </LeaseNumber>
    </getContractLease>
  </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>
    <getContractLeaseResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContractLeaseResult>
        <ContractLeaseNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContractLeaseNumber>
        <Equipment>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Equipment>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <LeaseCompany>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </LeaseCompany>
        <StartDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </StartDate>
        <TerminationDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </TerminationDate>
        <LeasePayment>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </LeasePayment>
        <LeaseFunded>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </LeaseFunded>
        <Term>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </Term>
        <LeaseCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </LeaseCode>
        <Notes>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Notes>
        <DepositAmount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </DepositAmount>
        <FinancedAmount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </FinancedAmount>
        <InterestRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </InterestRate>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <Details>
          <ContractLeaseDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <FinancedAmount xsi:nil="true" />
            <PaymentAmount xsi:nil="true" />
            <LeaseEquipmentNumber xsi:nil="true" />
          </ContractLeaseDetail>
          <ContractLeaseDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <FinancedAmount xsi:nil="true" />
            <PaymentAmount xsi:nil="true" />
            <LeaseEquipmentNumber xsi:nil="true" />
          </ContractLeaseDetail>
        </Details>
      </getContractLeaseResult>
    </getContractLeaseResponse>
  </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>
    <getContractLease xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <LeaseNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </LeaseNumber>
    </getContractLease>
  </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>
    <getContractLeaseResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContractLeaseResult>
        <ContractLeaseNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContractLeaseNumber>
        <Equipment>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Equipment>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <LeaseCompany>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </LeaseCompany>
        <StartDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </StartDate>
        <TerminationDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </TerminationDate>
        <LeasePayment>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </LeasePayment>
        <LeaseFunded>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </LeaseFunded>
        <Term>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </Term>
        <LeaseCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </LeaseCode>
        <Notes>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Notes>
        <DepositAmount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </DepositAmount>
        <FinancedAmount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </FinancedAmount>
        <InterestRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </InterestRate>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <Details>
          <ContractLeaseDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <FinancedAmount xsi:nil="true" />
            <PaymentAmount xsi:nil="true" />
            <LeaseEquipmentNumber xsi:nil="true" />
          </ContractLeaseDetail>
          <ContractLeaseDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
            <FinancedAmount xsi:nil="true" />
            <PaymentAmount xsi:nil="true" />
            <LeaseEquipmentNumber xsi:nil="true" />
          </ContractLeaseDetail>
        </Details>
      </getContractLeaseResult>
    </getContractLeaseResponse>
  </soap12:Body>
</soap12:Envelope>