Credentialing Techniques

Create CredTechnique

Creates a new CredTechnique

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
credTechnique_Key
required
integer <int32>

Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 512 characters

Description of the credentialing technique.

display
string or null <= 128 characters

Name of the credentialing technique.

entry_Date
string <date-time>

Date when the 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 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/credentialing-techniques
Request samples
{
  • "credTechnique_Key": 0,
  • "description": "string",
  • "display": "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 CredTechnique

Lists all CredTechnique

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/credentialing-techniques
Request samples
Response samples
No sample

Get CredTechnique

Gets CredTechnique

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
credTechniqueKey
required
integer <int32>

CredTechnique Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/credentialing-techniques/{credTechniqueKey}
Request samples
Response samples
No sample

Update CredTechnique

Updates a specific CredTechnique.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
credTechniqueKey
required
integer <int32>

CredTechnique Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
credTechnique_Key
required
integer <int32>

Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 512 characters

Description of the credentialing technique.

display
string or null <= 128 characters

Name of the credentialing technique.

entry_Date
string <date-time>

Date when the 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 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/credentialing-techniques/{credTechniqueKey}
Request samples
{
  • "credTechnique_Key": 0,
  • "description": "string",
  • "display": "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 CredTechnique

Deletes an CredTechnique

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
credTechniqueKey
required
integer <int32>

CredTechnique Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/credentialing-techniques/{credTechniqueKey}
Request samples

Create or Update Batch CredTechnique

Create or Update multiple CredTechnique 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
credTechnique_Key
required
integer <int32>

Unique Identity Key associated with this table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 512 characters

Description of the credentialing technique.

display
string or null <= 128 characters

Name of the credentialing technique.

entry_Date
string <date-time>

Date when the 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 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/credentialing-techniques-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}