PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addSalesQuote

Adds a new sales quote.

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

<?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>
    <addSalesQuote xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SalesQuote>
        <QuoteID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </QuoteID>
        <QuoteNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </QuoteNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <optBillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optBillToNumber>
        <optMailToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optMailToNumber>
        <optShipToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipToNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <RequiredDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </RequiredDate>
        <DueDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DueDate>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <CreateDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </CreateDate>
        <LastUpdate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastUpdate>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Details>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
        </Details>
      </SalesQuote>
    </addSalesQuote>
  </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>
    <addSalesQuoteResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addSalesQuoteResult>
        <QuoteID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </QuoteID>
        <QuoteNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </QuoteNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <optBillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optBillToNumber>
        <optMailToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optMailToNumber>
        <optShipToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipToNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <RequiredDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </RequiredDate>
        <DueDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DueDate>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <CreateDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </CreateDate>
        <LastUpdate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastUpdate>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Details>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
        </Details>
      </addSalesQuoteResult>
    </addSalesQuoteResponse>
  </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>
    <addSalesQuote xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SalesQuote>
        <QuoteID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </QuoteID>
        <QuoteNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </QuoteNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <optBillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optBillToNumber>
        <optMailToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optMailToNumber>
        <optShipToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipToNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <RequiredDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </RequiredDate>
        <DueDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DueDate>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <CreateDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </CreateDate>
        <LastUpdate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastUpdate>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Details>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
        </Details>
      </SalesQuote>
    </addSalesQuote>
  </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>
    <addSalesQuoteResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addSalesQuoteResult>
        <QuoteID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </QuoteID>
        <QuoteNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </QuoteNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <optBillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optBillToNumber>
        <optMailToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optMailToNumber>
        <optShipToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipToNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <RequiredDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </RequiredDate>
        <DueDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DueDate>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <Email>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Email>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <CreateDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </CreateDate>
        <LastUpdate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastUpdate>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Details>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
          <SalesQuoteDetail>
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
          </SalesQuoteDetail>
        </Details>
      </addSalesQuoteResult>
    </addSalesQuoteResponse>
  </soap12:Body>
</soap12:Envelope>