Sheets Web Service

Sheets

Click here for a complete list of operations.

UpLoadSheetDef

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

<?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>
    <UpLoadSheetDef xmlns="http://opendental.com/">
      <RegistrationKey>string</RegistrationKey>
      <sheetDef>
        <SheetDefNum>long</SheetDefNum>
        <Description>string</Description>
        <SheetType>LabelPatient or LabelCarrier or LabelReferral or ReferralSlip or LabelAppointment or Rx or Consent or PatientLetter or ReferralLetter or PatientForm or RoutingSlip or MedicalHistory or LabSlip or ExamSheet or DepositSlip or Statement or MedLabResults or TreatmentPlan or Screening or PaymentPlan or RxMulti or ERA or ERAGridHeader or RxInstruction or PatientDashboard or PatientDashboardWidget or ChartModule or None</SheetType>
        <FontSize>float</FontSize>
        <FontName>string</FontName>
        <Width>int</Width>
        <Height>int</Height>
        <IsLandscape>boolean</IsLandscape>
        <PageCount>int</PageCount>
        <IsMultiPage>boolean</IsMultiPage>
        <BypassGlobalLock>NeverBypass or BypassIfZero or BypassAlways</BypassGlobalLock>
        <HasMobileLayout>boolean</HasMobileLayout>
        <DateTCreated>dateTime</DateTCreated>
        <RevID>int</RevID>
        <AutoCheckSaveImage>boolean</AutoCheckSaveImage>
        <AutoCheckSaveImageDocCategory>long</AutoCheckSaveImageDocCategory>
        <SheetFieldDefs>
          <SheetFieldDef>
            <SheetFieldDefNum>long</SheetFieldDefNum>
            <SheetDefNum>long</SheetDefNum>
            <FieldType>OutputText or InputField or StaticText or Parameter or Image or Drawing or Line or Rectangle or CheckBox or SigBox or PatImage or Special or Grid or ComboBox or ScreenChart or MobileHeader or SigBoxPractice</FieldType>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <FontIsBold>boolean</FontIsBold>
            <XPos>int</XPos>
            <YPos>int</YPos>
            <Width>int</Width>
            <Height>int</Height>
            <GrowthBehavior>None or DownLocal or DownGlobal or FillRightDown or FillDown or FillRight or FillDownFitColumns</GrowthBehavior>
            <RadioButtonValue>string</RadioButtonValue>
            <RadioButtonGroup>string</RadioButtonGroup>
            <IsRequired>boolean</IsRequired>
            <ImageData>string</ImageData>
            <TabOrder>int</TabOrder>
            <ReportableName>string</ReportableName>
            <TextAlign>Left or Right or Center</TextAlign>
            <IsPaymentOption>boolean</IsPaymentOption>
            <IsLocked>boolean</IsLocked>
            <TabOrderMobile>int</TabOrderMobile>
            <UiLabelMobile>string</UiLabelMobile>
            <UiLabelMobileRadioButton>string</UiLabelMobileRadioButton>
            <LayoutMode>Default or TreatPlan or Ecw or EcwTreatPlan or Orion or OrionTreatPlan or MedicalPractice or MedicalPracticeTreatPlan</LayoutMode>
            <Language>string</Language>
            <CanElectronicallySign>boolean</CanElectronicallySign>
            <IsSigProvRestricted>boolean</IsSigProvRestricted>
            <ItemColor>int</ItemColor>
          </SheetFieldDef>
          <SheetFieldDef>
            <SheetFieldDefNum>long</SheetFieldDefNum>
            <SheetDefNum>long</SheetDefNum>
            <FieldType>OutputText or InputField or StaticText or Parameter or Image or Drawing or Line or Rectangle or CheckBox or SigBox or PatImage or Special or Grid or ComboBox or ScreenChart or MobileHeader or SigBoxPractice</FieldType>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <FontIsBold>boolean</FontIsBold>
            <XPos>int</XPos>
            <YPos>int</YPos>
            <Width>int</Width>
            <Height>int</Height>
            <GrowthBehavior>None or DownLocal or DownGlobal or FillRightDown or FillDown or FillRight or FillDownFitColumns</GrowthBehavior>
            <RadioButtonValue>string</RadioButtonValue>
            <RadioButtonGroup>string</RadioButtonGroup>
            <IsRequired>boolean</IsRequired>
            <ImageData>string</ImageData>
            <TabOrder>int</TabOrder>
            <ReportableName>string</ReportableName>
            <TextAlign>Left or Right or Center</TextAlign>
            <IsPaymentOption>boolean</IsPaymentOption>
            <IsLocked>boolean</IsLocked>
            <TabOrderMobile>int</TabOrderMobile>
            <UiLabelMobile>string</UiLabelMobile>
            <UiLabelMobileRadioButton>string</UiLabelMobileRadioButton>
            <LayoutMode>Default or TreatPlan or Ecw or EcwTreatPlan or Orion or OrionTreatPlan or MedicalPractice or MedicalPracticeTreatPlan</LayoutMode>
            <Language>string</Language>
            <CanElectronicallySign>boolean</CanElectronicallySign>
            <IsSigProvRestricted>boolean</IsSigProvRestricted>
            <ItemColor>int</ItemColor>
          </SheetFieldDef>
        </SheetFieldDefs>
      </sheetDef>
    </UpLoadSheetDef>
  </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>
    <UpLoadSheetDefResponse xmlns="http://opendental.com/" />
  </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>
    <UpLoadSheetDef xmlns="http://opendental.com/">
      <RegistrationKey>string</RegistrationKey>
      <sheetDef>
        <SheetDefNum>long</SheetDefNum>
        <Description>string</Description>
        <SheetType>LabelPatient or LabelCarrier or LabelReferral or ReferralSlip or LabelAppointment or Rx or Consent or PatientLetter or ReferralLetter or PatientForm or RoutingSlip or MedicalHistory or LabSlip or ExamSheet or DepositSlip or Statement or MedLabResults or TreatmentPlan or Screening or PaymentPlan or RxMulti or ERA or ERAGridHeader or RxInstruction or PatientDashboard or PatientDashboardWidget or ChartModule or None</SheetType>
        <FontSize>float</FontSize>
        <FontName>string</FontName>
        <Width>int</Width>
        <Height>int</Height>
        <IsLandscape>boolean</IsLandscape>
        <PageCount>int</PageCount>
        <IsMultiPage>boolean</IsMultiPage>
        <BypassGlobalLock>NeverBypass or BypassIfZero or BypassAlways</BypassGlobalLock>
        <HasMobileLayout>boolean</HasMobileLayout>
        <DateTCreated>dateTime</DateTCreated>
        <RevID>int</RevID>
        <AutoCheckSaveImage>boolean</AutoCheckSaveImage>
        <AutoCheckSaveImageDocCategory>long</AutoCheckSaveImageDocCategory>
        <SheetFieldDefs>
          <SheetFieldDef>
            <SheetFieldDefNum>long</SheetFieldDefNum>
            <SheetDefNum>long</SheetDefNum>
            <FieldType>OutputText or InputField or StaticText or Parameter or Image or Drawing or Line or Rectangle or CheckBox or SigBox or PatImage or Special or Grid or ComboBox or ScreenChart or MobileHeader or SigBoxPractice</FieldType>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <FontIsBold>boolean</FontIsBold>
            <XPos>int</XPos>
            <YPos>int</YPos>
            <Width>int</Width>
            <Height>int</Height>
            <GrowthBehavior>None or DownLocal or DownGlobal or FillRightDown or FillDown or FillRight or FillDownFitColumns</GrowthBehavior>
            <RadioButtonValue>string</RadioButtonValue>
            <RadioButtonGroup>string</RadioButtonGroup>
            <IsRequired>boolean</IsRequired>
            <ImageData>string</ImageData>
            <TabOrder>int</TabOrder>
            <ReportableName>string</ReportableName>
            <TextAlign>Left or Right or Center</TextAlign>
            <IsPaymentOption>boolean</IsPaymentOption>
            <IsLocked>boolean</IsLocked>
            <TabOrderMobile>int</TabOrderMobile>
            <UiLabelMobile>string</UiLabelMobile>
            <UiLabelMobileRadioButton>string</UiLabelMobileRadioButton>
            <LayoutMode>Default or TreatPlan or Ecw or EcwTreatPlan or Orion or OrionTreatPlan or MedicalPractice or MedicalPracticeTreatPlan</LayoutMode>
            <Language>string</Language>
            <CanElectronicallySign>boolean</CanElectronicallySign>
            <IsSigProvRestricted>boolean</IsSigProvRestricted>
            <ItemColor>int</ItemColor>
          </SheetFieldDef>
          <SheetFieldDef>
            <SheetFieldDefNum>long</SheetFieldDefNum>
            <SheetDefNum>long</SheetDefNum>
            <FieldType>OutputText or InputField or StaticText or Parameter or Image or Drawing or Line or Rectangle or CheckBox or SigBox or PatImage or Special or Grid or ComboBox or ScreenChart or MobileHeader or SigBoxPractice</FieldType>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
            <FontSize>float</FontSize>
            <FontName>string</FontName>
            <FontIsBold>boolean</FontIsBold>
            <XPos>int</XPos>
            <YPos>int</YPos>
            <Width>int</Width>
            <Height>int</Height>
            <GrowthBehavior>None or DownLocal or DownGlobal or FillRightDown or FillDown or FillRight or FillDownFitColumns</GrowthBehavior>
            <RadioButtonValue>string</RadioButtonValue>
            <RadioButtonGroup>string</RadioButtonGroup>
            <IsRequired>boolean</IsRequired>
            <ImageData>string</ImageData>
            <TabOrder>int</TabOrder>
            <ReportableName>string</ReportableName>
            <TextAlign>Left or Right or Center</TextAlign>
            <IsPaymentOption>boolean</IsPaymentOption>
            <IsLocked>boolean</IsLocked>
            <TabOrderMobile>int</TabOrderMobile>
            <UiLabelMobile>string</UiLabelMobile>
            <UiLabelMobileRadioButton>string</UiLabelMobileRadioButton>
            <LayoutMode>Default or TreatPlan or Ecw or EcwTreatPlan or Orion or OrionTreatPlan or MedicalPractice or MedicalPracticeTreatPlan</LayoutMode>
            <Language>string</Language>
            <CanElectronicallySign>boolean</CanElectronicallySign>
            <IsSigProvRestricted>boolean</IsSigProvRestricted>
            <ItemColor>int</ItemColor>
          </SheetFieldDef>
        </SheetFieldDefs>
      </sheetDef>
    </UpLoadSheetDef>
  </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>
    <UpLoadSheetDefResponse xmlns="http://opendental.com/" />
  </soap12:Body>
</soap12:Envelope>