Provider Credentialing Dates

Create ProviderCredDate

Creates a new ProviderCredDate

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

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

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

credDate_Key
required
integer <int32>

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

effective_Date
required
string <date-time>

Date when the associated credential becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

term_Date
string or null <date-time>

Date when the associated credential 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}/dates
Request samples
{
  • "providerCred_Key": 0,
  • "credDate_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredDate

Lists all ProviderCredDate 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}/dates
Request samples
Response samples
No sample

Get ProviderCredDate

Gets ProviderCredDate

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

ProviderCred Key

credDateKey
required
integer <int32>

CredDate Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/provider-credentialing/{providerCredKey}/dates/{credDateKey}
Request samples
Response samples
No sample

Update ProviderCredDate

Updates a specific ProviderCredDate.

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

ProviderCred Key

credDateKey
required
integer <int32>

CredDate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

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

credDate_Key
required
integer <int32>

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

effective_Date
required
string <date-time>

Date when the associated credential becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

term_Date
string or null <date-time>

Date when the associated credential 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}/dates/{credDateKey}
Request samples
{
  • "providerCred_Key": 0,
  • "credDate_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ProviderCredDate

Deletes an ProviderCredDate

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

ProviderCred Key

credDateKey
required
integer <int32>

CredDate Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/provider-credentialing/{providerCredKey}/dates/{credDateKey}
Request samples

Create or Update Batch ProviderCredDate

Create or Update multiple ProviderCredDate 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
providerCred_Key
required
integer <int32>

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

credDate_Key
required
integer <int32>

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

effective_Date
required
string <date-time>

Date when the associated credential becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

term_Date
string or null <date-time>

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