Benefit Categories

Create BenefitCategory

Creates a new BenefitCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
benefit_Category
required
string [ 1 .. 32 ] characters

Unique identifier assigned to the Benefit Category.

description
string or null <= 128 characters

Description of the associated Benefit Category.

entry_Date
string <date-time>

Date when the record was 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/benefit-categories
Request samples
{
  • "benefit_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 BenefitCategory

Lists all BenefitCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/benefit-categories
Request samples 
Response samples 
No sample
Get BenefitCategory
Gets BenefitCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCategory
required
string
Benefit Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/benefit-categories/{benefitCategory}
Request samples 
Response samples 
No sample
Update BenefitCategory
Updates a specific BenefitCategory.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCategory
required
string
Benefit Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
benefit_Category
required
string  [ 1 .. 32 ] characters 
Unique identifier assigned to the Benefit Category.


 
description
string or null  <= 128 characters 
Description of the associated Benefit Category.


 
entry_Date
string <date-time> 
Date when the record was 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/benefit-categories/{benefitCategory}
Request samples 
{
  • "benefit_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 BenefitCategory
Deletes an BenefitCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCategory
required
string
Benefit Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/benefit-categories/{benefitCategory}
Request samples 
Create or Update Batch BenefitCategory
Create or Update multiple BenefitCategory 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 
benefit_Category
required
string  [ 1 .. 32 ] characters 
Unique identifier assigned to the Benefit Category.


 
description
string or null  <= 128 characters 
Description of the associated Benefit Category.


 
entry_Date
string <date-time> 
Date when the record was 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/benefit-categories-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}