Provider Suffix

Create ProviderSuffix

Creates a new ProviderSuffix

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.

suffix
required
string [ 1 .. 16 ] characters

Suffix associated with the Provider.

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/providers/{providerID}/suffixes
Request samples
{
  • "provider_ID": "string",
  • "suffix": "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 ProviderSuffix

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
suffix
required
string
Suffix


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/suffixes/{suffix}
Request samples 
Response samples 
No sample
Update ProviderSuffix
Updates a specific ProviderSuffix.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
suffix
required
string
Suffix


 
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.


 
suffix
required
string  [ 1 .. 16 ] characters 
Suffix associated with the Provider.


 
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/providers/{providerID}/suffixes/{suffix}
Request samples 
{
  • "provider_ID": "string",
  • "suffix": "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 ProviderSuffix
Deletes an ProviderSuffix


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
suffix
required
string
Suffix


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/suffixes/{suffix}
Request samples 
Create or Update Batch ProviderSuffix
Create or Update multiple ProviderSuffix 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.


 
suffix
required
string  [ 1 .. 16 ] characters 
Suffix associated with the Provider.


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