Premium Rate Categories

Create PremRateCategory

Creates a new PremRateCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRate_Category
required
string [ 1 .. 32 ] characters
description
string or null <= 128 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-rate-categories
Request samples
{
  • "premRate_Category": "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 PremRateCategory

Lists all PremRateCategory

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/premium-rate-categories
Request samples
Response samples
No sample

Get PremRateCategory

Gets PremRateCategory

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateCategory
required
string

PremRate Category

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/premium-rate-categories/{premRateCategory}
Request samples
Response samples
No sample

Update PremRateCategory

Updates a specific PremRateCategory.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateCategory
required
string

PremRate Category

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRate_Category
required
string [ 1 .. 32 ] characters
description
string or null <= 128 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/premium-rate-categories/{premRateCategory}
Request samples
{
  • "premRate_Category": "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 PremRateCategory

Deletes an PremRateCategory

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateCategory
required
string

PremRate Category

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/premium-rate-categories/{premRateCategory}
Request samples

Create or Update Batch PremRateCategory

Create or Update multiple PremRateCategory 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
premRate_Category
required
string [ 1 .. 32 ] characters
description
string or null <= 128 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

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