Interactive Appointment Api

POST Get Appointment Details By ID /v1/api/Appointment/GetApptDetail/

Description: Get appointment details for supplied Appointment ID.

Request Information

Parameter	Type	Value	Required	Description
APPTID	Integer		Required	Appointment identification number
INCLUDEAPPTCODES	boolean		Optional	To Include Codes Attached to Appointments

                                    
  {
   "Successful": true,
   "Data": {
       "O": 101,
       "OSID": "DSMILE",
       "PID": 1001,
       "PRODTY": "63",
       "ATY": "Appointment",
       "APD": "02/16/2009T10:00:00",
       "APS": "Confirmed",
       "PDR": 101,
       "SID": "MIKE",
       "PRN": "Jones, Michael",
       "OPID": 101,
       "OPN": "TRoom1",
       "APL": 60,
       "ISNP": false,
       "ISASAP": false,
       "WSKPT": 1,
       "FEE": 68.00,
       "FNAME":"John",
       "LNAME":"Doe",
       "EMAIL":"john.doe@gmail.com",
       "CP":"71467777444",
       "WP":"67845311888",
       "HP":"85452789999",
       "ISBLOCKED": false,
       "CBO":"02/19/2009T12:47:00",
       "CBY": "ADAM.JOHN",
       "MBO":"02/29/2009T12:47:00",
       "MBY":"ADAM.JOHN",
       "Codes": [
         {
           "CD":"D1111",
           "DES":"A Dental Code"
         } 
       ],
       "IsSuccess": null,
       "Message": null
   },
   "Exception": null,
   "ResponseCode": 200
 }

POST Get Appointment List Of 30 Days /v1/api/Appointment/ListAppts/

Description: Gets appointment List with supplied Practice Group ID for 30 days.
All Dates with Time values will be returned in Local Time, in result set.

Request Information

