Sheets Web Service

Sheets

Click here for a complete list of operations.

GetSheets

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 /WebHostSynch/Sheets.asmx HTTP/1.1
Host: opendentalsoft.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://opendental.com/GetSheets"

<?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>
    <GetSheets xmlns="http://opendental.com/">
      <RegistrationKey>string</RegistrationKey>
    </GetSheets>
  </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>
    <GetSheetsResponse xmlns="http://opendental.com/">
      <GetSheetsResult>
        <SheetAndSheetField>
          <web_sheet>
            <SheetID>long</SheetID>
            <DentalOfficeID>long</DentalOfficeID>
            <Description>string</Description>
            <SheetType>int</SheetType>
            <DateTimeSheet>dateTime</DateTimeSheet>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <Width>int</Width>
            <Height>int</Height>
            <IsLandscape>byte</IsLandscape>
            <ClinicNum>long</ClinicNum>
            <webforms_preferenceReference xsi:nil="true" />
          </web_sheet>
          <web_sheetfieldlist>
            <webforms_sheetfield xsi:nil="true" />
            <webforms_sheetfield xsi:nil="true" />
          </web_sheetfieldlist>
        </SheetAndSheetField>
        <SheetAndSheetField>
          <web_sheet>
            <SheetID>long</SheetID>
            <DentalOfficeID>long</DentalOfficeID>
            <Description>string</Description>
            <SheetType>int</SheetType>
            <DateTimeSheet>dateTime</DateTimeSheet>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <Width>int</Width>
            <Height>int</Height>
            <IsLandscape>byte</IsLandscape>
            <ClinicNum>long</ClinicNum>
            <webforms_preferenceReference xsi:nil="true" />
          </web_sheet>
          <web_sheetfieldlist>
            <webforms_sheetfield xsi:nil="true" />
            <webforms_sheetfield xsi:nil="true" />
          </web_sheetfieldlist>
        </SheetAndSheetField>
      </GetSheetsResult>
    </GetSheetsResponse>
  </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 /WebHostSynch/Sheets.asmx HTTP/1.1
Host: opendentalsoft.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>
    <GetSheets xmlns="http://opendental.com/">
      <RegistrationKey>string</RegistrationKey>
    </GetSheets>
  </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>
    <GetSheetsResponse xmlns="http://opendental.com/">
      <GetSheetsResult>
        <SheetAndSheetField>
          <web_sheet>
            <SheetID>long</SheetID>
            <DentalOfficeID>long</DentalOfficeID>
            <Description>string</Description>
            <SheetType>int</SheetType>
            <DateTimeSheet>dateTime</DateTimeSheet>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <Width>int</Width>
            <Height>int</Height>
            <IsLandscape>byte</IsLandscape>
            <ClinicNum>long</ClinicNum>
            <webforms_preferenceReference xsi:nil="true" />
          </web_sheet>
          <web_sheetfieldlist>
            <webforms_sheetfield xsi:nil="true" />
            <webforms_sheetfield xsi:nil="true" />
          </web_sheetfieldlist>
        </SheetAndSheetField>
        <SheetAndSheetField>
          <web_sheet>
            <SheetID>long</SheetID>
            <DentalOfficeID>long</DentalOfficeID>
            <Description>string</Description>
            <SheetType>int</SheetType>
            <DateTimeSheet>dateTime</DateTimeSheet>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <Width>int</Width>
            <Height>int</Height>
            <IsLandscape>byte</IsLandscape>
            <ClinicNum>long</ClinicNum>
            <webforms_preferenceReference xsi:nil="true" />
          </web_sheet>
          <web_sheetfieldlist>
            <webforms_sheetfield xsi:nil="true" />
            <webforms_sheetfield xsi:nil="true" />
          </web_sheetfieldlist>
        </SheetAndSheetField>
      </GetSheetsResult>
    </GetSheetsResponse>
  </soap12:Body>
</soap12:Envelope>