Network Modifiers

Create NetworkModifier

Creates a new NetworkModifier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
networkID
required
string

Network ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
network_ID
required
string [ 1 .. 50 ] characters
modifier
required
string [ 1 .. 8 ] characters
effective_Date
required
string <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
fee_Percent
number or null <double>
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/networks/{networkID}/modifiers
Request samples
{
  • "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 NetworkModifier

Lists all NetworkModifier for the given networkID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
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/networks/{networkID}/modifiers
Request samples
Response samples
No sample

Get NetworkModifier

Gets NetworkModifier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
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/networks/{networkID}/modifiers/{modifier}/{effectiveDate}
Request samples
Response samples
No sample

Update NetworkModifier

Updates a specific NetworkModifier.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
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
network_ID
required
string [ 1 .. 50 ] characters
modifier
required
string [ 1 .. 8 ] characters
effective_Date
required
string <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
fee_Percent
number or null <double>
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/networks/{networkID}/modifiers/{modifier}/{effectiveDate}
Request samples
{
  • "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 NetworkModifier

Deletes an NetworkModifier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
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/networks/{networkID}/modifiers/{modifier}/{effectiveDate}
Request samples

Create or Update Batch NetworkModifier

Create or Update multiple NetworkModifier 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
networkID
required
string

Network ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
network_ID
required
string [ 1 .. 50 ] characters
modifier
required
string [ 1 .. 8 ] characters
effective_Date
required
string <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
fee_Percent
number or null <double>
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/networks/{networkID}/modifiers-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}