logo
API docs by Redocly

DMQT API (1.0.0)

Download OpenAPI specification:Download

DMQT API

DMQT is a data and models query tool the development of which will provide emergency management agencies and communities with the ability to search, discover, and reuse any of the models that are developed as a part of the RBFS effort.

Search

Search By Location

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "pageinfo": {
    },
  • "metadata": [
    ]
}

Search By Ai

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "pageinfo": {
    },
  • "metadata": [
    ],
  • "tabular_data": [
    ]
}

Search By Keyword

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "pageinfo": {
    },
  • "metadata": [
    ]
}

Search By Event

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "pageinfo": {
    },
  • "metadata": [
    ]
}

Search By Location Csv

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
null

Search By Keyword Csv

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
null

Search By Ai Csv

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
null

Search By Event Csv

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
null

Download All Search Results Csv

Authorizations:
BearerAuth
Request Body schema: application/json
required
Page (integer) or Page (null) (Page)
Default: 1

The page number, starting at 1

Size (integer) or Size (null) (Size)
Default: 10

The number of items per page, maximum 100

Count (integer) or Count (null) (Count)
required
Query (string) or Query (object) (Query)

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "size": 10,
  • "count": 0,
  • "query": "string"
}

Response samples

Content type
null

Info

Get Model Info

Get spatial information by tdis identifier.

Authorizations:
BearerAuth
path Parameters
tdis_id
required
string (Tdis Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Simulation Info

Authorizations:
BearerAuth
path Parameters
tdis_id
required
string (Tdis Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get File Listing

Authorizations:
BearerAuth
path Parameters
guuid
required
string (Guuid)

Responses

Response samples

Content type
application/json
{
  • "ms2": {
    }
}

Datasets

Search Files

Authorizations:
BearerAuth
Request Body schema: application/json
required
Search (string) or Search (null) (Search)
Type (string) or Type (null) (Type)
Parent Path (string) or Parent Path (null) (Parent Path)
Min Size (integer) or Min Size (null) (Min Size)
Max Size (integer) or Max Size (null) (Max Size)
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)
Sort By (string) or Sort By (null) (Sort By)
Default: "type,name"
Sort Direction (string) or Sort Direction (null) (Sort Direction)
Default: "desc,asc"
offset
integer (Offset) <= 1000
Default: 0

The page number, starting at 1

limit
integer (Limit)
Default: 50

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "type": "string",
  • "parent_path": "string",
  • "min_size": 0,
  • "max_size": 0,
  • "start_date": "string",
  • "end_date": "string",
  • "sort_by": "type,name",
  • "sort_direction": "desc,asc",
  • "offset": 0,
  • "limit": 50
}

Response samples

Content type
application/json
[
  • {
    }
]

Counties

Get County Counts

Responses

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ]
}

Get County Models

Responses

Response samples

Content type
application/json
[ ]

Models

Get Region Models

Get all models for a region as GeoJSON FeatureCollection.

Authorizations:
BearerAuth
path Parameters
region_id
required
string (Region Id)

Responses

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    ]
}

Feedback

Submit Feedback

Request Body schema: application/json
required
email
required
string <email> (Email)
required
Array of objects (Qa Pairs)
browser
required
string (Browser)
url
required
string (Url)
name
required
string (Name)
Message (string) or Message (null) (Message)

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "qa_pairs": [
    ],
  • "browser": "string",
  • "url": "string",
  • "name": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Admin

Get User Count

Get total user count from Keycloak.

Responses

Response samples

Content type
application/json
{
  • "user_count": 0
}

Health

Endpoint

Responses

Response samples

Content type
application/json
null

Endpoint

Responses

Response samples

Content type
application/json
null