Eligibility Status

Create EligibilityStatus

Creates a new EligibilityStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
eligibility_Status
required
string [ 1 .. 8 ] characters

Identifier for a specified eligibility status

description
string or null <= 64 characters

Description of the eligibility status

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

sec111_Exclude
required
boolean

Indicates if the eligibility status excludes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.

sec111_Include
required
boolean

Indicates if the eligibility status includes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.

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/eligibility-statuses
Request samples
{
  • "eligibility_Status": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "sec111_Exclude": true,
  • "sec111_Include": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EligibilityStatus

Lists all EligibilityStatus for the given eligibilityStatus

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/eligibility-statuses
Request samples 
Response samples 
No sample
Get EligibilityStatus
Gets EligibilityStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eligibilityStatus
required
string
Eligibility Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/eligibility-statuses/{eligibilityStatus}
Request samples 
Response samples 
No sample
Update EligibilityStatus
Updates a specific EligibilityStatus.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eligibilityStatus
required
string
Eligibility Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
eligibility_Status
required
string  [ 1 .. 8 ] characters 
Identifier for a specified eligibility status


 
description
string or null  <= 64 characters 
Description of the eligibility status


 
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


 
sec111_Exclude
required
boolean
Indicates if the eligibility status excludes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
sec111_Include
required
boolean
Indicates if the eligibility status includes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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/eligibility-statuses/{eligibilityStatus}
Request samples 
{
  • "eligibility_Status": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "sec111_Exclude": true,
  • "sec111_Include": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EligibilityStatus
Deletes an EligibilityStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eligibilityStatus
required
string
Eligibility Status


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/eligibility-statuses/{eligibilityStatus}
Request samples 
Create or Update Batch EligibilityStatus
Create or Update multiple EligibilityStatus 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 
eligibility_Status
required
string  [ 1 .. 8 ] characters 
Identifier for a specified eligibility status


 
description
string or null  <= 64 characters 
Description of the eligibility status


 
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


 
sec111_Exclude
required
boolean
Indicates if the eligibility status excludes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
sec111_Include
required
boolean
Indicates if the eligibility status includes section 111 Note: This field is marked as NOT NULL in the database and therefore required by the API.


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