Provider Credentialing Options

Create ProviderCredOption

Creates a new ProviderCredOption

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 options 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.

credOption_Key
required
integer <int32>

Indicates the type of credentialing option. 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.

option_Result
integer or null <int32>

Indicates the result of the credentialing option.

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}/options
Request samples
{
  • "providerCred_Key": 0,
  • "credOption_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "option_Result": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredOption

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


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


 
credOptionKey
required
integer <int32> 
CredOption Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-credentialing/{providerCredKey}/options/{credOptionKey}
Request samples 
Response samples 
No sample
Update ProviderCredOption
Updates a specific ProviderCredOption.


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


 
credOptionKey
required
integer <int32> 
CredOption Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerCred_Key
required
integer <int32> 
Associates these custom options 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.


 
credOption_Key
required
integer <int32> 
Indicates the type of credentialing option. 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.


 
option_Result
integer or null <int32> 
Indicates the result of the credentialing option.


 
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}/options/{credOptionKey}
Request samples 
{
  • "providerCred_Key": 0,
  • "credOption_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "option_Result": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCredOption
Deletes an ProviderCredOption


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


 
credOptionKey
required
integer <int32> 
CredOption Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-credentialing/{providerCredKey}/options/{credOptionKey}
Request samples 
Create or Update Batch ProviderCredOption
Create or Update multiple ProviderCredOption 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 options 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.


 
credOption_Key
required
integer <int32> 
Indicates the type of credentialing option. 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.


 
option_Result
integer or null <int32> 
Indicates the result of the credentialing option.


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