VBAInterface ID Codes

Create VBAInterfaceIDCode

Creates a new VBAInterfaceIDCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
vBAInterfaceKey
required
integer <int32>

VBAInterface Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
vbaInterface_Key
required
integer <int32>

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

iD_Code
required
string [ 1 .. 16 ] characters

ID code associated with the interface item.

type
required
string [ 1 .. 16 ] characters

Type associated with the interface item.

description
string or null

Description of the interface item.

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

surrogate_ID_Code
string or null <= 16 characters

System Configuration Values used by VBA Engineers to group ID Codes with similar functionality.

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/vba-interfaces/{vBAInterfaceKey}/id-codes
Request samples
{
  • "vbaInterface_Key": 0,
  • "iD_Code": "string",
  • "type": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "surrogate_ID_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List VBAInterfaceIDCode

Lists all VBAInterfaceIDCode for the given vBAInterfaceKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
vBAInterfaceKey
required
integer <int32>

VBAInterface Key

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/vba-interfaces/{vBAInterfaceKey}/id-codes
Request samples 
Response samples 
No sample
Get VBAInterfaceIDCode
Gets VBAInterfaceIDCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
type
required
string
Type


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/vba-interfaces/{vBAInterfaceKey}/id-codes/{type}/{iDCode}
Request samples 
Response samples 
No sample
Update VBAInterfaceIDCode
Updates a specific VBAInterfaceIDCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
type
required
string
Type


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
iD_Code
required
string  [ 1 .. 16 ] characters 
ID code associated with the interface item.


 
type
required
string  [ 1 .. 16 ] characters 
Type associated with the interface item.


 
description
string or null
Description of the interface item.


 
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


 
surrogate_ID_Code
string or null  <= 16 characters 
System Configuration Values used by VBA Engineers to group ID Codes with similar functionality.


 
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/vba-interfaces/{vBAInterfaceKey}/id-codes/{type}/{iDCode}
Request samples 
{
  • "vbaInterface_Key": 0,
  • "iD_Code": "string",
  • "type": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "surrogate_ID_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAInterfaceIDCode
Deletes an VBAInterfaceIDCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
type
required
string
Type


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/vba-interfaces/{vBAInterfaceKey}/id-codes/{type}/{iDCode}
Request samples 
Create or Update Batch VBAInterfaceIDCode
Create or Update multiple VBAInterfaceIDCode 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
vBAInterfaceKey
required
integer <int32> 
VBAInterface Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
iD_Code
required
string  [ 1 .. 16 ] characters 
ID code associated with the interface item.


 
type
required
string  [ 1 .. 16 ] characters 
Type associated with the interface item.


 
description
string or null
Description of the interface item.


 
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


 
surrogate_ID_Code
string or null  <= 16 characters 
System Configuration Values used by VBA Engineers to group ID Codes with similar functionality.


 
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/vba-interfaces/{vBAInterfaceKey}/id-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}