Disaster Locations

Create DisasterLocation

Creates a new DisasterLocation

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
disasterLocation_Key
required
integer <int32>

Unique identifer for each disaster location entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.

county_Code
string or null <= 8 characters

County Code associated with the disaster.

disaster_Key
integer or null <int32>

Unique identifer for each disaster entry, references Disaster.Disaster_Key .

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 associated with the disaster.

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

zip_Code
string or null <= 32 characters

US Zip Code associated with the disaster.

Responses
200

Success

401

Unauthorized

post/disaster-locations
Request samples
{
  • "disasterLocation_Key": 0,
  • "county_Code": "string",
  • "disaster_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DisasterLocation

Lists all DisasterLocation

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/disaster-locations
Request samples 
Response samples 
No sample
Get DisasterLocation
Gets DisasterLocation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisasterLocation_Key
required
integer <int32> 
DisasterLocation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/disaster-locations/{DisasterLocation_Key}
Request samples 
Response samples 
No sample
Update DisasterLocation
Updates a specific DisasterLocation.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisasterLocation_Key
required
integer <int32> 
DisasterLocation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
disasterLocation_Key
required
integer <int32> 
Unique identifer for each disaster location entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
county_Code
string or null  <= 8 characters 
County Code associated with the disaster.


 
disaster_Key
integer or null <int32> 
Unique identifer for each disaster entry, references Disaster.Disaster_Key .


 
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 associated with the disaster.


 
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


 
zip_Code
string or null  <= 32 characters 
US Zip Code associated with the disaster.


 
Responses 
200
Success


401
Unauthorized


put/disaster-locations/{DisasterLocation_Key}
Request samples 
{
  • "disasterLocation_Key": 0,
  • "county_Code": "string",
  • "disaster_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DisasterLocation
Deletes an DisasterLocation


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisasterLocation_Key
required
integer <int32> 
DisasterLocation Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/disaster-locations/{DisasterLocation_Key}
Request samples 
Create or Update Batch DisasterLocation
Create or Update multiple DisasterLocation 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 
disasterLocation_Key
required
integer <int32> 
Unique identifer for each disaster location entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
county_Code
string or null  <= 8 characters 
County Code associated with the disaster.


 
disaster_Key
integer or null <int32> 
Unique identifer for each disaster entry, references Disaster.Disaster_Key .


 
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 associated with the disaster.


 
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


 
zip_Code
string or null  <= 32 characters 
US Zip Code associated with the disaster.


 
Responses 
207
Success


401
Unauthorized


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