Skip to content

Create ProviderCredLicense

Request

Creates a new ProviderCredLicense

Security
apiKeyAuth and bearerAuth
Path
providerCredKeyinteger, (int32)required

ProviderCred Key

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
providerCredLicense_Keyinteger, (int32)required

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

credLicenseType_Keyinteger or null, (int32)

Indicates the type of license associated with the credential.

effective_Datestring or null, (date-time)

Date when the license becomes/became effective.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

license_Namestring or null, <= 512 characters

Name of the assoicated license.

license_Numberstring or null, <= 50 characters

License number of the associated license.

psV_Datestring or null, (date-time)

Primary Source Verification date.

providerCred_Keyinteger, (int32)required

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_Codestring or null, <= 10 characters

Specialty associated with the license.

statestring or null, <= 2 characters

State in which the associated license is effective.

term_Datestring or null, (date-time)

Date when the license expires/expired.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/provider-credentialing/{providerCredKey}/licenses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}