ID Code Values

Create IDCodeValue

Creates a new IDCodeValue

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
type
required
string

Type

idCode
required
string

ID Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
idCodeValue_Key
required
integer <int32>

Key value identifying a specific ID Code value 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.

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

iD_Code
required
string [ 1 .. 16 ] characters

Identifier for a specific ID Code

iD_Code_Data
string or null <= 500 characters

Data value for the ID Code when it is a string

iD_Code_Data_Date
string or null <date-time>

Data value for the ID Code when it is a datetime field

iD_Code_Data_Decimal
number or null <double>

Data value for the ID Code when it is a decimal

iD_Code_Data_Number
integer or null <int32>

Data value for the ID Code when it is a integer

iD_Code_Data_Option
boolean or null

Data value for the ID Code when it is a bit

key_Column1
string or null <= 128 characters

Key value column name that the ID Code is associated with

key_Column2
string or null <= 128 characters

Additional key value column name that the ID Code is associated with (if needed)

key_Column3
string or null <= 128 characters

Additional key value column name that the ID Code is associated with (if needed)

key_Column4
string or null <= 128 characters

Additional key value column name that the ID Code is associated with (if needed)

key_Column5
string or null <= 128 characters

Additional key value column name that the ID Code is associated with (if needed)

key_DataType1
string or null <= 32 characters

Data type of the key value column the ID Code is associated with

key_DataType2
string or null <= 32 characters

Additional data type of the key value column the ID Code is associated with (if needed)

key_DataType3
string or null <= 32 characters

Additional data type of the key value column the ID Code is associated with (if needed)

key_DataType4
string or null <= 32 characters

Additional data type of the key value column the ID Code is associated with (if needed)

key_DataType5
string or null <= 32 characters

Additional data type of the key value column the ID Code is associated with (if needed)

key_Value1
string or null <= 128 characters

Value of the key value column the ID Code is associated with

key_Value2
string or null <= 128 characters

Additional value of the key value column the ID Code is associated with (if needed)

key_Value3
string or null <= 128 characters

Additional value of the key value column the ID Code is associated with (if needed)

key_Value4
string or null <= 128 characters

Additional value of the key value column the ID Code is associated with (if needed)

key_Value5
string or null <= 128 characters

Additional value of the key value column the ID Code is associated with (if needed)

type
required
string [ 1 .. 16 ] characters

