Care Case Clinical Trials

Create CareCaseClinicalTrial

Creates a new CareCaseClinicalTrial

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseClinicalTrial_Key
required
integer <int32>

Identifier for the Clinical Trial Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

careCaseClinicalTrialArm_ID
string or null <= 64 characters

User Managed field that ties to the Clinical Trial Arm in the system

careCaseClinicalTrialReason_ID
string or null <= 64 characters

User Managed field that ties to the Clinical Trial Reason in the system.

careCaseClinicalTrialStudyPhase_ID
string or null <= 64 characters

User Managed field that ties to the Study Phase in the system

case_Key
integer or null <int32>

Identifier of the case.

comment
string or null

User Managed field that displays the Comment of this Clinical Trial

disease
string or null

User Managed field that displays the Disease of this Clinical Trial

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

inclusionExclusion
string or null

User Managed field that displays the Inclusion Exclusion of this Clinical Trial

location
string or null

User Managed field that displays the Location of this Clinical Trial

protocol_Number
string or null

User Managed field that displays the Protocol Number of this Clinical Trial

study_Drug
string or null

User Managed field that displays the Study Drug of this Clinical Trial

study_Length
string or null

User Managed field that displays the Study Length of this Clinical Trial

study_Title
string or null

User Managed field that displays the Study Title of this Clinical Trial

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

website
string or null

User Managed field that displays the Website of this Clinical Trial

Responses
200

Success

401

Unauthorized

post/care-case-clinical-trials
Request samples
{
  • "careCaseClinicalTrial_Key": 0,
  • "careCaseClinicalTrialArm_ID": "string",
  • "careCaseClinicalTrialReason_ID": "string",
  • "careCaseClinicalTrialStudyPhase_ID": "string",
  • "case_Key": 0,
  • "comment": "string",
  • "disease": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "inclusionExclusion": "string",
  • "location": "string",
  • "protocol_Number": "string",
  • "study_Drug": "string",
  • "study_Length": "string",
  • "study_Title": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "website": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseClinicalTrial

Lists all CareCaseClinicalTrial

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/care-case-clinical-trials
Request samples 
Response samples 
No sample
Get CareCaseClinicalTrial
Gets CareCaseClinicalTrial


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CareCaseClinicalTrial_Key
required
integer <int32> 
CareCaseClinicalTrial Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/care-case-clinical-trials/{CareCaseClinicalTrial_Key}
Request samples 
Response samples 
No sample
Update CareCaseClinicalTrial
Updates a specific CareCaseClinicalTrial.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CareCaseClinicalTrial_Key
required
integer <int32> 
CareCaseClinicalTrial Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseClinicalTrial_Key
required
integer <int32> 
Identifier for the Clinical Trial  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
careCaseClinicalTrialArm_ID
string or null  <= 64 characters 
User Managed field that ties to the Clinical Trial Arm in the system


 
careCaseClinicalTrialReason_ID
string or null  <= 64 characters 
User Managed field that ties to the Clinical Trial Reason in the system.


 
careCaseClinicalTrialStudyPhase_ID
string or null  <= 64 characters 
User Managed field that ties to the Study Phase in the system


 
case_Key
integer or null <int32> 
Identifier of the case.


 
comment
string or null
User Managed field that displays the Comment of this Clinical Trial


 
disease
string or null
User Managed field that displays the Disease of this Clinical Trial


 
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


 
inclusionExclusion
string or null
User Managed field that displays the Inclusion Exclusion of this Clinical Trial


 
location
string or null
User Managed field that displays the Location of this Clinical Trial


 
protocol_Number
string or null
User Managed field that displays the Protocol Number of this Clinical Trial


 
study_Drug
string or null
User Managed field that displays the Study Drug of this Clinical Trial


 
study_Length
string or null
User Managed field that displays the Study Length of this Clinical Trial


 
study_Title
string or null
User Managed field that displays the Study Title of this Clinical Trial


 
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


 
website
string or null
User Managed field that displays the Website of this Clinical Trial


 
Responses 
200
Success


401
Unauthorized


put/care-case-clinical-trials/{CareCaseClinicalTrial_Key}
Request samples 
{
  • "careCaseClinicalTrial_Key": 0,
  • "careCaseClinicalTrialArm_ID": "string",
  • "careCaseClinicalTrialReason_ID": "string",
  • "careCaseClinicalTrialStudyPhase_ID": "string",
  • "case_Key": 0,
  • "comment": "string",
  • "disease": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "inclusionExclusion": "string",
  • "location": "string",
  • "protocol_Number": "string",
  • "study_Drug": "string",
  • "study_Length": "string",
  • "study_Title": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "website": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseClinicalTrial
Deletes an CareCaseClinicalTrial


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
CareCaseClinicalTrial_Key
required
integer <int32> 
CareCaseClinicalTrial Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/care-case-clinical-trials/{CareCaseClinicalTrial_Key}
Request samples 
Create or Update Batch CareCaseClinicalTrial
Create or Update multiple CareCaseClinicalTrial 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 
careCaseClinicalTrial_Key
required
integer <int32> 
Identifier for the Clinical Trial  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
careCaseClinicalTrialArm_ID
string or null  <= 64 characters 
User Managed field that ties to the Clinical Trial Arm in the system


 
careCaseClinicalTrialReason_ID
string or null  <= 64 characters 
User Managed field that ties to the Clinical Trial Reason in the system.


 
careCaseClinicalTrialStudyPhase_ID
string or null  <= 64 characters 
User Managed field that ties to the Study Phase in the system


 
case_Key
integer or null <int32> 
Identifier of the case.


 
comment
string or null
User Managed field that displays the Comment of this Clinical Trial


 
disease
string or null
User Managed field that displays the Disease of this Clinical Trial


 
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


 
inclusionExclusion
string or null
User Managed field that displays the Inclusion Exclusion of this Clinical Trial


 
location
string or null
User Managed field that displays the Location of this Clinical Trial


 
protocol_Number
string or null
User Managed field that displays the Protocol Number of this Clinical Trial


 
study_Drug
string or null
User Managed field that displays the Study Drug of this Clinical Trial


 
study_Length
string or null
User Managed field that displays the Study Length of this Clinical Trial


 
study_Title
string or null
User Managed field that displays the Study Title of this Clinical Trial


 
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


 
website
string or null
User Managed field that displays the Website of this Clinical Trial


 
Responses 
207
Success


401
Unauthorized


put/care-case-clinical-trials-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}