CallTrackingDiagCodes

Create CallTrackingDiagCodes

Creates a new CallTrackingDiagCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
callTrackingDiagCodes_Key
required
integer <int32>

Unique identifier for each record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

call_Key
required
integer <int32>

Unique identifier assigned to the call tracking. Note: This field is marked as NOT NULL in the database and therefore required by the API.

diagnostic_Code
required
string [ 1 .. 8 ] characters

Unique identifier assigned to the diagnosis that will be tied to the call tracking. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Identifies the ICD version that is associated with the diagnosis code. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
required
string <date-time>

Date when the Diagnostic Code becomes/became effective. 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.

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/call-tracking-diag-codes
Request samples
{
  • "callTrackingDiagCodes_Key": 0,
  • "call_Key": 0,
  • "diagnostic_Code": "string",
  • "diagnostic_Code_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CallTrackingDiagCodes

Lists all CallTrackingDiagCodes

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/call-tracking-diag-codes
Request samples 
Response samples 
No sample
Get CallTrackingDiagCodes
Gets CallTrackingDiagCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CallTrackingDiagCodes_Key
required
integer <int32> 
CallTrackingDiagCodes Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/call-tracking-diag-codes/{CallTrackingDiagCodes_Key}
Request samples 
Response samples 
No sample
Update CallTrackingDiagCodes
Updates a specific CallTrackingDiagCodes.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CallTrackingDiagCodes_Key
required
integer <int32> 
CallTrackingDiagCodes Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
callTrackingDiagCodes_Key
required
integer <int32> 
Unique identifier for each record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
call_Key
required
integer <int32> 
Unique identifier assigned to the call tracking. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
diagnostic_Code
required
string  [ 1 .. 8 ] characters 
Unique identifier assigned to the diagnosis that will be tied to the call tracking. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Identifies the ICD version that is associated with the diagnosis code. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date when the Diagnostic Code becomes/became effective. 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.


 
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/call-tracking-diag-codes/{CallTrackingDiagCodes_Key}
Request samples 
{
  • "callTrackingDiagCodes_Key": 0,
  • "call_Key": 0,
  • "diagnostic_Code": "string",
  • "diagnostic_Code_Type": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CallTrackingDiagCodes
Deletes an CallTrackingDiagCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CallTrackingDiagCodes_Key
required
integer <int32> 
CallTrackingDiagCodes Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/call-tracking-diag-codes/{CallTrackingDiagCodes_Key}
Request samples 
Create or Update Batch CallTrackingDiagCodes
Create or Update multiple CallTrackingDiagCodes 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 
callTrackingDiagCodes_Key
required
integer <int32> 
Unique identifier for each record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
call_Key
required
integer <int32> 
Unique identifier assigned to the call tracking. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
diagnostic_Code
required
string  [ 1 .. 8 ] characters 
Unique identifier assigned to the diagnosis that will be tied to the call tracking. This can be selected by right-clicking within the field and selecting 'Lookup' from the context menu.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Identifies the ICD version that is associated with the diagnosis code. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
required
string <date-time> 
Date when the Diagnostic Code becomes/became effective. 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.


 
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/call-tracking-diag-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}