Provider Credentialing Education

Create ProviderCredEducation

Creates a new ProviderCredEducation

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

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCredEducation_Key
required
integer <int32>

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

credEducationType_Key
required
integer <int32>

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

education_Name
string or null <= 128 characters

Name of the educational institution.

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.

gpa
number or null <double>

Grade point average of the Provider from the associated institution.

graduation_Date
string or null <date-time>

Date when the Provider graduated from the associated institution.

honors
string or null <= 256 characters

Identifies any honors that the Provider obtained from the assoicated institution.

providerCred_Key
required
integer <int32>

Associates these custom education 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.

start_Date
string or null <date-time>

Date when the Provider started their education at the associated institution.

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}/education-records
Request samples
{
  • "providerCredEducation_Key": 0,
  • "credEducationType_Key": 0,
  • "education_Name": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "gpa": 0.1,
  • "graduation_Date": "2019-08-24T14:15:22Z",
  • "honors": "string",
  • "providerCred_Key": 0,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredEducation

Lists all ProviderCredEducation 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}/education-records
Request samples 
Response samples 
No sample
Get ProviderCredEducation
Gets ProviderCredEducation


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


 
providerCredEducationKey
required
integer <int32> 
ProviderCredEducation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-credentialing/{providerCredKey}/education-records/{providerCredEducationKey}
Request samples 
Response samples 
No sample
Update ProviderCredEducation
Updates a specific ProviderCredEducation.


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


 
providerCredEducationKey
required
integer <int32> 
ProviderCredEducation Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
credEducationType_Key
required
integer <int32> 
Indicates the type of education associated with the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
education_Name
string or null  <= 128 characters 
Name of the educational institution.


 
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.


 
gpa
number or null <double> 
Grade point average of the Provider from the associated institution.


 
graduation_Date
string or null <date-time> 
Date when the Provider graduated from the associated institution.


 
honors
string or null  <= 256 characters 
Identifies any honors that the Provider obtained from the assoicated institution.


 
providerCred_Key
required
integer <int32> 
Associates these custom education 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.


 
start_Date
string or null <date-time> 
Date when the Provider started their education at the associated institution.


 
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}/education-records/{providerCredEducationKey}
Request samples 
{
  • "providerCredEducation_Key": 0,
  • "credEducationType_Key": 0,
  • "education_Name": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "gpa": 0.1,
  • "graduation_Date": "2019-08-24T14:15:22Z",
  • "honors": "string",
  • "providerCred_Key": 0,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCredEducation
Deletes an ProviderCredEducation


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


 
providerCredEducationKey
required
integer <int32> 
ProviderCredEducation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-credentialing/{providerCredKey}/education-records/{providerCredEducationKey}
Request samples 
Create or Update Batch ProviderCredEducation
Create or Update multiple ProviderCredEducation 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 
providerCredEducation_Key
required
integer <int32> 
Unique value for each education record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
credEducationType_Key
required
integer <int32> 
Indicates the type of education associated with the credential. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
education_Name
string or null  <= 128 characters 
Name of the educational institution.


 
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.


 
gpa
number or null <double> 
Grade point average of the Provider from the associated institution.


 
graduation_Date
string or null <date-time> 
Date when the Provider graduated from the associated institution.


 
honors
string or null  <= 256 characters 
Identifies any honors that the Provider obtained from the assoicated institution.


 
providerCred_Key
required
integer <int32> 
Associates these custom education 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.


 
start_Date
string or null <date-time> 
Date when the Provider started their education at the associated institution.


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