Benefit Places

Create BenefitPlace

Creates a new BenefitPlace

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
benefit_Code
required
string [ 1 .. 10 ] characters

References the BenefitCodes.Benefit_Code from the parent table.

place_Code
required
string [ 1 .. 4 ] characters

Specifies the place of service that the User wishes to either include or exclude as part of the benefit.

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.

exclude
required
boolean

Indicates whether the specified place of service is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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/benefits/{benefitCode}/places
Request samples
{
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List BenefitPlace

Lists all BenefitPlace benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/benefits/{benefitCode}/places
Request samples 
Response samples 
No sample
Get BenefitPlace
Gets BenefitPlace


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/benefits/{benefitCode}/places/{placeCode}
Request samples 
Response samples 
No sample
Update BenefitPlace
Updates a specific BenefitPlace.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code from the parent table.


 
place_Code
required
string  [ 1 .. 4 ] characters 
Specifies the place of service that the User wishes to either include or exclude as part of the benefit.


 
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.


 
exclude
required
boolean
Indicates whether the specified place of service is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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/benefits/{benefitCode}/places/{placeCode}
Request samples 
{
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete BenefitPlace
Deletes an BenefitPlace


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/benefits/{benefitCode}/places/{placeCode}
Request samples 
Create or Update Batch BenefitPlace
Create or Update multiple BenefitPlace 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
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code from the parent table.


 
place_Code
required
string  [ 1 .. 4 ] characters 
Specifies the place of service that the User wishes to either include or exclude as part of the benefit.


 
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.


 
exclude
required
boolean
Indicates whether the specified place of service is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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/benefits/{benefitCode}/places-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}