PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getContract

Returns the details for the specified Contract.

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

<?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>
    <getContract xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ContractNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </ContractNumber>
    </getContract>
  </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>
    <getContractResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContractResult>
        <ContractNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContractNumber>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <Contact>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Contact>
        <ContactPhone>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ContactPhone>
        <ContactFax>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ContactFax>
        <BillingPeriod>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </BillingPeriod>
        <BillingPeriodThrough>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </BillingPeriodThrough>
        <StartDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </StartDate>
        <ExpDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </ExpDate>
        <ExpCopies>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ExpCopies>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <Type>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Type>
        <TypeDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </TypeDescription>
        <Status>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Status>
        <SalesRepID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRepID>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <BaseRate>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </BaseRate>
        <BaseRatePeriod>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </BaseRatePeriod>
        <UnearnedBalance>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </UnearnedBalance>
        <LeaseSchedule>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </LeaseSchedule>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <BillingCycle>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillingCycle>
        <BillCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillCode>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <BaseArrears>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </BaseArrears>
        <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>
        <Details>
          <ContractDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
          </ContractDetail>
          <ContractDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
          </ContractDetail>
        </Details>
      </getContractResult>
    </getContractResponse>
  </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: pip.sta.solutions
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>
    <getContract xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ContractNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </ContractNumber>
    </getContract>
  </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>
    <getContractResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getContractResult>
        <ContractNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ContractNumber>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <Contact>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Contact>
        <ContactPhone>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ContactPhone>
        <ContactFax>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ContactFax>
        <BillingPeriod>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </BillingPeriod>
        <BillingPeriodThrough>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </BillingPeriodThrough>
        <StartDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </StartDate>
        <ExpDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </ExpDate>
        <ExpCopies>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ExpCopies>
        <Active>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Active>
        <Type>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Type>
        <TypeDescription>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </TypeDescription>
        <Status>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Status>
        <SalesRepID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRepID>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <BaseRate>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </BaseRate>
        <BaseRatePeriod>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </BaseRatePeriod>
        <UnearnedBalance>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </UnearnedBalance>
        <LeaseSchedule>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </LeaseSchedule>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <BillingCycle>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillingCycle>
        <BillCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillCode>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <BaseArrears>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </BaseArrears>
        <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>
        <Details>
          <ContractDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
          </ContractDetail>
          <ContractDetail>
            <DetailID xsi:nil="true" />
            <EquipmentNumber xsi:nil="true" />
          </ContractDetail>
        </Details>
      </getContractResult>
    </getContractResponse>
  </soap12:Body>
</soap12:Envelope>