Group Division ID Codes

Create GroupDivisionIDCode

Creates a new GroupDivisionIDCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

iDCode
required
string

ID Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

No longer in use. Replaced by IDCodeValue table.

division_ID
required
string [ 1 .. 20 ] characters

No longer in use. Replaced by IDCodeValue table.

iD_Code
required
string [ 1 .. 6 ] characters

No longer in use. Replaced by IDCodeValue table.

description
string or null <= 64 characters

No longer in use. Replaced by IDCodeValue table.

entry_Date
string <date-time>

No longer in use. Replaced by IDCodeValue table.

entry_User
string or null <= 20 characters

No longer in use. Replaced by IDCodeValue table.

update_Date
string <date-time>

No longer in use. Replaced by IDCodeValue table.

update_User
string or null <= 20 characters

No longer in use. Replaced by IDCodeValue table.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/id-codes/{iDCode}
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "iD_Code": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get GroupDivisionIDCode

Gets GroupDivisionIDCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

iDCode
required
string

ID Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/divisions/{divisionID}/id-codes/{iDCode}
Request samples 
Response samples 
No sample
Update GroupDivisionIDCode
Updates a specific GroupDivisionIDCode.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by IDCodeValue table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by IDCodeValue table.


 
iD_Code
required
string  [ 1 .. 6 ] characters 
No longer in use. Replaced by IDCodeValue table.


 
description
string or null  <= 64 characters 
No longer in use. Replaced by IDCodeValue table.


 
entry_Date
string <date-time> 
No longer in use. Replaced by IDCodeValue table.


 
entry_User
string or null  <= 20 characters 
No longer in use. Replaced by IDCodeValue table.


 
update_Date
string <date-time> 
No longer in use. Replaced by IDCodeValue table.


 
update_User
string or null  <= 20 characters 
No longer in use. Replaced by IDCodeValue table.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/id-codes/{iDCode}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "iD_Code": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupDivisionIDCode
Deletes an GroupDivisionIDCode


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
iDCode
required
string
ID Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/id-codes/{iDCode}
Request samples 
List GroupDivisionIDCode
Lists all GroupDivisionIDCode for the given groupID and divisionID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
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/groups/{groupID}/divisions/{divisionID}/id-codes
Request samples 
Response samples 
No sample
Create or Update Batch GroupDivisionIDCode
Create or Update multiple GroupDivisionIDCode 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
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by IDCodeValue table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by IDCodeValue table.


 
iD_Code
required
string  [ 1 .. 6 ] characters 
No longer in use. Replaced by IDCodeValue table.


 
description
string or null  <= 64 characters 
No longer in use. Replaced by IDCodeValue table.


 
entry_Date
string <date-time> 
No longer in use. Replaced by IDCodeValue table.


 
entry_User
string or null  <= 20 characters 
No longer in use. Replaced by IDCodeValue table.


 
update_Date
string <date-time> 
No longer in use. Replaced by IDCodeValue table.


 
update_User
string or null  <= 20 characters 
No longer in use. Replaced by IDCodeValue table.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/id-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}