Drug Codes

Create DrugCode

Creates a new DrugCode

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
drugCode_Key
required
integer <int32>
application_Number
string or null <= 32 characters
deA_Schedule
string or null <= 64 characters
description
string or null
dosage_For_Name
string or null <= 512 characters
drug_Code
required
string [ 1 .. 32 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
labeler_Code
string or null <= 6 characters
labeler_Name
string or null <= 512 characters
listing_Record_Certified_Through
string or null <date-time>
marketing_Category_Name
string or null <= 64 characters
ndC_Package_Code
string or null <= 32 characters
non_Proprietary_Name
string or null <= 512 characters
package_Code
string or null <= 2 characters
package_End_Marketing_Date
string or null <date-time>
package_NDC_Exclude_Flag
string or null <= 8 characters
package_Size
string or null <= 25 characters
package_Start_Marketing_Date
string or null <date-time>
package_Type
string or null <= 25 characters
pharmacy_Class
string or null
product_Code
string or null <= 32 characters
product_End_Marketing_Date
string or null <date-time>
product_NDC_Exclude_Flag
string or null <= 8 characters
product_Start_Marketing_Date
string or null <date-time>
product_Type_Name
string or null <= 512 characters
proprietary_Name
string or null <= 512 characters
proprietary_Name_Suffix
string or null <= 64 characters
rX_OTC
string or null <= 1 characters
route_Name
string or null <= 512 characters
sample_Package
string or null <= 8 characters
strength
string or null <= 32 characters
substance_Name
string or null <= 512 characters
trade_Name
string or null <= 100 characters
unit
string or null <= 32 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/drug-codes
Request samples
{
  • "drugCode_Key": 0,
  • "application_Number": "string",
  • "deA_Schedule": "string",
  • "description": "string",
  • "dosage_For_Name": "string",
  • "drug_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "labeler_Code": "string",
  • "labeler_Name": "string",
  • "listing_Record_Certified_Through": "2019-08-24T14:15:22Z",
  • "marketing_Category_Name": "string",
  • "ndC_Package_Code": "string",
  • "non_Proprietary_Name": "string",
  • "package_Code": "st",
  • "package_End_Marketing_Date": "2019-08-24T14:15:22Z",
  • "package_NDC_Exclude_Flag": "string",
  • "package_Size": "string",
  • "package_Start_Marketing_Date": "2019-08-24T14:15:22Z",
  • "package_Type": "string",
  • "pharmacy_Class": "string",
  • "product_Code": "string",
  • "product_End_Marketing_Date": "2019-08-24T14:15:22Z",
  • "product_NDC_Exclude_Flag": "string",
  • "product_Start_Marketing_Date": "2019-08-24T14:15:22Z",
  • "product_Type_Name": "string",
  • "proprietary_Name": "string",
  • "proprietary_Name_Suffix": "string",
  • "rX_OTC": "s",
  • "route_Name": "string",
  • "sample_Package": "string",
  • "strength": "string",
  • "substance_Name": "string",
  • "trade_Name": "string",
  • "unit": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DrugCode

Lists all DrugCode

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/drug-codes
Request samples 
Response samples 
No sample
Get DrugCode
Gets DrugCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
drugCodeKey
required
integer <int32> 
DrugCode Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/drug-codes/{drugCodeKey}
Request samples 
Response samples 
No sample
Update DrugCode
Updates a specific DrugCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
drugCodeKey
required
integer <int32> 
DrugCode Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
drugCode_Key
required
integer <int32> 
 
application_Number
string or null  <= 32 characters 
 
deA_Schedule
string or null  <= 64 characters 
 
description
string or null
 
dosage_For_Name
string or null  <= 512 characters 
 
drug_Code
required
string  [ 1 .. 32 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
labeler_Code
string or null  <= 6 characters 
 
labeler_Name
string or null  <= 512 characters 
 
listing_Record_Certified_Through
string or null <date-time> 
 
marketing_Category_Name
string or null  <= 64 characters 
 
ndC_Package_Code
string or null  <= 32 characters 
 
non_Proprietary_Name
string or null  <= 512 characters 
 
package_Code
string or null  <= 2 characters 
 
package_End_Marketing_Date
string or null <date-time> 
 
package_NDC_Exclude_Flag
string or null  <= 8 characters 
 
package_Size
string or null  <= 25 characters 
 
package_Start_Marketing_Date
string or null <date-time> 
 
package_Type
string or null  <= 25 characters 
 
pharmacy_Class
string or null
 
product_Code
string or null  <= 32 characters 
 
product_End_Marketing_Date
string or null <date-time> 
 
product_NDC_Exclude_Flag
string or null  <= 8 characters 
 
product_Start_Marketing_Date
string or null <date-time> 
 
product_Type_Name
string or null  <= 512 characters 
 
proprietary_Name
string or null  <= 512 characters 
 
proprietary_Name_Suffix
string or null  <= 64 characters 
 
rX_OTC
string or null  <= 1 characters 
 
route_Name
string or null  <= 512 characters 
 
sample_Package
string or null  <= 8 characters 
 
strength
string or null  <= 32 characters 
 
substance_Name
string or null  <= 512 characters 
 
trade_Name
string or null  <= 100 characters 
 
unit
string or null  <= 32 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/drug-codes/{drugCodeKey}
Request samples 
{
  • "drugCode_Key": 0,
  • "application_Number": "string",
  • "deA_Schedule": "string",
  • "description": "string",
  • "dosage_For_Name": "string",
  • "drug_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "labeler_Code": "string",
  • "labeler_Name": "string",
  • "listing_Record_Certified_Through": "2019-08-24T14:15:22Z",
  • "marketing_Category_Name": "string",
  • "ndC_Package_Code": "string",
  • "non_Proprietary_Name": "string",
  • "package_Code": "st",
  • "package_End_Marketing_Date": "2019-08-24T14:15:22Z",
  • "package_NDC_Exclude_Flag": "string",
  • "package_Size": "string",
  • "package_Start_Marketing_Date": "2019-08-24T14:15:22Z",
  • "package_Type": "string",
  • "pharmacy_Class": "string",
  • "product_Code": "string",
  • "product_End_Marketing_Date": "2019-08-24T14:15:22Z",
  • "product_NDC_Exclude_Flag": "string",
  • "product_Start_Marketing_Date": "2019-08-24T14:15:22Z",
  • "product_Type_Name": "string",
  • "proprietary_Name": "string",
  • "proprietary_Name_Suffix": "string",
  • "rX_OTC": "s",
  • "route_Name": "string",
  • "sample_Package": "string",
  • "strength": "string",
  • "substance_Name": "string",
  • "trade_Name": "string",
  • "unit": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DrugCode
Deletes an DrugCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
drugCodeKey
required
integer <int32> 
DrugCode Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/drug-codes/{drugCodeKey}
Request samples 
Create or Update Batch DrugCode
Create or Update multiple DrugCode 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 
drugCode_Key
required
integer <int32> 
 
application_Number
string or null  <= 32 characters 
 
deA_Schedule
string or null  <= 64 characters 
 
description
string or null
 
dosage_For_Name
string or null  <= 512 characters 
 
drug_Code
required
string  [ 1 .. 32 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
labeler_Code
string or null  <= 6 characters 
 
labeler_Name
string or null  <= 512 characters 
 
listing_Record_Certified_Through
string or null <date-time> 
 
marketing_Category_Name
string or null  <= 64 characters 
 
ndC_Package_Code
string or null  <= 32 characters 
 
non_Proprietary_Name
string or null  <= 512 characters 
 
package_Code
string or null  <= 2 characters 
 
package_End_Marketing_Date
string or null <date-time> 
 
package_NDC_Exclude_Flag
string or null  <= 8 characters 
 
package_Size
string or null  <= 25 characters 
 
package_Start_Marketing_Date
string or null <date-time> 
 
package_Type
string or null  <= 25 characters 
 
pharmacy_Class
string or null
 
product_Code
string or null  <= 32 characters 
 
product_End_Marketing_Date
string or null <date-time> 
 
product_NDC_Exclude_Flag
string or null  <= 8 characters 
 
product_Start_Marketing_Date
string or null <date-time> 
 
product_Type_Name
string or null  <= 512 characters 
 
proprietary_Name
string or null  <= 512 characters 
 
proprietary_Name_Suffix
string or null  <= 64 characters 
 
rX_OTC
string or null  <= 1 characters 
 
route_Name
string or null  <= 512 characters 
 
sample_Package
string or null  <= 8 characters 
 
strength
string or null  <= 32 characters 
 
substance_Name
string or null  <= 512 characters 
 
trade_Name
string or null  <= 100 characters 
 
unit
string or null  <= 32 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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