Setup API

GET Practice Details /v1/api/SetUp/PracticeDetail/

Description: Api call that returns Practice details for a given PGID

                                    
        {
        "Successful": true,
        "Data": [
        {
            "P": 101,
            "PGN": "Planet DDS Inc",
            "SID": "PDDS",
            "AD": "223  Corporate Drive",
            "AD2": "Suite 200",
            "CT": "Irvine",
            "ST": "CA",
            "ZP": "92612",
            "PH": "8545278999",
            "EM": "connect@planetdds.com",
            "CUID": "en-US",
            "CBO":"12/02/2004T22:33:00",
            "CBY":"ADAM.JACK",
            "MBO":"12/02/2004T22:33:00",
            "MBY":"ADAM.JACK"
        }
        ],
        "Exception": null,
        "ResponseCode": 200
        }

GET Office List /v1/api/SetUp/OfficeList/

Description: Api call that returns all office list for a given PGID

                                    
            {
            "Successful":true,
            "Data":[
            {
                "O":101,
                "OFN":"Irvine",
                "SID":"IRV01",
                "AD":"151 Klamus DR",
                "AD2":"Street #A54",
                "CT":"Costa Mesa",
                "ST":"CA",
                "ZP":"96262",
                "PH":"8545278999",
                "PH2":"8885555555",
                "FAX":"3108765432",
                "EM":"connect@planetdds.com",
                "TZ":"PST - Pacific Standard Time"
                "WS":"planetdds.com"
                "CBO":"01/15/2001T13:24:00",
                "CBY":"ADAM.JACK",
                "MBO":"01/15/2001T13:24:00",
                "MBY":"ADAM.JACK",
                "AC" :"Y",
                "BillingAddress": {
                "BAD": "1234 Main",
                "BAD2": "P.O. 600",
                "BCT": "Bountiful",
                "BST": "CA",
                "BZP": "84010"
            },
                "Hours": {
                    "MonStart": "8:00AM",
                    "MonEnd": "5:00PM",
                    "MonLunStart": "11:00AM",
                    "MonLunEnd": "12:00PM",
                    "TuesStart": "8:00AM",
                    "TuesEnd": "5:00PM",
                    "TuesLunStart": "11:00AM",
                    "TuesLunEnd": "12:00PM",
                    "WedStart": "8:00AM",
                    "WedEnd": "5:00PM",
                    "WedLunStart": "11:00AM",
                    "WedLunEnd": "12:00PM",
                    "ThurStart": "8:00AM",
                    "ThurEnd": "5:00PM",
                    "ThurLunStart": "11:00AM",
                    "ThurLunEnd": "12:00PM",
                    "FriStart": "8:00AM",
                    "FriEnd": "5:00PM",
                    "FriLunStart": "11:00AM",
                    "FriLunEnd": "12:00PM",
                    "SatStart": "8:00AM",
                    "SatEnd": "5:00PM",
                    "SatLunStart": "11:00AM",
                    "SatLunEnd": "12:00PM",
                    "SunStart": "8:00AM",
                    "SunEnd": "5:00PM",
                    "SunLunStart": "11:00AM",
                    "SunLunEnd": "12:00PM"
                }
            }
            ],
            "Exception":null,
            "ResponseCode":200
            }

GET Practice Codes /v1/api/SetUp/PracticeCodes/

Description: Api call that returns the procedure codes for a given PGID

                                    
 {
  "Successful": true,
  "Data": [
    {
      "P": 101,
      "CD": "AD101",
      "DES": "A Procedure Code"
    }
  ],
  "Exception": null,
  "ResponseCode": 200
}

POST Operatory List /v1/api/Setup/OperatoryList/

Description: Api call that returns all Operators list for a given PGID

Request Information

Parameter	Type	Value	Required	Description
OID	Integer		Required	Office Identification Number

                                    
{
    "Successful": true,
    "Data": [
        {
            "OPID": 103,
            "OPN": "GP 01"
        },
        {
            "OPID": 104,
            "OPN": "GP 05"
        }
    ],
    "Exception": null,
    "ResponseCode": 200
}

GET Provider List /v1/api/SetUp/ProviderList/

