Provider Taxonomy

Create ProviderTaxonomy

Creates a new ProviderTaxonomy

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerTaxonomy_Key
required
integer <int32>

Unique identifier for each taxonomy value for this Provider. 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.

provider_ID
required
string [ 1 .. 20 ] characters

Unique idenfitier assigned to the Proivider record.

taxonomy_Code
required
string [ 1 .. 32 ] characters

Taxonomy Code assigned to this Provider.

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/providers/{providerID}/taxonomies
Request samples
{
  • "providerTaxonomy_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "provider_ID": "string",
  • "taxonomy_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderTaxonomy

Lists all ProviderTaxonomy given a specific providerID

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}/taxonomies
Request samples 
Response samples 
No sample
Get ProviderTaxonomy
Gets ProviderTaxonomy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerTaxonomyKey
required
integer <int32> 
ProviderTaxonomy Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/taxonomies/{providerTaxonomyKey}
Request samples 
Response samples 
No sample
Update ProviderTaxonomy
Updates a specific ProviderTaxonomy.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerTaxonomyKey
required
integer <int32> 
ProviderTaxonomy Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerTaxonomy_Key
required
integer <int32> 
Unique identifier for each taxonomy value for this Provider. 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.


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


 
taxonomy_Code
required
string  [ 1 .. 32 ] characters 
Taxonomy Code assigned to this Provider.


 
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/providers/{providerID}/taxonomies/{providerTaxonomyKey}
Request samples 
{
  • "providerTaxonomy_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "provider_ID": "string",
  • "taxonomy_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderTaxonomy
Deletes an ProviderTaxonomy


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
providerTaxonomyKey
required
integer <int32> 
ProviderTaxonomy Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/taxonomies/{providerTaxonomyKey}
Request samples 
Create or Update Batch ProviderTaxonomy
Create or Update multiple ProviderTaxonomy 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 
providerTaxonomy_Key
required
integer <int32> 
Unique identifier for each taxonomy value for this Provider. 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.


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


 
taxonomy_Code
required
string  [ 1 .. 32 ] characters 
Taxonomy Code assigned to this Provider.


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