Group Premium Rate Categories

Create GroupPremRateCategory

Creates a new GroupPremRateCategory

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

reportDefinitionKey
required
integer <int32>

ReportDefinition Key

header Parameters
vbasoftware-database
required
string

Target database

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

References Groups.Group_ID value on the parent record.

reportDefinition_Key
required
integer <int32>

References ReportDefinition.ReportDefinition_Key on the referenced record. This is the report (of Report_Category "INV") that will have a dynamic sequence of premrate categories.

premRate_Category
required
string [ 1 .. 32 ] characters

References PremRateCategory.PremRate_Category on the referenced record. This si the category that will be sequenced on a "INV" report.

sequence
required
integer <int32>

The suquence of this Category on the "INV" report.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories
Request samples
{
  • "group_ID": "string",
  • "reportDefinition_Key": 0,
  • "premRate_Category": "string",
  • "sequence": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupPremRateCategory

Lists all GroupPremRateCategory for the given groupID and reportDefinitionKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

reportDefinitionKey
required
integer <int32>

ReportDefinition 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/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories
Request samples 
Response samples 
No sample
Get GroupPremRateCategory
Gets GroupPremRateCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
sequence
required
integer <int32> 
Sequence


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories/{sequence}
Request samples 
Response samples 
No sample
Delete GroupPremRateCategory
Deletes an GroupPremRateCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
sequence
required
integer <int32> 
Sequence


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories/{sequence}
Request samples 
Create or Update Batch GroupPremRateCategory
Create or Update multiple GroupPremRateCategory 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


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
reportDefinition_Key
required
integer <int32> 
References ReportDefinition.ReportDefinition_Key on the referenced record. This is the report (of Report_Category "INV") that will have a dynamic sequence of premrate categories.


 
premRate_Category
required
string  [ 1 .. 32 ] characters 
References PremRateCategory.PremRate_Category on the referenced record. This si the category that will be sequenced on a "INV" report.


 
sequence
required
integer <int32> 
The suquence of this Category on the "INV" report.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/reports/{reportDefinitionKey}/premium-categories-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}