Member Tooth Ex Codes

Create MemberToothExCode

Creates a new MemberToothExCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

tooth_Number
required
integer <int32>

Identifies the number of the tooth/teeth that the User intends to apply an Ex Code to. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
required
string [ 1 .. 8 ] characters

Idenfities the Ex Code that will be applied to the selected tooth/teeth.

update_Date
string <date-time>

Date when 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/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "tooth_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberToothExCode

Lists all MemberToothExCode for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

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/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes
Request samples
Response samples
No sample

Get MemberToothExCode

Gets MemberToothExCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

toothNumber
required
integer <int32>

Tooth Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes/{toothNumber}
Request samples
Response samples
No sample

Update MemberToothExCode

Updates a specific MemberToothExCode.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

toothNumber
required
integer <int32>

Tooth Number

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

tooth_Number
required
integer <int32>

Identifies the number of the tooth/teeth that the User intends to apply an Ex Code to. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
required
string [ 1 .. 8 ] characters

Idenfities the Ex Code that will be applied to the selected tooth/teeth.

update_Date
string <date-time>

Date when 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/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes/{toothNumber}
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "tooth_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete MemberToothExCode

Deletes an MemberToothExCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

toothNumber
required
integer <int32>

Tooth Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes/{toothNumber}
Request samples

Create or Update Batch MemberToothExCode

Create or Update multiple MemberToothExCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

tooth_Number
required
integer <int32>

Identifies the number of the tooth/teeth that the User intends to apply an Ex Code to. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
required
string [ 1 .. 8 ] characters

Idenfities the Ex Code that will be applied to the selected tooth/teeth.

update_Date
string <date-time>

Date when 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/subscribers/{subscriberID}/members/{memberSeq}/teeth-ex-codes-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}