Provider Credentialing Licenses

Create ProviderCredLicense

Creates a new ProviderCredLicense

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

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCredLicense_Key
required
integer <int32>

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

credLicenseType_Key
integer or null <int32>

Indicates the type of license associated with the credential.

effective_Date
string or null <date-time>

Date when the license becomes/became effective.

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.

license_Name
string or null <= 512 characters

Name of the assoicated license.

license_Number
string or null <= 50 characters

License number of the associated license.

psV_Date
string or null <date-time>

Primary Source Verification date.

providerCred_Key
required
integer <int32>

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

specialty_Code
string or null <= 10 characters

Specialty associated with the license.

state
string or null <= 2 characters

State in which the associated license is effective.

term_Date
string or null <date-time>

Date when the license expires/expired.

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/provider-credentialing/{providerCredKey}/licenses
Request samples
{
  • "providerCredLicense_Key": 0,
  • "credLicenseType_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "license_Name": "string",
  • "license_Number": "string",
  • "psV_Date": "2019-08-24T14:15:22Z",
  • "providerCred_Key": 0,
  • "specialty_Code": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredLicense

Lists all ProviderCredLicense 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}/licenses
Request samples 
Response samples 
No sample
Get ProviderCredLicense
Gets ProviderCredLicense


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


 
providerCredLicenseKey
required
integer <int32> 
ProviderCredLicense Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-credentialing/{providerCredKey}/licenses/{providerCredLicenseKey}
Request samples 
Response samples 
No sample
Update ProviderCredLicense
Updates a specific ProviderCredLicense.


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


 
providerCredLicenseKey
required
integer <int32> 
ProviderCredLicense Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
credLicenseType_Key
integer or null <int32> 
Indicates the type of license associated with the credential.


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


 
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.


 
license_Name
string or null  <= 512 characters 
Name of the assoicated license.


 
license_Number
string or null  <= 50 characters 
License number of the associated license.


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


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


 
specialty_Code
string or null  <= 10 characters 
Specialty associated with the license.


 
state
string or null  <= 2 characters 
State in which the associated license is effective.


 
term_Date
string or null <date-time> 
Date when the license expires/expired.


 
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/provider-credentialing/{providerCredKey}/licenses/{providerCredLicenseKey}
Request samples 
{
  • "providerCredLicense_Key": 0,
  • "credLicenseType_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "license_Name": "string",
  • "license_Number": "string",
  • "psV_Date": "2019-08-24T14:15:22Z",
  • "providerCred_Key": 0,
  • "specialty_Code": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCredLicense
Deletes an ProviderCredLicense


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


 
providerCredLicenseKey
required
integer <int32> 
ProviderCredLicense Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-credentialing/{providerCredKey}/licenses/{providerCredLicenseKey}
Request samples 
Create or Update Batch ProviderCredLicense
Create or Update multiple ProviderCredLicense 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 
providerCredLicense_Key
required
integer <int32> 
Unique identifier for each license record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
credLicenseType_Key
integer or null <int32> 
Indicates the type of license associated with the credential.


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


 
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.


 
license_Name
string or null  <= 512 characters 
Name of the assoicated license.


 
license_Number
string or null  <= 50 characters 
License number of the associated license.


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


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


 
specialty_Code
string or null  <= 10 characters 
Specialty associated with the license.


 
state
string or null  <= 2 characters 
State in which the associated license is effective.


 
term_Date
string or null <date-time> 
Date when the license expires/expired.


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