Tooth Procedures

Create ToothProcedure

Creates a new ToothProcedure

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
toothProcedure_Key
required
integer <int32>

Key value identifying a specfic dental procedure code range and action Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date the procedure code range and tooth action relationship become effective

end_Date
string or null <date-time>

Date the procedure code range and tooth action relationship terminate

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

from_Procedure
string or null <= 8 characters

First procedure code on the range covered by the tooth action

thru_Procedure
string or null <= 8 characters

Last procedure code on the range covered by the tooth action

tooth_Action
string or null <= 8 characters

Code identifying the action taken on a tooth, including cleaning, filling, bridge, crown, extraction, prosthesis or root canal

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/tooth-procedures
Request samples
{
  • "toothProcedure_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Procedure": "string",
  • "thru_Procedure": "string",
  • "tooth_Action": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ToothProcedure

Lists all ToothProcedure

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/tooth-procedures
Request samples 
Response samples 
No sample
Get ToothProcedure
Gets ToothProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
toothProcedureKey
required
integer <int32> 
ToothProcedure Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/tooth-procedures/{toothProcedureKey}
Request samples 
Response samples 
No sample
Update ToothProcedure
Updates a specific ToothProcedure.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
toothProcedureKey
required
integer <int32> 
ToothProcedure Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
toothProcedure_Key
required
integer <int32> 
Key value identifying a specfic dental procedure code range and action Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date the procedure code range and tooth action relationship become effective


 
end_Date
string or null <date-time> 
Date the procedure code range and tooth action relationship terminate


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
from_Procedure
string or null  <= 8 characters 
First procedure code on the range covered by the tooth action


 
thru_Procedure
string or null  <= 8 characters 
Last procedure code on the range covered by the tooth action


 
tooth_Action
string or null  <= 8 characters 
Code identifying the action taken on a tooth, including cleaning, filling, bridge, crown, extraction, prosthesis or root canal


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/tooth-procedures/{toothProcedureKey}
Request samples 
{
  • "toothProcedure_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "from_Procedure": "string",
  • "thru_Procedure": "string",
  • "tooth_Action": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ToothProcedure
Deletes an ToothProcedure


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
toothProcedureKey
required
integer <int32> 
ToothProcedure Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/tooth-procedures/{toothProcedureKey}
Request samples 
Create or Update Batch ToothProcedure
Create or Update multiple ToothProcedure at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
toothProcedure_Key
required
integer <int32> 
Key value identifying a specfic dental procedure code range and action Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date the procedure code range and tooth action relationship become effective


 
end_Date
string or null <date-time> 
Date the procedure code range and tooth action relationship terminate


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
from_Procedure
string or null  <= 8 characters 
First procedure code on the range covered by the tooth action


 
thru_Procedure
string or null  <= 8 characters 
Last procedure code on the range covered by the tooth action


 
tooth_Action
string or null  <= 8 characters 
Code identifying the action taken on a tooth, including cleaning, filling, bridge, crown, extraction, prosthesis or root canal


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/tooth-procedures-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}