UC Network

Create UCNetwork

Creates a new UCNetwork

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

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

Group ID that the Usual and Customary Network applies to

division_ID
required
string [ 1 .. 20 ] characters

Division ID that the Usual and Customary Network applies to

plan_ID
required
string [ 1 .. 20 ] characters

Plan ID that the Usual and Customary Network applies to

state
required
string [ 1 .. 2 ] characters

State that the Usual and Customary Network applies to

fee_Sched
required
string [ 1 .. 8 ] characters

Fee Schedule that is used for the Usual and Customary Network

end_Date
string or null <date-time>

Date the Usual and Customary Network terminates

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

start_Date
string or null <date-time>

Date that the Usual and Customary Network becomes effective

update_Date
string <date-time>

Date 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/uc-networks
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "plan_ID": "string",
  • "state": "st",
  • "fee_Sched": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List UCNetwork

Lists all UCNetwork for the given groupID and divisionID and planID and state and feeSched

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
groupID
string

Group ID

divisionID
string

Division ID

planID
string

Plan ID

state
string

State

feeSched
string

Fee Sched

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/uc-networks
Request samples 
Response samples 
No sample
Get UCNetwork
Gets UCNetwork


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planID
required
string
Plan ID


 
state
required
string
State


 
feeSched
required
string
Fee Sched


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/uc-networks/{groupID}/{divisionID}/{planID}/{state}/{feeSched}
Request samples 
Response samples 
No sample
Update UCNetwork
Updates a specific UCNetwork.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planID
required
string
Plan ID


 
state
required
string
State


 
feeSched
required
string
Fee Sched


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
Group ID that the Usual and Customary Network applies to


 
division_ID
required
string  [ 1 .. 20 ] characters 
Division ID that the Usual and Customary Network applies to


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Plan ID that the Usual and Customary Network applies to


 
state
required
string  [ 1 .. 2 ] characters 
State that the Usual and Customary Network applies to


 
fee_Sched
required
string  [ 1 .. 8 ] characters 
Fee Schedule that is used for the Usual and Customary Network


 
end_Date
string or null <date-time> 
Date the Usual and Customary Network terminates


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
start_Date
string or null <date-time> 
Date that the Usual and Customary Network becomes effective


 
update_Date
string <date-time> 
Date 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/uc-networks/{groupID}/{divisionID}/{planID}/{state}/{feeSched}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "plan_ID": "string",
  • "state": "st",
  • "fee_Sched": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete UCNetwork
Deletes an UCNetwork


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
planID
required
string
Plan ID


 
state
required
string
State


 
feeSched
required
string
Fee Sched


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/uc-networks/{groupID}/{divisionID}/{planID}/{state}/{feeSched}
Request samples