Provider Credentialing Certifications

Create ProviderCredCertification

Creates a new ProviderCredCertification

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

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCredCertification_Key
required
integer <int32>

Unique identifier for each certification record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

certification_Date
string or null <date-time>

Date when the certification becomes/became effective.

certification_Details
string or null <= 512 characters

Allows the User to add a description of the assocaited certification.

certification_Expiration_Date
string or null <date-time>

Date when the certification expires/expired.

credCertification_Key
required
integer <int32>

Indicates the type of certification for the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

psV_Date
string or null <date-time>

Primary Source Verification date.

providerCred_Key
required
integer <int32>

Associates these custom certification values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/provider-credentialing/{providerCredKey}/certifications
Request samples
{
  • "providerCredCertification_Key": 0,
  • "certification_Date": "2019-08-24T14:15:22Z",
  • "certification_Details": "string",
  • "certification_Expiration_Date": "2019-08-24T14:15:22Z",
  • "credCertification_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "psV_Date": "2019-08-24T14:15:22Z",
  • "providerCred_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredCertification

Lists all ProviderCredCertification for the given providerCredKey

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

ProviderCred Key

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/provider-credentialing/{providerCredKey}/certifications
Request samples 
Response samples 
No sample
Get ProviderCredCertification
Gets ProviderCredCertification


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerCredKey
required
integer <int32> 
ProviderCred Key


 
providerCredCertificationKey
required
integer <int32> 
ProviderCredCertification Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-credentialing/{providerCredKey}/certifications/{providerCredCertificationKey}
Request samples 
Response samples 
No sample
Update ProviderCredCertification
Updates a specific ProviderCredCertification.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerCredKey
required
integer <int32> 
ProviderCred Key


 
providerCredCertificationKey
required
integer <int32> 
ProviderCredCertification Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerCredCertification_Key
required
integer <int32> 
Unique identifier for each certification record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
certification_Date
string or null <date-time> 
Date when the certification becomes/became effective.


 
certification_Details
string or null  <= 512 characters 
Allows the User to add a description of the assocaited certification.


 
certification_Expiration_Date
string or null <date-time> 
Date when the certification expires/expired.


 
credCertification_Key
required
integer <int32> 
Indicates the type of certification for the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
psV_Date
string or null <date-time> 
Primary Source Verification date.


 
providerCred_Key
required
integer <int32> 
Associates these custom certification values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/provider-credentialing/{providerCredKey}/certifications/{providerCredCertificationKey}
Request samples 
{
  • "providerCredCertification_Key": 0,
  • "certification_Date": "2019-08-24T14:15:22Z",
  • "certification_Details": "string",
  • "certification_Expiration_Date": "2019-08-24T14:15:22Z",
  • "credCertification_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "psV_Date": "2019-08-24T14:15:22Z",
  • "providerCred_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCredCertification
Deletes an ProviderCredCertification


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerCredKey
required
integer <int32> 
ProviderCred Key


 
providerCredCertificationKey
required
integer <int32> 
ProviderCredCertification Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-credentialing/{providerCredKey}/certifications/{providerCredCertificationKey}
Request samples 
Create or Update Batch ProviderCredCertification
Create or Update multiple ProviderCredCertification 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
providerCredKey
required
integer <int32> 
ProviderCred Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
providerCredCertification_Key
required
integer <int32> 
Unique identifier for each certification record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
certification_Date
string or null <date-time> 
Date when the certification becomes/became effective.


 
certification_Details
string or null  <= 512 characters 
Allows the User to add a description of the assocaited certification.


 
certification_Expiration_Date
string or null <date-time> 
Date when the certification expires/expired.


 
credCertification_Key
required
integer <int32> 
Indicates the type of certification for the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


 
psV_Date
string or null <date-time> 
Primary Source Verification date.


 
providerCred_Key
required
integer <int32> 
Associates these custom certification values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/provider-credentialing/{providerCredKey}/certifications-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}