Provider Network Modifier

Create ProviderNetworkModifier

Creates a new ProviderNetworkModifier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

networkID
required
string

Network ID

modifier
required
string

Modifier

header Parameters
vbasoftware-database
required
string

Target database

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

Identifier of the Proivider record.

network_ID
required
string [ 1 .. 50 ] characters

Indicates which Network the options will be associated with.

modifier
required
string [ 1 .. 8 ] characters

This is the modifier assigned to this configuration. When blank it indicates all modifiers.

effective_Date
required
string <date-time>

Date when the associated modifier 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.

fee_Percent
number or null <double>

Fee percentage that will be applied with the modifier. Negative values may be used to apply discounts.

term_Date
string or null <date-time>

Date when the associated modifier 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}/networks/{networkID}/modifiers/{modifier}
Request samples
{
  • "provider_ID": "string",
  • "network_ID": "string",
  • "modifier": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderNetworkModifier

Lists all ProviderNetworkModifier for the given Provider ID, and Network ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

networkID
required
string

Network ID

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/providers/{providerID}/networks/{networkID}/modifiers
Request samples 
Response samples 
No sample
List ProviderNetworkModifier for a given provider id
Lists all ProviderNetworkModifier for the given Provider ID. This will include all assigned Networks.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
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/providers/{providerID}/network-modifiers
Request samples 
Response samples 
No sample
Get ProviderNetworkModifier
Gets ProviderNetworkModifier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
networkID
required
string
Network ID


 
modifier
required
string
Modifier


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/networks/{networkID}/modifiers/{modifier}/effective-date/{effectiveDate}
Request samples 
Response samples 
No sample
Update ProviderNetworkModifier
Updates a specific ProviderNetworkModifier.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
networkID
required
string
Network ID


 
modifier
required
string
Modifier


 
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 
Identifier of the Proivider record.


 
network_ID
required
string  [ 1 .. 50 ] characters 
Indicates which Network the options will be associated with.


 
modifier
required
string  [ 1 .. 8 ] characters 
This is the modifier assigned to this configuration. When blank it indicates all modifiers.


 
effective_Date
required
string <date-time> 
Date when the associated modifier 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.


 
fee_Percent
number or null <double> 
Fee percentage that will be applied with the modifier. Negative values may be used to apply discounts.


 
term_Date
string or null <date-time> 
Date when the associated modifier 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}/networks/{networkID}/modifiers/{modifier}/effective-date/{effectiveDate}
Request samples 
{
  • "provider_ID": "string",
  • "network_ID": "string",
  • "modifier": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fee_Percent": 0.1,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderNetworkModifier
Deletes an ProviderNetworkModifier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
networkID
required
string
Network ID


 
modifier
required
string
Modifier


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/networks/{networkID}/modifiers/{modifier}/effective-date/{effectiveDate}
Request samples 
Create or Update Batch ProviderNetworkModifier
Create or Update multiple ProviderNetworkModifier 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


 
networkID
required
string
Network ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
provider_ID
required
string  [ 1 .. 20 ] characters 
Identifier of the Proivider record.


 
network_ID
required
string  [ 1 .. 50 ] characters 
Indicates which Network the options will be associated with.


 
modifier
required
string  [ 1 .. 8 ] characters 
This is the modifier assigned to this configuration. When blank it indicates all modifiers.


 
effective_Date
required
string <date-time> 
Date when the associated modifier 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.


 
fee_Percent
number or null <double> 
Fee percentage that will be applied with the modifier. Negative values may be used to apply discounts.


 
term_Date
string or null <date-time> 
Date when the associated modifier 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}/networks/{networkID}/modifiers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}