User Note Access

Create User Note Access

Creates a new User Note Access

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
userNoteAccess_Key
required
integer <int32>

ID of the User note access. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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_Access
required
integer <int32>

Identifies the access level that will be applied to the selected note type. Note: This field is marked as NOT NULL in the database and therefore required by the API.

note_Type
string or null <= 8 characters

Identifies the note type that the selected level of access will be applied to.

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

user_ID
required
string [ 1 .. 20 ] characters

ID of the User to whom the note access will be applied.

Responses
200

Success

401

Unauthorized

post/users/{userID}/note-access
Request samples
{
  • "userNoteAccess_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Access": 0,
  • "note_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List User Note Access

Lists all User Note Access given a specific userID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/users/{userID}/note-access
Request samples 
Response samples 
No sample
Get User Note Access
Gets User Note Access


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userNoteAccessKey
required
integer <int32> 
UserNoteAccess Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/users/{userID}/note-access/{userNoteAccessKey}
Request samples 
Response samples 
No sample
Update User Note Access
Updates a specific User Note Access.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userNoteAccessKey
required
integer <int32> 
UserNoteAccess Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userNoteAccess_Key
required
integer <int32> 
ID of the User note access. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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_Access
required
integer <int32> 
Identifies the access level that will be applied to the selected note type. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
note_Type
string or null  <= 8 characters 
Identifies the note type that the selected level of access will be applied to.


 
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


 
user_ID
required
string  [ 1 .. 20 ] characters 
ID of the User to whom the note access will be applied.


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}/note-access/{userNoteAccessKey}
Request samples 
{
  • "userNoteAccess_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Access": 0,
  • "note_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete User Note Access
Deletes an User Note Access


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
userNoteAccessKey
required
integer <int32> 
User Note Access Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/users/{userID}/note-access/{userNoteAccessKey}
Request samples 
Create or Update Batch User Note Access
Create or Update multiple User Note Access 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
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
userNoteAccess_Key
required
integer <int32> 
ID of the User note access. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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_Access
required
integer <int32> 
Identifies the access level that will be applied to the selected note type. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
note_Type
string or null  <= 8 characters 
Identifies the note type that the selected level of access will be applied to.


 
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


 
user_ID
required
string  [ 1 .. 20 ] characters 
ID of the User to whom the note access will be applied.


 
Responses 
207
Success


401
Unauthorized


put/users/{userID}/note-access-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}