HIPAA Tiers

Create HIPAATier

Creates a new HIPAATier

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

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

Code identifying the HIPAA tier

description
string or null <= 512 characters

Description of the HIPAA tier

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

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/hipaa-tiers
Request samples
{
  • "hipaA_Code": "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 HIPAATier

Lists all HIPAATier given a specific

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/hipaa-tiers
Request samples
Response samples
No sample

Get HIPAATier

Gets HIPAATier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
hIPAACode
required
string

HIPAA Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/hipaa-tiers/{hIPAACode}
Request samples
Response samples
No sample

Update HIPAATier

Updates a specific HIPAATier.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
hIPAACode
required
string

HIPAA Code

header Parameters
vbasoftware-database
required
string

Target database

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

Code identifying the HIPAA tier

description
string or null <= 512 characters

Description of the HIPAA tier

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

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/hipaa-tiers/{hIPAACode}
Request samples
{
  • "hipaA_Code": "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 HIPAATier

Deletes an HIPAATier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
hIPAACode
required
string

HIPAA Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/hipaa-tiers/{hIPAACode}
Request samples

Create or Update Batch HIPAATier

Create or Update multiple HIPAATier 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
hipaA_Code
required
string [ 1 .. 8 ] characters

Code identifying the HIPAA tier

description
string or null <= 512 characters

Description of the HIPAA tier

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

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