Group Network Add-Ons

Create GroupNetworkAddOn

Creates a new GroupNetworkAddOn

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

networkID
required
string

NetworkID

state
required
string

State

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupNetworkAddOn_Key
required
integer <int32>

Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 512 characters

Used in custom client processing with no functional impact on existing processing.

discount_Payment
number or null <double>

Used in custom client processing with no functional impact on existing processing.

discount_Payment_Pct
required
boolean

Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

discount_Threshold
number or null <double>

Used in custom client processing with no functional impact on existing processing.

discount_Threshold_Pct
required
boolean

Used in custom client processing with no functional impact on existing processing. 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.

group_ID
required
string [ 1 .. 20 ] characters

Used in custom client processing with no functional impact on existing processing.

incurred_From
required
string <date-time>

Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

incurred_Thru
string or null <date-time>

Used in custom client processing with no functional impact on existing processing.

member_Seq
string or null <= 2 characters

Used in custom client processing with no functional impact on existing processing.

network_ID
required
string [ 1 .. 20 ] characters

Used in custom client processing with no functional impact on existing processing.

paid_From
string or null <date-time>

Used in custom client processing with no functional impact on existing processing.

paid_Thru
string or null <date-time>

Used in custom client processing with no functional impact on existing processing.

payment_Limit
number or null <double>

Used in custom client processing with no functional impact on existing processing.

payment_Limit_Type
string or null <= 32 characters

Used in custom client processing with no functional impact on existing processing.

provider_ID
string or null <= 20 characters

Used in custom client processing with no functional impact on existing processing.

subscriber_ID
string or null <= 9 characters

Used in custom client processing with no functional impact on existing processing.

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/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons
Request samples
{
  • "groupNetworkAddOn_Key": 0,
  • "description": "string",
  • "discount_Payment": 0.1,
  • "discount_Payment_Pct": true,
  • "discount_Threshold": 0.1,
  • "discount_Threshold_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "incurred_From": "2019-08-24T14:15:22Z",
  • "incurred_Thru": "2019-08-24T14:15:22Z",
  • "member_Seq": "st",
  • "network_ID": "string",
  • "paid_From": "2019-08-24T14:15:22Z",
  • "paid_Thru": "2019-08-24T14:15:22Z",
  • "payment_Limit": 0.1,
  • "payment_Limit_Type": "string",
  • "provider_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupNetworkAddOn

Lists all GroupNetworkAddOn for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

networkID
required
string

NetworkID

state
required
string

State

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/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons
Request samples 
Response samples 
No sample
Get GroupNetworkAddOn
Gets GroupNetworkAddOn


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
networkID
required
string
NetworkID


 
state
required
string
State


 
groupNetworkAddOnKey
required
integer <int32> 
GroupNetworkAddOn Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons/{groupNetworkAddOnKey}
Request samples 
Response samples 
No sample
Update GroupNetworkAddOn
Updates a specific GroupNetworkAddOn.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
networkID
required
string
NetworkID


 
state
required
string
State


 
groupNetworkAddOnKey
required
integer <int32> 
GroupNetworkAddOn Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupNetworkAddOn_Key
required
integer <int32> 
Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 512 characters 
Used in custom client processing with no functional impact on existing processing.


 
discount_Payment
number or null <double> 
Used in custom client processing with no functional impact on existing processing.


 
discount_Payment_Pct
required
boolean
Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
discount_Threshold
number or null <double> 
Used in custom client processing with no functional impact on existing processing.


 
discount_Threshold_Pct
required
boolean
Used in custom client processing with no functional impact on existing processing. 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.


 
group_ID
required
string  [ 1 .. 20 ] characters 
Used in custom client processing with no functional impact on existing processing.


 
incurred_From
required
string <date-time> 
Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
incurred_Thru
string or null <date-time> 
Used in custom client processing with no functional impact on existing processing.


 
member_Seq
string or null  <= 2 characters 
Used in custom client processing with no functional impact on existing processing.


 
network_ID
required
string  [ 1 .. 20 ] characters 
Used in custom client processing with no functional impact on existing processing.


 
paid_From
string or null <date-time> 
Used in custom client processing with no functional impact on existing processing.


 
paid_Thru
string or null <date-time> 
Used in custom client processing with no functional impact on existing processing.


 
payment_Limit
number or null <double> 
Used in custom client processing with no functional impact on existing processing.


 
payment_Limit_Type
string or null  <= 32 characters 
Used in custom client processing with no functional impact on existing processing.


 
provider_ID
string or null  <= 20 characters 
Used in custom client processing with no functional impact on existing processing.


 
subscriber_ID
string or null  <= 9 characters 
Used in custom client processing with no functional impact on existing processing.


 
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/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons/{groupNetworkAddOnKey}
Request samples 
{
  • "groupNetworkAddOn_Key": 0,
  • "description": "string",
  • "discount_Payment": 0.1,
  • "discount_Payment_Pct": true,
  • "discount_Threshold": 0.1,
  • "discount_Threshold_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "incurred_From": "2019-08-24T14:15:22Z",
  • "incurred_Thru": "2019-08-24T14:15:22Z",
  • "member_Seq": "st",
  • "network_ID": "string",
  • "paid_From": "2019-08-24T14:15:22Z",
  • "paid_Thru": "2019-08-24T14:15:22Z",
  • "payment_Limit": 0.1,
  • "payment_Limit_Type": "string",
  • "provider_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupNetworkAddOn
Deletes an GroupNetworkAddOn


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
networkID
required
string
NetworkID


 
state
required
string
State


 
groupNetworkAddOnKey
required
integer <int32> 
GroupNetworkAddOn Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons/{groupNetworkAddOnKey}
Request samples 
Create or Update Batch GroupNetworkAddOn
Create or Update multiple GroupNetworkAddOn 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
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
networkID
required
string
NetworkID


 
state
required
string
State


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupNetworkAddOn_Key
required
integer <int32> 
Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 512 characters 
Used in custom client processing with no functional impact on existing processing.


 
discount_Payment
number or null <double> 
Used in custom client processing with no functional impact on existing processing.


 
discount_Payment_Pct
required
boolean
Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
discount_Threshold
number or null <double> 
Used in custom client processing with no functional impact on existing processing.


 
discount_Threshold_Pct
required
boolean
Used in custom client processing with no functional impact on existing processing. 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.


 
group_ID
required
string  [ 1 .. 20 ] characters 
Used in custom client processing with no functional impact on existing processing.


 
incurred_From
required
string <date-time> 
Used in custom client processing with no functional impact on existing processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
incurred_Thru
string or null <date-time> 
Used in custom client processing with no functional impact on existing processing.


 
member_Seq
string or null  <= 2 characters 
Used in custom client processing with no functional impact on existing processing.


 
network_ID
required
string  [ 1 .. 20 ] characters 
Used in custom client processing with no functional impact on existing processing.


 
paid_From
string or null <date-time> 
Used in custom client processing with no functional impact on existing processing.


 
paid_Thru
string or null <date-time> 
Used in custom client processing with no functional impact on existing processing.


 
payment_Limit
number or null <double> 
Used in custom client processing with no functional impact on existing processing.


 
payment_Limit_Type
string or null  <= 32 characters 
Used in custom client processing with no functional impact on existing processing.


 
provider_ID
string or null  <= 20 characters 
Used in custom client processing with no functional impact on existing processing.


 
subscriber_ID
string or null  <= 9 characters 
Used in custom client processing with no functional impact on existing processing.


 
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/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/networks/{networkID}/{state}/add-ons-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}