ZipCodes

Create ZipCodes

Creates a new ZipCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
zip_Code
required
string [ 1 .. 32 ] characters

Zip Code as specified by the US Postal Service

city
string or null <= 64 characters

City where the Zip Code is located

country_ID
string or null <= 8 characters

Country ID as specified by the US Postal Service

county
string or null <= 64 characters

County where the Zip Code is located

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

state
string or null <= 2 characters

State where the Zip Code is located

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/zip-codes
Request samples
{
  • "zip_Code": "string",
  • "city": "string",
  • "country_ID": "string",
  • "county": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ZipCodes

Lists all ZipCodes

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/zip-codes
Request samples 
Response samples 
No sample
Get ZipCodes
Gets ZipCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
zipCode
required
string
Zip Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/zip-codes/{zipCode}
Request samples 
Response samples 
No sample
Update ZipCodes
Updates a specific ZipCodes.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
zipCode
required
string
Zip Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
zip_Code
required
string  [ 1 .. 32 ] characters 
Zip Code as specified by the US Postal Service


 
city
string or null  <= 64 characters 
City where the Zip Code is located


 
country_ID
string or null  <= 8 characters 
Country ID as specified by the US Postal Service


 
county
string or null  <= 64 characters 
County where the Zip Code is located


 
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


 
state
string or null  <= 2 characters 
State where the Zip Code is located


 
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/zip-codes/{zipCode}
Request samples 
{
  • "zip_Code": "string",
  • "city": "string",
  • "country_ID": "string",
  • "county": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ZipCodes
Deletes an ZipCodes


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
zipCode
required
string
Zip Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/zip-codes/{zipCode}
Request samples 
Create or Update Batch ZipCodes
Create or Update multiple ZipCodes 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 
zip_Code
required
string  [ 1 .. 32 ] characters 
Zip Code as specified by the US Postal Service


 
city
string or null  <= 64 characters 
City where the Zip Code is located


 
country_ID
string or null  <= 8 characters 
Country ID as specified by the US Postal Service


 
county
string or null  <= 64 characters 
County where the Zip Code is located


 
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


 
state
string or null  <= 2 characters 
State where the Zip Code is located


 
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 
207
Success


401
Unauthorized


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