Group Division Captives

Create GroupDivisionCaptive

Creates a new GroupDivisionCaptive

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupDivisionCaptive1
required
string [ 1 .. 256 ] characters

Unique identifier for this Captive.

description
string or null <= 512 characters

The description for this captive to be used on the Division.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

update_Date
string <date-time>

Date when 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/group-division-captives
Request samples
{
  • "groupDivisionCaptive1": "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": {
    }
}

List GroupDivisionCaptive

Lists all GroupDivisionCaptive

SecurityapiKeyAuth and bearerAuth
Request
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/group-division-captives
Request samples 
Response samples 
No sample
Get GroupDivisionCaptive
Gets GroupDivisionCaptive


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupDivisionCaptive1
required
string
GroupDivisionCaptive1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/group-division-captives/{groupDivisionCaptive1}
Request samples 
Response samples 
No sample
Update GroupDivisionCaptive
Updates a specific GroupDivisionCaptive.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupDivisionCaptive1
required
string
GroupDivisionCaptive1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupDivisionCaptive1
required
string  [ 1 .. 256 ] characters 
Unique identifier for this Captive.


 
description
string or null  <= 512 characters 
The description for this captive to be used on the Division.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
update_Date
string <date-time> 
Date when 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/group-division-captives/{groupDivisionCaptive1}
Request samples 
{
  • "groupDivisionCaptive1": "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 GroupDivisionCaptive
Deletes an GroupDivisionCaptive


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupDivisionCaptive1
required
string
GroupDivisionCaptive1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/group-division-captives/{groupDivisionCaptive1}
Request samples 
Create or Update Batch GroupDivisionCaptive
Create or Update multiple GroupDivisionCaptive 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 
groupDivisionCaptive1
required
string  [ 1 .. 256 ] characters 
Unique identifier for this Captive.


 
description
string or null  <= 512 characters 
The description for this captive to be used on the Division.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
update_Date
string <date-time> 
Date when 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/group-division-captives-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}