Type of the ID Code

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/id-types/{type}/id-codes/{idCode}/id-code-values
Request samples
{
  • "idCodeValue_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "iD_Code": "string",
  • "iD_Code_Data": "string",
  • "iD_Code_Data_Date": "2019-08-24T14:15:22Z",
  • "iD_Code_Data_Decimal": 0.1,
  • "iD_Code_Data_Number": 0,
  • "iD_Code_Data_Option": true,
  • "key_Column1": "string",
  • "key_Column2": "string",
  • "key_Column3": "string",
  • "key_Column4": "string",
  • "key_Column5": "string",
  • "key_DataType1": "string",
  • "key_DataType2": "string",
  • "key_DataType3": "string",
  • "key_DataType4": "string",
  • "key_DataType5": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List IDCodeValue

Lists all IDCodeValue for the given type and idCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
type
required
string

Type

idCode
required
string

ID Code

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/id-types/{type}/id-codes/{idCode}/id-code-values
Request samples 
Response samples 
No sample
List IDCodeValue based on Source
Lists all IDCodeValue for the given type and specific source
                Based on IDCodeType we will return different values.


            AUTH
                @SourceColumn1 = auth_number

            BENEFIT
                @SourceColumn1 = benefit_code

            CAREPLAN
                @SourceColumn1 = case_key

            CARRIER
                @SourceColumn1 = carrier_key

            CASE
                @SourceColumn1 = case_key

            CLAIM
                @SourceColumn1 = batch_number
                @SourceColumn2 = batch_claim

            CLMBTCH
                @SourceColumn1 = batch_number

            COMMAGENCY
                @SourceColumn1 = commissionagency_key

            COMMREP
                @SourceColumn1 = commissionrep_key

            COMPANYDATA
                @SourceColumn1 = key_value

            CONTRACTRIDER
                @SourceColumn1 = group_id
                @SourceColumn2 = division_id
                @SourceColumn3 = coverage_start
                @SourceColumn4 = plan_id
                @SourceColumn5 = benefit_code

            CREDQUESTION
                @SourceColumn1 = credattestationquestion_key

            DISREASON
                @SourceColumn1 = reason_id

            FUNDINGACCOUNT
                @SourceColumn1 = account_key

            GRIEV
                @SourceColumn1 = grievance_key

            GROUP
                @SourceColumn1 = group_id

            GROUPDIVISION
                @SourceColumn1 = group_id
                @SourceColumn1 = division_id

            GROUPNETWORK
                @SourceColumn1 = group_id
                @SourceColumn2 = division_id
                @SourceColumn3 = coverage_start
                @SourceColumn4 = networkid

            GROUPPLAN
                @SourceColumn1 = group_id
                @SourceColumn2 = division_id
                @SourceColumn3 = plan_id

            INTRFACE
                @SourceColumn1 = vbainterface_key

            MEMBER
                @SourceColumn1 = subscriber_id
                @SourceColumn2 = member_seq

            NETWORK
                @SourceColumn1 = networkid

            PAYEE
                @SourceColumn1 = payee_id

            PAYOR
                @SourceColumn1 = payor_id

            PLAN
                @SourceColumn1 = plan_id

            PROV
                @SourceColumn1 = provider_id

            PROVCRED
                @SourceColumn1 = providercred_key

            REINS
                @SourceColumn1 = reinscontract_key

            SUBSCRIBER
                @SourceColumn1 = subscriber_id

            USER
                @SourceColumn1 = user_id
            



SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
type
required
string
Type


 
columnName1
required
string
Column_Name1


 
keyValue1
required
string
Key_Value1


 
columnName2
string
Column_Name2


 
keyValue2
string
Key_Value2


 
columnName3
string
Column_Name3


 
keyValue3
string
Key_Value3


 
columnName4
string
Column_Name4


 
keyValue4
string
Key_Value4


 
columnName5
string
Column_Name5


 
keyValue5
string
Key_Value5


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/id-code-values-by-source
Request samples 
Response samples 
No sample
Get IDCodeValue
Gets IDCodeValue


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
type
required
string
Type


 
idCode
required
string
ID Code


 
idCodeValueKey
required
integer <int32> 
IDCodeValue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/id-types/{type}/id-codes/{idCode}/id-code-values/{idCodeValueKey}
Request samples 
Response samples 
No sample
Update IDCodeValue
Updates a specific IDCodeValue.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
type
required
string
Type


 
idCode
required
string
ID Code


 
idCodeValueKey
required
integer <int32> 
IDCodeValue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
idCodeValue_Key
required
integer <int32> 
Key value identifying a specific ID Code value  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.


 
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


 
iD_Code
required
string  [ 1 .. 16 ] characters 
Identifier for a specific ID Code


 
iD_Code_Data
string or null  <= 500 characters 
Data value for the ID Code when it is a string


 
iD_Code_Data_Date
string or null <date-time> 
Data value for the ID Code when it is a datetime field


 
iD_Code_Data_Decimal
number or null <double> 
Data value for the ID Code when it is a decimal


 
iD_Code_Data_Number
integer or null <int32> 
Data value for the ID Code when it is a integer


 
iD_Code_Data_Option
boolean or null
Data value for the ID Code when it is a bit


 
key_Column1
string or null  <= 128 characters 
Key value column name that the ID Code is associated with


 
key_Column2
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_Column3
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_Column4
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_Column5
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_DataType1
string or null  <= 32 characters 
Data type of the key value column the ID Code is associated with


 
key_DataType2
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_DataType3
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_DataType4
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_DataType5
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_Value1
string or null  <= 128 characters 
Value of the key value column the ID Code is associated with


 
key_Value2
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
key_Value3
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
key_Value4
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
key_Value5
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
type
required
string  [ 1 .. 16 ] characters 
Type of the ID Code


 
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/id-types/{type}/id-codes/{idCode}/id-code-values/{idCodeValueKey}
Request samples 
{
  • "idCodeValue_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "iD_Code": "string",
  • "iD_Code_Data": "string",
  • "iD_Code_Data_Date": "2019-08-24T14:15:22Z",
  • "iD_Code_Data_Decimal": 0.1,
  • "iD_Code_Data_Number": 0,
  • "iD_Code_Data_Option": true,
  • "key_Column1": "string",
  • "key_Column2": "string",
  • "key_Column3": "string",
  • "key_Column4": "string",
  • "key_Column5": "string",
  • "key_DataType1": "string",
  • "key_DataType2": "string",
  • "key_DataType3": "string",
  • "key_DataType4": "string",
  • "key_DataType5": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete IDCodeValue
Deletes an IDCodeValue


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
type
required
string
Type


 
idCode
required
string
ID Code


 
idCodeValueKey
required
integer <int32> 
IDCodeValue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/id-types/{type}/id-codes/{idCode}/id-code-values/{idCodeValueKey}
Request samples 
Create or Update Batch IDCodeValue
Create or Update multiple IDCodeValue 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
type
required
string
Type


 
idCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
idCodeValue_Key
required
integer <int32> 
Key value identifying a specific ID Code value  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.


 
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


 
iD_Code
required
string  [ 1 .. 16 ] characters 
Identifier for a specific ID Code


 
iD_Code_Data
string or null  <= 500 characters 
Data value for the ID Code when it is a string


 
iD_Code_Data_Date
string or null <date-time> 
Data value for the ID Code when it is a datetime field


 
iD_Code_Data_Decimal
number or null <double> 
Data value for the ID Code when it is a decimal


 
iD_Code_Data_Number
integer or null <int32> 
Data value for the ID Code when it is a integer


 
iD_Code_Data_Option
boolean or null
Data value for the ID Code when it is a bit


 
key_Column1
string or null  <= 128 characters 
Key value column name that the ID Code is associated with


 
key_Column2
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_Column3
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_Column4
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_Column5
string or null  <= 128 characters 
Additional key value column name that the ID Code is associated with (if needed)


 
key_DataType1
string or null  <= 32 characters 
Data type of the key value column the ID Code is associated with


 
key_DataType2
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_DataType3
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_DataType4
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_DataType5
string or null  <= 32 characters 
Additional data type of the key value column the ID Code is associated with (if needed)


 
key_Value1
string or null  <= 128 characters 
Value of the key value column the ID Code is associated with


 
key_Value2
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
key_Value3
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
key_Value4
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
key_Value5
string or null  <= 128 characters 
Additional value of the key value column the ID Code is associated with (if needed)


 
type
required
string  [ 1 .. 16 ] characters 
Type of the ID Code


 
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/id-types/{type}/id-codes/{idCode}/id-code-values-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}