Premium Rate Zipcodes

Create PremRateZip

Creates a new PremRateZip

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRateZip_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
premRate_Key
required
integer <int32>
update_Date
string <date-time>
update_User
string or null <= 20 characters
zip_From
required
string [ 1 .. 16 ] characters
zip_Thru
required
string [ 1 .. 16 ] characters
Responses
200

Success

401

Unauthorized

post/premium-rates/{premRateKey}/zipcodes
Request samples
{
  • "premRateZip_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "premRate_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_From": "string",
  • "zip_Thru": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremRateZip

Lists all PremRateZip for the given premRateKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
premRateKey
required
integer <int32>

PremRate Key

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/premium-rates/{premRateKey}/zipcodes
Request samples 
Response samples 
No sample
Get PremRateZip
Gets PremRateZip


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
premRateZipKey
required
integer <int32> 
PremRateZip Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-rates/{premRateKey}/zipcodes/{premRateZipKey}
Request samples 
Response samples 
No sample
Update PremRateZip
Updates a specific PremRateZip.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
premRateZipKey
required
integer <int32> 
PremRateZip Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premRateZip_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
premRate_Key
required
integer <int32> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip_From
required
string  [ 1 .. 16 ] characters 
 
zip_Thru
required
string  [ 1 .. 16 ] characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-rates/{premRateKey}/zipcodes/{premRateZipKey}
Request samples 
{
  • "premRateZip_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "premRate_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_From": "string",
  • "zip_Thru": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremRateZip
Deletes an PremRateZip


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
premRateZipKey
required
integer <int32> 
PremRateZip Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-rates/{premRateKey}/zipcodes/{premRateZipKey}
Request samples 
Create or Update Batch PremRateZip
Create or Update multiple PremRateZip 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
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
premRateZip_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
premRate_Key
required
integer <int32> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
zip_From
required
string  [ 1 .. 16 ] characters 
 
zip_Thru
required
string  [ 1 .. 16 ] characters 
 
Responses 
207
Success


401
Unauthorized


put/premium-rates/{premRateKey}/zipcodes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}