Parameter	Type	Required	Description
OID	Integer	Required	Office identification number (JSON url: /v1/api/SetUp/OfficeList/)
PAGEINDEX	Integer	Required	Page Number
INCLUDEAPPTCODES	boolean	Optional	To Include Codes Attached to Appointments
FROMDATE	Date	Optional	Date (MM/DD/YYYY) default to today
FROMTIME	Time	Optional	Time (HH:MM) in 24 hr format
TODATE	Date	Optional	Date (MM/DD/YYYY) default to 30 days from today
TOTIME	Time	Optional	Time (HH:MM) in 24 hr format

                                    
  {  
   "Successful":true,
   "Data":{  
      "Appointments":[  
         {  
            "O":101,
            "OSID":"OD",
            "PID":1001,
            "APID":5001,
            "APD":"10/17/2017T11:00:00",
            "OPID":"102",
            "OPN":"op1",
            "ATY": "Appointment",
            "APS":"Valid",
            "PDR":101,
            "SID": "HYG1",
            "OPID":201,
            "APL":60,
            "ISNP":false,
            "ISASAP": false,
            "WSKPT": 1,
            "FEE": 68.00,
            "CODES": [
              {
                 "CD":"D1111",
                 "DES":"A Dental Code"
               } 
            ],
            "FN":"John",
            "LN":"Doe",
            "EM":"john.doe@gmail.com",
            "HP":"85452789999",
            "WP":"67845311888",
            "CP":"71467777444",
            "ISBLOCKED": false,
            "CBO":"02/19/2009T12:47:00",
            "CBY": "ADAM.JOHN",
            "MBO":"02/29/2009T12:47:00",
            "MBY":"ADAM.JOHN",
            "IsSuccess": null,
            "Message": null
         }  
      ],
      "TotalRecords":"8",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Is Appointment Valid /v1/api/Appointment/IsApptValid/

Description: Gets appointment Status with Appointment ID.

Request Information

Parameter	Type	Value	Required	Description
APPTID	Integer		Required	Appointment identification number

                                    
  {
  "Successful": true,
  "Data": [
    {
      "APS": "Confirmed",
      "APD": "02/16/2009T10:00:00",
      "O": 101,
      "IsSuccess": null,
      "Message": null
    }
  ],
  "Exception": null,
  "ResponseCode": 200
}

POST Is Appointment List Valid /v1/api/Appointment/IsApptListValid/

Description: Gets appointment Status with Appointment ID List. Maximum 50 Appointment IDs are allowed.

Request Information

Parameter	Type	Value	Required	Description
APPTID	Integer		Required	Comma-separated Appointment identification numbers (Example: 3500,3600,3700)

                                        
{
"Successful": true,
"Data": [
      {
        "APPTID": 3500,
        "APS": "Invalid",
        "APD": "",
        "O": null,
        "IsSuccess": false,
        "Message": "Invalid Appointment-ID"
      },
      {
        "APPTID": 3005,
        "APS": "Valid and Un-confirmed",
        "APD": "05/18/2021T23:50:00",
        "O": 101,
        "IsSuccess": true,
        "Message": ""
      }
    ],
"Exception": null,
"ResponseCode": 200
}

POST Set Appointment Confirmation date /v1/api/Appointment/ConfirmApptDate/

Description: Set appointment Confirmation for supplied Appointment ID.

Request Information

Parameter	Type	Value	Required	Description
APPTID	Integer		Required	Appointment identification number
Date	Date		Required	Appointment Confirmation Date

                                    
  {
  "Successful": true,
  "Data": {
      "APD": "02/16/2009T10:00:00",
      "APS": "Confirmed",
      "O": null,
      "MSG": "Patient has confirmed time.",
      "IsSuccess": null,
      "Message": null
  },
  "Exception": null,
  "ResponseCode": 200
}

POSTAppointNow - Get available appointment /v1/api/Appointment/GetAvailableSchedule/

Description: Api call to get available AppointNow appointments

Request Information

Parameter	Type	Required	Description
OID	Integer	Required	Office identification number (JSON url: /v1/api/SetUp/OfficeList/)
STARTDATE	Date	Optional	Date (MM/DD/YYYY) default to today
ENDDATE	Date	Optional	Date (MM/DD/YYYY) default to 7 days from today
APPTDURATION	Interger	Optional	Appointment duration (# minutes)
WEEKDAYBITPATTERN	Integer	Optional	[Combination string of 1-7 with comma seperation. 1=Sun,…, 7=Sat. Example: "1,2,3,4,5,6,7"]
TIMEREFERENCE	String	Optional	[AM=Morning, PM=Eve, EMPTY=AllDay]
PROVIDERID	Integer	Optional	Provider identification number (JSON url: /v1/api/SetUp/ProviderList/)
PRODTYPE	Integer	Required	Production Type identification number (JSON url: /v1/api/SetUp/SchProductionType/)

                                    
{
  "Successful": true,
  "Data": {
    "AppointmentSlots": [
      {
        "SPOTDATE": "2018-06-26T08:00:00",
        "STS": "08:00:00",
        "TIMEEND": "09:00:00",
        "DU": 30,
        "WKDAY": 4,
        "PDR": 102,
        "OPID": 1,
        "PRTY": 8,
        "APD": "2018-06-26T08:00:00",
      },
      {
        "SPOTDATE": "2018-06-26T08:00:00",
        "STS": "08:00:00",
        "TIMEEND": "10:00:00",
        "DU": 60,
        "WKDAY": 4,
        "PDR": 102,
        "OPID": 1,
        "PRTY": 8,
        "APD": "2018-06-26T08:00:00",
      }
    ],
    "IsSuccess": "1",
    "Message": ""
  },
  "Exception": null,
  "ResponseCode": 200
}

POST AppointNow - Book appointment slot /v1/api/Appointment/BookAppointmentSlot/

Description: Api call to book AppointNow appointments

Request Information

Parameter	Type	Required	Description
OID	Integer	Required	Office identification number (JSON url: /v1/api/SetUp/ProviderOperatoryList/)
PROVIDERID	Integer	Required	Provider identification number (JSON url: /v1/api/SetUp/ProviderList/)
OPID	Integer	Required	Operatory identification number (JSON url: /v1/api/SetUp/OfficeList/)
PRODTYPE	Integer	Required	Production Type identification number (JSON url: /v1/api/SetUp/SchProductionType/)
APPTDATE	Date	Required	Appointment Date (MM/DD/YYYY)
STARTTIME	Time	Required	Time (HH:MM) in 24 hr format (in 10/15 minute intervals only)
APPTDURATION	Interger	Required	Appointment duration (# minutes, in 10/15 minute intervals only)
ISNEWPATIENT	Boolean	Required	Is New Patient
LASTNAME	String	Required	Patient Last Name
FIRSTNAME	String	Required	Patient First Name
DOB	Date	Required	Patient Birthdate (MM/DD/YYYY)
EMAIL	String	NP: Required EP: Optional	Email is Required if the patient is new. If the patient is existing, then its Optional (NP: New patient, EP: Existing patient)
PHONE	Integer	NP: Required EP: Optional	Phone is Required if the patient is new. If the patient is existing, then its Optional. Value will be stored as Home Phone and Cell Phone in Denticon (NP: New patient, EP: Existing patient)
HAVEINS	String	Required	Patient Last Name
INSNAME	String	RequiredOptional	Insurance Name
SUBSCRIBER	String	RequiredOptional	Subscriber
SUBSCRIBERID	String	RequiredOptional	Subcriber ID
GROUPNO	String	RequiredOptional	Insurance group number
CAMPAIGNID	String	Optional	Appointment Campaign ID
NOTETOOFFICE	String	Optional	Notes to Office (maximum 3950 characters)

                                    
{
  "Successful": true,
  "Data": [
    {
      "APPTID": 0,
      "IsSuccess": null,
      "Message": "The slot is not available."
    }
  ],
  "Exception": null,
  "ResponseCode": 200
} 

Or

{
  "Successful": true,
  "Data": [
    {
      "APPTID": 4086,
      "IsSuccess": null,
      "Message": "Appointment successfully booked."
    }
  ],
  "Exception": null,
  "ResponseCode": 200
}

POST Cancel Appointment /v1/api/Appointment/CancelAppointment/

Description: Api call to cancel appointments

Request Information

Parameter	Type	Required	Description
OID	Integer	Required	Office identification number
APPTID	Integer	Required	Appointment identification number
CANCELLATIONCODEID	Integer	Required	Appointment cancellation identification number (JSON url: /v1/api/SetUp/CancellationCodes/)
CANCELLATIONNOTE	String	Optional	Appointment cancellation note

                                    
{
    "Successful": true,
    "Data": {
        "APPTID": 5848,
        "ISCANCELLED": true,
        "CANCELDESCR": "None",
        "CANCELLATIONNOTE": "Decided to cancel",
        "IsSuccess": null,
        "Message": null,
        "ReturnCode": null
    },
    "Exception": null,
    "ResponseCode": 200
}

Appointment Interactive API List

Service Authentication :

POST Get Appointment Details By ID /v1/api/Appointment/GetApptDetail/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Get Appointment List Of 30 Days /v1/api/Appointment/ListAppts/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Is Appointment Valid /v1/api/Appointment/IsApptValid/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Is Appointment List Valid /v1/api/Appointment/IsApptListValid/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Set Appointment Confirmation date /v1/api/Appointment/ConfirmApptDate/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POSTAppointNow - Get available appointment /v1/api/Appointment/GetAvailableSchedule/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST AppointNow - Book appointment slot /v1/api/Appointment/BookAppointmentSlot/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Cancel Appointment /v1/api/Appointment/CancelAppointment/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body