Provider Affiliation

Create ProviderAffiliation

Creates a new ProviderAffiliation

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

affiliation_Provider_ID
required
string [ 1 .. 20 ] characters

Identifier of the Affiliate Provider.

effective_Date
required
string <date-time>

Date when the Affiliate Provider status 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>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

term_Date
string or null <date-time>

Date when the Affiliate Provider status expires/expired.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

Responses
200

Success

401

Unauthorized

post/providers/{providerID}/affiliations
Request samples
{
  • "provider_ID": "string",
  • "affiliation_Provider_ID": "string",
  • "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 ProviderAffiliation

Gets all ProviderAffiliations for a specific Provider

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/providers/{providerID}/affiliations
Request samples 
Response samples 
No sample
Get ProviderAffiliation
Gets ProviderAffiliation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
affiliationProviderID
required
string
Affiliation Provider ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/affiliations/{affiliationProviderID}/effective-dates/{effectiveDate}
Request samples 
Response samples 
No sample
Update ProviderAffiliation
Updates a specific ProviderAffiliation.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
affiliationProviderID
required
string
Affiliation Provider ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
affiliation_Provider_ID
required
string  [ 1 .. 20 ] characters 
Identifier of the Affiliate Provider.


 
effective_Date
required
string <date-time> 
Date when the Affiliate Provider status 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> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
200
Success


401
Unauthorized


put/providers/{providerID}/affiliations/{affiliationProviderID}/effective-dates/{effectiveDate}
Request samples 
{
  • "provider_ID": "string",
  • "affiliation_Provider_ID": "string",
  • "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 ProviderAffiliation
Deletes an ProviderAffiliation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
affiliationProviderID
required
string
Affiliation Provider ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/affiliations/{affiliationProviderID}/effective-dates/{effectiveDate}
Request samples 
Create or Update Batch ProviderAffiliation
Create or Update multiple ProviderAffiliation 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
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
provider_ID
required
string  [ 1 .. 20 ] characters 
Unique idenfitier assigned to the Proivider record.


 
affiliation_Provider_ID
required
string  [ 1 .. 20 ] characters 
Identifier of the Affiliate Provider.


 
effective_Date
required
string <date-time> 
Date when the Affiliate Provider status 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> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
Responses 
207
Success


401
Unauthorized


put/providers/{providerID}/affiliations-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}