Description: Api call that returns all Provider list for a given PGID

                                        
{
"Successful": true,
"Data": [
{
"PDR": 101,
"PDSID": "MIKE",
"FN": "Jones ",
"LN": "Michael",
"PH": "8749825627",
"PDTY": "Dentist",
"AC": "Y",
"ISAPN": "N",
"NPI": "99999999"
"CBO":"01/15/2001T13:24:00",
"CBY":"ADAM.JACK",
"MBO":"01/15/2001T13:24:00",
"MBY":"ADAM.JACK",
"LIC": "56765",
"TIN": "675987923",
"SPEC": "Prosthodontics",
"AD": "123 S. Gale Ave.",
"AD2": "",
"CT": "Seattle",
"ST": "WA",
"ZP": "98999",
"OFFICES": [
    {
    "OFN": "Organic Dentistry",
    "O": 101,
    "OSID": "OD"
    },
    {
    "OFN": "Melbourne Cricket Ground",
    "O": 116,
    "OSID": "MCG"
    }
    ]
}
],
"Exception": null,
"ResponseCode": 200
}

POST Provider Office List /v1/api/Setup/ProviderOfficeList/

Description: Api call that returns one Provider's Office (work's at) list for a given PGID

Request Information

Parameter	Type	Value	Required	Description
PROVIDERID	Integer		Required	Provider identification number

                                    
 {
  "Successful": true,
  "Data": [
    {
      "O": 1,
      "OFN": "Irvine",
      "OSID": "IRV01"
    } 
  ],
  "Exception": null,
  "ResponseCode": 200
}

GET Office Provider List /v1/api/Setup/OfficeProviderList/

Description: Api call that returns an office's list of providers

Request Information

Parameter	Type	Value	Required	Description
OID	Integer		Required	Office identification number

                                    
 {
  "Successful": true,
  "Data": [
    {
      "PDR": 1,
      "PDSID": "BC12",
      "FN": "Rahul",
      "LN": "Khot",
      "PH": "1111111111",
      "PDTY": "Dentist",
      "AC": "Y",
      "NPI": "5874589",
      "LIC": "127137892",
      "TIN": "123123123",
      "SPEC": "Prosthodontics"
    }
  ],
  "Exception": null,
  "ResponseCode": 200
}

POST Provider Operatories List /v1/api/Setup/ProviderOperatoryList/

Description: Api call that returns one Provider's Operatories list for a given PGID and OID.

Request Information

Parameter	Type	Value	Required	Description
OID	Integer		Required	Office Identification Number
PROVIDERID	Integer		Required	Provider Identification Number

                                    
  {
  "Successful": true,
  "Data": [
    {
      "OPID": 101,
      "DES": "TRoom01"
    } 
  ],
  "Exception": null,
  "ResponseCode": 200
}

POST Provider Holidays Scheduler /v1/api/Setup/ProviderHolidaySch/

Description: Api call that returns one Provider's holidays list for a given PGID and OID

Request Information

Parameter	Type	Value	Required	Description
OID	Integer		Required	Office Identification Number
PROVIDERID	Integer		Required	Provider Identification Number

                                    
  {
  "Successful": true,
  "Data": [
    {
      "DH": "08/03/2004T00:00:00",
      "DES": "Seminar",
      "TY": "Out of Office",
      "DS": "13:25",
      "DE": "19:45",
      "LUS": "15:15",
      "LUE": "15:45"
    } 
   ],
  "Exception": null,
  "ResponseCode": 200
}

POST Provider Effective Schedule /v1/api/Setup/ProviderEffSch/

Description: Api call that returns Provider Effective Schedule for a given OID And PROVIDERID

Request Information

Parameter	Type	Value	Required	Description
OID	Integer		Required	Office Identification Number
PROVIDERID	Integer		Required	Provider Identification Number

                                    
 {
  "Successful": true,
  "Data": [
    {
      "OPID": 101,
      "OPN": "TRoom01",
      "EFD": "04/28/2016T00:00:00",
      "STS": "02/15/2017T10:10:00",
      "DU": 100,
      "PRTY": 8
    } 
  ],
  "Exception": null,
  "ResponseCode": 200
}

GET Scheduler Production Types /v1/api/SetUp/SchProductionType/

Description: Api call that returns production types list for a given PGID and OID

Parameter	Type	Value	Required	Description
OID	Integer		Required	Office Identification Number

                                    
  {
  "Successful": true,
  "Data": [
    {
      "PRTY": "1",
      "PRC": "DarkGreen",
      "DES": "High",
      "ISAPN": "N",
      "ISACT": "Y",
      "APNDUR": "30"
    } 
  ],
  "Exception": null,
  "ResponseCode": 200
}

GETGet Referral Types /v1/api/Setup/ReferralTypes/

