Provider Credentialing Practice Offices

Create ProviderCredPracticeOffice

Creates a new ProviderCredPracticeOffice

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

payee_ID
required
string [ 1 .. 20 ] characters

Identifies the Payee ID of the office location.

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.

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

List ProviderCredPracticeOffice

Lists all ProviderCredPracticeOffice 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}/practice-offices
Request samples 
Response samples 
No sample
Get ProviderCredPracticeOffice
Gets ProviderCredPracticeOffice


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


 
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-credentialing/{providerCredKey}/practice-offices/{payeeID}
Request samples 
Response samples 
No sample
Update ProviderCredPracticeOffice
Updates a specific ProviderCredPracticeOffice.


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


 
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
payee_ID
required
string  [ 1 .. 20 ] characters 
Identifies the Payee ID of the office location.


 
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.


 
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}/practice-offices/{payeeID}
Request samples 
{
  • "providerCred_Key": 0,
  • "payee_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderCredPracticeOffice
Deletes an ProviderCredPracticeOffice


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


 
payeeID
required
string
Payee ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-credentialing/{providerCredKey}/practice-offices/{payeeID}
Request samples 
Create or Update Batch ProviderCredPracticeOffice
Create or Update multiple ProviderCredPracticeOffice 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 office 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.


 
payee_ID
required
string  [ 1 .. 20 ] characters 
Identifies the Payee ID of the office location.


 
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.


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