Insurance Carriers

Create InsuranceCarrier

Creates a new InsuranceCarrier

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
carrier_Key
required
integer <int32>
address
string or null <= 255 characters
address2
string or null <= 128 characters
coB_Carrier
string or null <= 1 characters
carrier_ID
required
string [ 1 .. 16 ] characters
carrier_Type
string or null <= 6 characters
city
string or null <= 64 characters
contact_Fax
string or null <= 32 characters
contact_Fax_Country_Code
string or null <= 8 characters
contact_Name
string or null <= 64 characters
contact_Phone
string or null <= 32 characters
contact_Phone_Country_Code
string or null <= 8 characters
country_ID
string or null <= 8 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
fax
string or null <= 32 characters
fax_Country_Code
string or null <= 8 characters
malpractice
string or null <= 1 characters
medicare
boolean or null
name
string or null <= 64 characters
over_Spec_Advance_Fund
number or null <double>
phone
string or null <= 32 characters
phone_Country_Code
string or null <= 8 characters
reinsurance
string or null <= 1 characters
state
string or null <= 32 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
zip
string or null <= 32 characters
Responses
200

Success

401

Unauthorized

post/insurance-carriers
Request samples
{
  • "carrier_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "coB_Carrier": "s",
  • "carrier_ID": "string",
  • "carrier_Type": "string",
  • "city": "string",
  • "contact_Fax": "string",
  • "contact_Fax_Country_Code": "string",
  • "contact_Name": "string",
  • "contact_Phone": "string",
  • "contact_Phone_Country_Code": "string",
  • "country_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "malpractice": "s",
  • "medicare": true,
  • "name": "string",
  • "over_Spec_Advance_Fund": 0.1,
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "reinsurance": "s",
  • "state": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List InsuranceCarrier

Lists all InsuranceCarrier

SecurityapiKeyAuth and bearerAuth
Request
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/insurance-carriers
Request samples 
Response samples 
No sample
Get InsuranceCarrier
Gets InsuranceCarrier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carrierKey
required
integer <int32> 
Carrier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/insurance-carriers/{carrierKey}
Request samples 
Response samples 
No sample
Update InsuranceCarrier
Updates a specific InsuranceCarrier.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carrierKey
required
integer <int32> 
Carrier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
carrier_Key
required
integer <int32> 
 
address
string or null  <= 255 characters 
 
address2
string or null  <= 128 characters 
 
coB_Carrier
string or null  <= 1 characters 
 
carrier_ID
required
string  [ 1 .. 16 ] characters 
 
carrier_Type
string or null  <= 6 characters 
 
city
string or null  <= 64 characters 
 
contact_Fax
string or null  <= 32 characters 
 
contact_Fax_Country_Code
string or null  <= 8 characters 
 
contact_Name
string or null  <= 64 characters 
 
contact_Phone
string or null  <= 32 characters 
 
contact_Phone_Country_Code
string or null  <= 8 characters 
 
country_ID
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
fax
string or null  <= 32 characters 
 
fax_Country_Code
string or null  <= 8 characters 
 
malpractice
string or null  <= 1 characters 
 
medicare
boolean or null
 
name
string or null  <= 64 characters 
 
over_Spec_Advance_Fund
number or null <double> 
 
phone
string or null  <= 32 characters 
 
phone_Country_Code
string or null  <= 8 characters 
 
reinsurance
string or null  <= 1 characters 
 
state
string or null  <= 32 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip
string or null  <= 32 characters 
 
Responses 
200
Success


401
Unauthorized


put/insurance-carriers/{carrierKey}
Request samples 
{
  • "carrier_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "coB_Carrier": "s",
  • "carrier_ID": "string",
  • "carrier_Type": "string",
  • "city": "string",
  • "contact_Fax": "string",
  • "contact_Fax_Country_Code": "string",
  • "contact_Name": "string",
  • "contact_Phone": "string",
  • "contact_Phone_Country_Code": "string",
  • "country_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "malpractice": "s",
  • "medicare": true,
  • "name": "string",
  • "over_Spec_Advance_Fund": 0.1,
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "reinsurance": "s",
  • "state": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete InsuranceCarrier
Deletes an InsuranceCarrier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
carrierKey
required
integer <int32> 
Carrier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/insurance-carriers/{carrierKey}
Request samples 
Create or Update Batch InsuranceCarrier
Create or Update multiple InsuranceCarrier at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
carrier_Key
required
integer <int32> 
 
address
string or null  <= 255 characters 
 
address2
string or null  <= 128 characters 
 
coB_Carrier
string or null  <= 1 characters 
 
carrier_ID
required
string  [ 1 .. 16 ] characters 
 
carrier_Type
string or null  <= 6 characters 
 
city
string or null  <= 64 characters 
 
contact_Fax
string or null  <= 32 characters 
 
contact_Fax_Country_Code
string or null  <= 8 characters 
 
contact_Name
string or null  <= 64 characters 
 
contact_Phone
string or null  <= 32 characters 
 
contact_Phone_Country_Code
string or null  <= 8 characters 
 
country_ID
string or null  <= 8 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
fax
string or null  <= 32 characters 
 
fax_Country_Code
string or null  <= 8 characters 
 
malpractice
string or null  <= 1 characters 
 
medicare
boolean or null
 
name
string or null  <= 64 characters 
 
over_Spec_Advance_Fund
number or null <double> 
 
phone
string or null  <= 32 characters 
 
phone_Country_Code
string or null  <= 8 characters 
 
reinsurance
string or null  <= 1 characters 
 
state
string or null  <= 32 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip
string or null  <= 32 characters 
 
Responses 
207
Success


401
Unauthorized


put/insurance-carriers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}