Description: Api call that returns all Referral types for a given PGID

                                        
{
"Successful": true,
"Data": [
{
"TypeCode": "R001",
"TypeDescription": "Billboard"
},
{
"TypeCode": "R003",
"TypeDescription": "Patient PlanetDDS"
},
{
"TypeCode": "R004",
"TypeDescription": "Confident Plan"
},
{
"TypeCode": "R005",
"TypeDescription": "Doctor"
}
],
"Exception": null,
"ResponseCode": 200
}

GETGet Cancellation Codes /v1/api/Setup/CancellationCodes/

Description: Api call that returns all Cancellation Codes given the PGID

                                    
  {
  "Successful": true,
  "Data": [
    {
      "CANCELLATIONCODEID": 436,
      "DESCR": "Appointment build 44"
    },
    {
      "CANCELLATIONCODEID": 472,
      "DESCR": "Automated Cancellation"
    },
    {
      "CANCELLATIONCODEID": 421,
      "DESCR": "Automated cancellation"
    },
    {
      "CANCELLATIONCODEID": 469,
      "DESCR": "Cancelled and rescheduled"
    },
    {
      "CANCELLATIONCODEID": 471,
      "DESCR": "Cancelled by email"
    }
  ],
  "Exception": null,
  "ResponseCode": 200
}

GET Carrier List /v1/api/SetUp/CarrierList/

Description: Api call that returns a list of all carriers for a given PGID

                                    
        {
        "Successful":true,
        "Data":[
        {
            "CID": 100,
            "CN": "DENTAL",
            "CAD": "123 Main St",
            "CT": "Irvine",
            "ST": "CA",
            "ZP": "92606",
            "PH": "999-999-9999",
            "PID": "11111",
            "WS": https://www.DeltaDental.com,
            "CBO": "2007-01-19T16:08:00",
            "CBY": "USER"
            "MBO": "2007-01-19T16:08:00",
            "MBY": "USER"
        }
        ],
        "Exception":null,
        "ResponseCode":200
        }

GET Get Provider Carrier Login /v1/api/Setup/GetProviderCarrierLogin/

Description: Api call that returns a list of a provider's carrier logins

Parameter	Type	Value	Required	Description
PROVIDERID	Integer		Required	Provider Identification Number
CarrierName	String		Optional	Carrier Name

                                    
 {
  "Successful": true,
  "Data": [
    {
        "P": 1,
        "PDR": 221,
        "PN": "Smith, John",
        "CID": 192,
        "O": 212,
        "ID": 3,
        "CN": "AETNA",
        "ON": "Great Smiles",
        "WS": "www.denticon.com",
        "UN": "test",
        "PWD": "123454678",
        "CBO": "2017-07-24T03:46:00",
        "CBY": "User"
    } 
  ],
  "Exception": null,
  "ResponseCode": 200
}

POST Add Provider Carrier Login /v1/api/Setup/AddProviderCarrierLogin/

Description: Api call adds a carrier login for a given provider

Parameter	Type	Required	Description
OID	Integer	Required	Provider Office Identification Number
PROVIDERID	Integer	Required	Provider Identification Number
CarrierID	Integer	Required	Carrier Identification Number
WS	String	Required	Carrier Website
UN	String	Required	Carrier Login Username
PWD	String	Required	Carrier Login Password

                                    
  {
  "Successful": true,
  "Data": [
    {
        "ID": 3
    } 
  ],
  "Exception": null,
  "ResponseCode": 200
}

Setup Interactive API List

Service Authentication :

GET Practice Details /v1/api/SetUp/PracticeDetail/

Request URL

HTTP Status Code

Request Headers

Request Body

GET Office List /v1/api/SetUp/OfficeList/

Request URL

HTTP Status Code

Request Headers

Request Body

GET Practice Codes /v1/api/SetUp/PracticeCodes/

Request URL

HTTP Status Code

Request Headers

Request Body

POST Operatory List /v1/api/Setup/OperatoryList/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

GET Provider List /v1/api/SetUp/ProviderList/

Request URL

HTTP Status Code

Request Headers

Request Body

POST Provider Office List /v1/api/Setup/ProviderOfficeList/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

GET Office Provider List /v1/api/Setup/OfficeProviderList/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Provider Operatories List /v1/api/Setup/ProviderOperatoryList/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Provider Holidays Scheduler /v1/api/Setup/ProviderHolidaySch/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Provider Effective Schedule /v1/api/Setup/ProviderEffSch/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

GET Scheduler Production Types /v1/api/SetUp/SchProductionType/

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

GETGet Referral Types /v1/api/Setup/ReferralTypes/

Request URL

HTTP Status Code

Request Headers

Request Body

GETGet Cancellation Codes /v1/api/Setup/CancellationCodes/

Request URL

HTTP Status Code

Request Headers

Request Body