Note Data

Create NoteData

Creates a new NoteData

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
note_Key
required
integer <int32>

Key value used to identify a specific note

effective_Date
string or null <date-time>

Date the information in the note goes into effect

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

note_Alert
required
boolean

Flag identifying if there is an alert associated with the note

note_Alert_End
string or null <date-time>

Date the alert associated with a note terminates

note_Category
string or null <= 8 characters

Identifies the 'Category' of note. Note 'Category' are configured within 'Note Configuration'.

note_Data
string or null

Text data of the note.

note_Priority
string or null <= 8 characters

Identifies the 'Priority' of note. Note 'Priority' are configured within 'Note Configuration'.

note_Subject
string or null <= 64 characters

Description of the note's subject.

note_Type
string or null <= 8 characters

Identifies the 'Type' of note. Note 'Types' are configured within 'Note Configuration'.

term_Date
string or null <date-time>

Date the information in the note terminates

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/note-data
Request samples
{
  • "note_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Alert": true,
  • "note_Alert_End": "2019-08-24T14:15:22Z",
  • "note_Category": "string",
  • "note_Data": "string",
  • "note_Priority": "string",
  • "note_Subject": "string",
  • "note_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List NoteData by Source

List of Notes based on a specific source Expectations of Category compared to what is in the source values

        AUTH
        @SourceColumn1 = auth_number

        CALL
        @SourceColumn1 = call_key

        CASE
        @SourceColumn1 = case_key

        CLAIM
        @SourceColumn1 = batch_number
        @SourceColumn2 = batch_claim

        CLMBTCH ** NO REFS **
        @SourceColumn1 = batch_number

        COMMAGEN ** NO REFS **
        @SourceColumn1 = commissionagency_key

        COMMREP ** NO REFS **
        @SourceColumn1 = commissionrep_key

        CORTRACK ** NO REFS **
        @SourceColumn1 = reporttrack_key

        FEESCHED ** NO REFS **
        @SourceColumn1 = fee_sched

        GRIEV
        @SourceColumn1 = grievance_key

        GROUP
        @SourceColumn1 = group_id

        GROUPDIV
        @SourceColumn1 = group_id
        @SourceColumn2 = division_id

        GRPCLASS
        @SourceColumn1 = group_id

        GWREQ ** NO REFS **
        @SourceColumn1 = request_key

        INTRFACE ** NO REFS **
        @SourceColumn1 = vbainterface_key

        INVHDR ** NO REFS **
        @SourceColumn1 = invoice_key

        MEMBER
        @SourceColumn1 = subscriber_id
        @SourceColumn2 = member_seq

        NETWORK ** NO REFS **
        @SourceColumn1 = network_id

        NOTE ** NO REFS **
        @SourceColumn1 = note_key

        PAYEE ** NO REFS **
        @SourceColumn1 = payee_id

        PAYOR ** NO REFS **
        @SourceColumn1 = payor_id

        PBENMAX
        @SourceColumn1 = plan_id
        @SourceColumn2 = benefit_code
        @SourceColumn3 = max_id

        PLAN ** NO REFS **
        @SourceColumn1 = plan_id

        PLANLVL ** NO REFS **
        @SourceColumn1 = planbenefitlevel_key

        PROV ** NO REFS **
        @SourceColumn1 = provider_id

        PROVCRED
        @SourceColumn1 = providercred_key

        REINS
        @SourceColumn1 = reinscontract_key

        REINSTRN
        @SourceColumn1 = reinscontracttrans_key

        SUB
        @SourceColumn1 = subscriber_id
SecurityapiKeyAuth and bearerAuth
Request
query Parameters
noteCategory
required
string

Note_Category

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/note-data
Request samples 
Response samples 
No sample
Get NoteData
Gets NoteData


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteKey
required
integer <int32> 
Note Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/note-data/{noteKey}
Request samples 
Response samples 
No sample
Update NoteData
Updates a specific NoteData.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteKey
required
integer <int32> 
Note Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
note_Key
required
integer <int32> 
Key value used to identify a specific note


 
effective_Date
string or null <date-time> 
Date the information in the note goes into effect


 
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


 
note_Alert
required
boolean
Flag identifying if there is an alert associated with the note


 
note_Alert_End
string or null <date-time> 
Date the alert associated with a note terminates


 
note_Category
string or null  <= 8 characters 
Identifies the 'Category' of note. Note 'Category' are configured within 'Note Configuration'.


 
note_Data
string or null
Text data of the note.


 
note_Priority
string or null  <= 8 characters 
Identifies the 'Priority' of note. Note 'Priority' are configured within 'Note Configuration'.


 
note_Subject
string or null  <= 64 characters 
Description of the note's subject.


 
note_Type
string or null  <= 8 characters 
Identifies the 'Type' of note. Note 'Types' are configured within 'Note Configuration'.


 
term_Date
string or null <date-time> 
Date the information in the note terminates


 
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/note-data/{noteKey}
Request samples 
{
  • "note_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Alert": true,
  • "note_Alert_End": "2019-08-24T14:15:22Z",
  • "note_Category": "string",
  • "note_Data": "string",
  • "note_Priority": "string",
  • "note_Subject": "string",
  • "note_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete NoteData
Deletes an NoteData


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteKey
required
integer <int32> 
Note Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/note-data/{noteKey}
Request samples 
Create or Update Batch NoteData
Create or Update multiple NoteData 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 
note_Key
required
integer <int32> 
Key value used to identify a specific note


 
effective_Date
string or null <date-time> 
Date the information in the note goes into effect


 
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


 
note_Alert
required
boolean
Flag identifying if there is an alert associated with the note


 
note_Alert_End
string or null <date-time> 
Date the alert associated with a note terminates


 
note_Category
string or null  <= 8 characters 
Identifies the 'Category' of note. Note 'Category' are configured within 'Note Configuration'.


 
note_Data
string or null
Text data of the note.


 
note_Priority
string or null  <= 8 characters 
Identifies the 'Priority' of note. Note 'Priority' are configured within 'Note Configuration'.


 
note_Subject
string or null  <= 64 characters 
Description of the note's subject.


 
note_Type
string or null  <= 8 characters 
Identifies the 'Type' of note. Note 'Types' are configured within 'Note Configuration'.


 
term_Date
string or null <date-time> 
Date the information in the note terminates


 
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/note-data-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get Note Attachment Location
Gets Note Attachment Location


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
noteCategory
required
string
Note Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/note-attachment-location/{noteCategory}
Request samples 
Response samples 
No sample