Reasons

Create Reasons

Creates a new Reasons

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reason_ID
required
integer <int32>

Identifier for a specific enrollment change Note: This field is marked as NOT NULL in the database and therefore required by the API.

cobrA_Length
integer or null <int32>

Time period for COBRA election

cobrA_Length_Type
string or null <= 32 characters

Units of the time period for COBRA election

description
string or null <= 50 characters

Description for a specific enrollment change

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

hipaA_Code
string or null <= 8 characters

HIPAA code associate with the reason

hsrS_Code
string or null <= 2 characters

Human Services Reporting System code associated with the reason

reason_Type
string or null <= 32 characters

Specifies if the reason is a qualifying event, standard reason or not specified

update_Date
string <date-time>

Date 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/reasons
Request samples
{
  • "reason_ID": 0,
  • "cobrA_Length": 0,
  • "cobrA_Length_Type": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "hsrS_Code": "st",
  • "reason_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Reasons

Lists all Reasons

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reasons
Request samples 
Response samples 
No sample
Get Reasons
Gets Reasons


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reasonID
required
integer <int32> 
Reason ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/reasons/{reasonID}
Request samples 
Response samples 
No sample
Update Reasons
Updates a specific Reasons.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reasonID
required
integer <int32> 
Reason ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reason_ID
required
integer <int32> 
Identifier for a specific enrollment change Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cobrA_Length
integer or null <int32> 
Time period for COBRA election


 
cobrA_Length_Type
string or null  <= 32 characters 
Units of the time period for COBRA election


 
description
string or null  <= 50 characters 
Description for a specific enrollment change


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


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


 
hipaA_Code
string or null  <= 8 characters 
HIPAA code associate with the reason


 
hsrS_Code
string or null  <= 2 characters 
Human Services Reporting System code associated with the reason


 
reason_Type
string or null  <= 32 characters 
Specifies if the reason is a qualifying event, standard reason or not specified


 
update_Date
string <date-time> 
Date 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/reasons/{reasonID}
Request samples 
{
  • "reason_ID": 0,
  • "cobrA_Length": 0,
  • "cobrA_Length_Type": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "hipaA_Code": "string",
  • "hsrS_Code": "st",
  • "reason_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Reasons
Deletes an Reasons


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reasonID
required
integer <int32> 
Reason ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/reasons/{reasonID}
Request samples 
Create or Update Batch Reasons
Create or Update multiple Reasons 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 
reason_ID
required
integer <int32> 
Identifier for a specific enrollment change Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cobrA_Length
integer or null <int32> 
Time period for COBRA election


 
cobrA_Length_Type
string or null  <= 32 characters 
Units of the time period for COBRA election


 
description
string or null  <= 50 characters 
Description for a specific enrollment change


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


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


 
hipaA_Code
string or null  <= 8 characters 
HIPAA code associate with the reason


 
hsrS_Code
string or null  <= 2 characters 
Human Services Reporting System code associated with the reason


 
reason_Type
string or null  <= 32 characters 
Specifies if the reason is a qualifying event, standard reason or not specified


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