Disasters

Create Disaster

Creates a new Disaster

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
disaster_Key
required
integer <int32>

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

description
string or null <= 256 characters

The description of the Disaster.

disaster_ID
string or null <= 20 characters

User defined identifier for the Disaster

effective_Date
string or null <date-time>

Date when the disaster becomes/became effective.

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

ex_Code
string or null <= 6 characters

The ExCode applied to this disaster entry.

term_Date
string or null <date-time>

Date when the disaster no longe applies.

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/disasters
Request samples
{
  • "disaster_Key": 0,
  • "description": "string",
  • "disaster_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Disaster

Lists all Disaster

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/disasters
Request samples 
Response samples 
No sample
Get Disaster
Gets Disaster


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Disaster_Key
required
integer <int32> 
Disaster Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/disasters/{Disaster_Key}
Request samples 
Response samples 
No sample
Update Disaster
Updates a specific Disaster.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Disaster_Key
required
integer <int32> 
Disaster Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
description
string or null  <= 256 characters 
The description of the Disaster.


 
disaster_ID
string or null  <= 20 characters 
User defined identifier for the Disaster


 
effective_Date
string or null <date-time> 
Date when the disaster becomes/became effective.


 
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


 
ex_Code
string or null  <= 6 characters 
The ExCode applied to this disaster entry.


 
term_Date
string or null <date-time> 
Date when the disaster no longe applies.


 
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/disasters/{Disaster_Key}
Request samples 
{
  • "disaster_Key": 0,
  • "description": "string",
  • "disaster_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Disaster
Deletes an Disaster


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
Disaster_Key
required
integer <int32> 
Disaster Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


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


 
description
string or null  <= 256 characters 
The description of the Disaster.


 
disaster_ID
string or null  <= 20 characters 
User defined identifier for the Disaster


 
effective_Date
string or null <date-time> 
Date when the disaster becomes/became effective.


 
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


 
ex_Code
string or null  <= 6 characters 
The ExCode applied to this disaster entry.


 
term_Date
string or null <date-time> 
Date when the disaster no longe applies.


 
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/disasters-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}