MS2 Public API (1.0.0)

Download OpenAPI specification:Download

MS2 Public API

API for external partners to maintain metadata about the models, such as when it was created, the model type, and other key pieces of information for the archive.

Authentication

API to get auth token.

Authentication

Get authorization access token.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

Content type

application/json

{"id": 0,
"username": "string",
"roles": ["ROLE_ADMIN-OPERATIONAL"
],
"expirationTime": 0,
"accessToken": "string"
}

External Partners

APIs to manage models.

Get Model by ID

Get Models by TDIS Identifier.

Authorizations:

ApiKeyAuth

path Parameters

model_tdis_identifier

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-6849a4a0-c9d1-11ee-87a4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "CR_1052",
"creator": null,
"description": "test",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Test",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": ["Test"
],
"cities": ["Abbott"
],
"counties": ["Anderson"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "5engineering",
"origination_agency_id": 2112,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "ADvanced CIRCulation Model",
"software_distributor": "University of North Carolina",
"software_version": "test",
"time_periods": null,
"twdb_flood_planning_project_ids": ["023000012"
],
"most_recent_status_update": "2024-02-13T20:35:56.336Z",
"model_created": "2024-01-31T00:00:00.000Z",
"model_last_updated": "2023-08-30T00:00:00.000Z",
"external_identifier": "020000000008",
"twdb_identifier": "020000000008"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-33df4e00-cb47-11ee-80b4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "in progress",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000025"
],
"most_recent_status_update": "2024-02-14T14:41:56.838Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000028",
"twdb_identifier": "010000000028"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-46bdf826-cc11-11ee-88f7-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000029"
],
"most_recent_status_update": "2024-02-15T14:58:44.818Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000029",
"twdb_identifier": "010000000029"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-499f3fda-cc36-11ee-a7e5-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000031"
],
"most_recent_status_update": "2024-02-15T19:24:52.173Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000031",
"external_identifier": "010000000031"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000030"
],
"most_recent_status_update": "2024-02-15T17:39:16.698Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000030",
"external_identifier": "010000000030"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-ddc9c7fc-cba5-11ee-8b78-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000028"
],
"most_recent_status_update": "2024-02-15T02:20:06.408Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000029",
"external_identifier": "010000000029"
}
}
]
}

Get Download File Path

Get Download File Path by TWDB Identifier.

Authorizations:

ApiKeyAuth

query Parameters

twdb_identifier

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-fb6c9598-9fa7-11ee-9e44-c9f3204fbf5a",
"username": "edaniel",
"upload_type": "archive",
"name": "090000000014_CityofAndrewsPlaya.zip",
"mime_type": "application/zip",
"path": "twdb-region-09/archive/c9426447-4d90-4ba7-9a1f-81e8ea8ef1c5/090000000014_CityofAndrewsPlaya.zip",
"archived": false,
"uploaded": "2024-01-04T16:00:00.000Z"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-fb6c9598-9fa7-11ee-9e44-c9f3204fbf5a",
"username": "edaniel",
"upload_type": "archive",
"name": "090000000014_CityofAndrewsPlaya.zip",
"mime_type": "application/zip",
"path": "twdb-region-09/archive/113900de-ccf2-4877-8981-67e1f0422d29/090000000014_CityofAndrewsPlaya.zip",
"archived": false,
"uploaded": "2024-03-11T15:24:00.000Z"
}
}
]
}

Get Models By User

Get all the models by user.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-6849a4a0-c9d1-11ee-87a4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "CR_1052",
"creator": null,
"description": "test",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Test",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": ["Test"
],
"cities": ["Abbott"
],
"counties": ["Anderson"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "5engineering",
"origination_agency_id": 2112,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "ADvanced CIRCulation Model",
"software_distributor": "University of North Carolina",
"software_version": "test",
"time_periods": null,
"twdb_flood_planning_project_ids": ["023000012"
],
"most_recent_status_update": "2024-02-13T20:35:56.336Z",
"model_created": "2024-01-31T00:00:00.000Z",
"model_last_updated": "2023-08-30T00:00:00.000Z",
"external_identifier": "020000000008",
"twdb_identifier": "020000000008"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-33df4e00-cb47-11ee-80b4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "in progress",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000025"
],
"most_recent_status_update": "2024-02-14T14:41:56.838Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000028",
"twdb_identifier": "010000000028"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-46bdf826-cc11-11ee-88f7-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000029"
],
"most_recent_status_update": "2024-02-15T14:58:44.818Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000029",
"twdb_identifier": "010000000029"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-499f3fda-cc36-11ee-a7e5-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000031"
],
"most_recent_status_update": "2024-02-15T19:24:52.173Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000031",
"external_identifier": "010000000031"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000030"
],
"most_recent_status_update": "2024-02-15T17:39:16.698Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000030",
"external_identifier": "010000000030"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-ddc9c7fc-cba5-11ee-8b78-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000028"
],
"most_recent_status_update": "2024-02-15T02:20:06.408Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000029",
"external_identifier": "010000000029"
}
}
]
}

Get Models By Project Identifier

Get all the models by project identifier.

Authorizations:

ApiKeyAuth

query Parameters

project_identifier

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-6849a4a0-c9d1-11ee-87a4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "CR_1052",
"creator": null,
"description": "test",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Test",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": ["Test"
],
"cities": ["Abbott"
],
"counties": ["Anderson"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "5engineering",
"origination_agency_id": 2112,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "ADvanced CIRCulation Model",
"software_distributor": "University of North Carolina",
"software_version": "test",
"time_periods": null,
"twdb_flood_planning_project_ids": ["023000012"
],
"most_recent_status_update": "2024-02-13T20:35:56.336Z",
"model_created": "2024-01-31T00:00:00.000Z",
"model_last_updated": "2023-08-30T00:00:00.000Z",
"external_identifier": "020000000008",
"twdb_identifier": "020000000008"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-33df4e00-cb47-11ee-80b4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "in progress",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000025"
],
"most_recent_status_update": "2024-02-14T14:41:56.838Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000028",
"twdb_identifier": "010000000028"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-46bdf826-cc11-11ee-88f7-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000029"
],
"most_recent_status_update": "2024-02-15T14:58:44.818Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000029",
"twdb_identifier": "010000000029"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-499f3fda-cc36-11ee-a7e5-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000031"
],
"most_recent_status_update": "2024-02-15T19:24:52.173Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000031",
"external_identifier": "010000000031"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000030"
],
"most_recent_status_update": "2024-02-15T17:39:16.698Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000030",
"external_identifier": "010000000030"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-ddc9c7fc-cba5-11ee-8b78-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000028"
],
"most_recent_status_update": "2024-02-15T02:20:06.408Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000029",
"external_identifier": "010000000029"
}
}
]
}

Get Models By Search Field

Get models by project identifier or external identifier.

Authorizations:

ApiKeyAuth

query Parameters

search_field required	string Search field (project_identifier or external_identifier).
value required	string Search value.

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-6849a4a0-c9d1-11ee-87a4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "CR_1052",
"creator": null,
"description": "test",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Test",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": ["Test"
],
"cities": ["Abbott"
],
"counties": ["Anderson"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "5engineering",
"origination_agency_id": 2112,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "ADvanced CIRCulation Model",
"software_distributor": "University of North Carolina",
"software_version": "test",
"time_periods": null,
"twdb_flood_planning_project_ids": ["023000012"
],
"most_recent_status_update": "2024-02-13T20:35:56.336Z",
"model_created": "2024-01-31T00:00:00.000Z",
"model_last_updated": "2023-08-30T00:00:00.000Z",
"external_identifier": "020000000008",
"twdb_identifier": "020000000008"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-33df4e00-cb47-11ee-80b4-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "in progress",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000025"
],
"most_recent_status_update": "2024-02-14T14:41:56.838Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000028",
"twdb_identifier": "010000000028"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-46bdf826-cc11-11ee-88f7-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "rejected",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000029"
],
"most_recent_status_update": "2024-02-15T14:58:44.818Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"external_identifier": "010000000029",
"twdb_identifier": "010000000029"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-499f3fda-cc36-11ee-a7e5-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": ["110800060909"
],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000031"
],
"most_recent_status_update": "2024-02-15T19:24:52.173Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000031",
"external_identifier": "010000000031"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": [ ],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000030"
],
"most_recent_status_update": "2024-02-15T17:39:16.698Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000030",
"external_identifier": "010000000030"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-ddc9c7fc-cba5-11ee-8b78-7c1e5208b5a2",
"collection_id": 161,
"model_title": "Happy West Road Hydraulic Model",
"creator": null,
"description": "Hydraulic Model of Happy West Road in Randall County",
"controlled_vocabulary": null,
"region": "Canadian-Upper Red",
"model_types": ["Hydraulic"
],
"purpose": "Evaluate existing and proposed conditions for Happy West Road",
"extent": null,
"model_contacts": [[277,
1
]
],
"custody_chain": [ ],
"cities": ["Abbott"
],
"counties": ["Randall"
],
"hucs": [ ],
"license": "",
"keyword_term": null,
"status": "accepted",
"locality": null,
"update_interval": "None",
"distribution_agency": null,
"origination_agency": "HDR",
"origination_agency_id": 2102,
"documentation_filenames": [ ],
"model_version": null,
"distribution_url": null,
"software": "Hydrologic Engineering Center River Analysis System",
"software_distributor": "US Army Corps of Engineers",
"software_version": "6.3",
"time_periods": null,
"twdb_flood_planning_project_ids": ["013000028"
],
"most_recent_status_update": "2024-02-15T02:20:06.408Z",
"model_created": "2023-03-25T00:00:00.000Z",
"model_last_updated": "2023-03-25T00:00:00.000Z",
"twdb_identifier": "010000000029",
"external_identifier": "010000000029"
}
}
]
}

Search Models

Search models by search terms

path Parameters

search_terms

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-1c889abc-25df-11ee-9e44-c9f3204fbf5a",
"collection": "Region 06 Collection",
"tdis_collection_identifier": "TC-c86e508a-8ec3-11ec-ba2a-59ebf1ac4488",
"model_types": ["Hydraulic",
"Hydrologic"
],
"title": "Halls Bayou - Right-Of-Way, Design, and Construction of Channel Conveyance Improvements on P118-25-00 & P118-25-01",
"description": "Prepared by R. G. Millers engineering for Harris County Flood Control District (HCFCD). \nBEGIN DESCRIPTION: \nProject: Halls Bayou (HCFCD Unit P118-00-00) Flood Risk Reduction and Phasing Study; Preliminary Impacts Analysis P118-25-00\nDate: January 2021 to Present\nClient: HCFCD\nModeler: HT&J\nVersion: 5.0.7\n\n**********************************\nProject:Halls Bayou (HCFCD Unit P118-00-00) Flood Risk Reduction and Phasing Study; Preliminary Impacts Analysis P118-25-00\nDate: January 2018 to Present\nClient: HCFCD\nModeler: LAN\nVersion: 5.0.3\n\nDescription:\nTo conduct preliminary impacts analysis, LAN utilized the P118-00-00 Halls Bayou Phasing Study HEC-RAS model and implemented the standalone model of P118-25-00/01 with its boundary conditions. As P118-25-00/01 is an unstudied tributary of Halls Bayou, this analysis will only focus on the effect that the Recommended Alternative will potentially have on P118-00-00 WSEL pre- and post-project. \n\nThe purpose of the Phasing Study to provide a systematic approach towards implementing the 2013 Halls Vision Plan. The development, calibration, validation, and routine maintenance of this model is done with the intent to provide a means for analyzing various channel improvements and regional detention basins for flood risk management purposes and to provide a quantitative check to ensure flood mitigation solutions are in full compliance with the stated objectives of the Halls Ahead Vision Plan. The model has been developed as an unsteady HEC-RAS model (Version 5.0.3), built upon the Vision Plan models, and updated to reflect Revised Existing conditions that represented watershed characteristics up to and including the time of the calibration event (i.e. 2015 October Event) and validation events (i.e. 2016 Tax Day Event and 2017 Hurricane Harvey).",
"custody_chain": [ ],
"cities": [ ],
"counties": ["Harris"
],
"region": "San Jacinto",
"keyword_term": null,
"archive_path": "twdb-region-06/archive/fbbb9732-cfde-44d8-bf03-89ee3563310d/060000000399_HallsBayou_P118-25.zip"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-d69cd304-1ffa-11ee-9e44-c9f3204fbf5a",
"collection": "Region 03 Collection",
"tdis_collection_identifier": "TC-2afb0120-a94e-11ec-ba2a-59ebf1ac4488",
"model_types": ["Hydraulic"
],
"title": "Kingstree",
"description": "Model to analyze the severity of roadway and structural flooding and develop an alternative to improve flooding conditions.\n",
"custody_chain": [ ],
"cities": [ ],
"counties": ["Kaufman"
],
"region": "Trinity",
"keyword_term": null,
"archive_path": "twdb-region-03/archive/fd75d377-6471-4f03-9d6d-f9ea228775f7/030000014331_Kingstree.zip"
}
}
]
}

List files of Model

Get the list of uploaded files by TDIS identifier.

Authorizations:

ApiKeyAuth

path Parameters

tdis_identifier

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"upload_type": "file",
"name": "metadata_TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2.yml",
"mime_type": "text/plain",
"path": "twdb-region-01/content/d2c0ff62-4ea1-4d1f-ba7f-d5f7996847a9/010000000030_HappyWestRoad/metadata_TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2.yml"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"upload_type": "directory",
"name": "GIS",
"mime_type": "directory",
"path": "twdb-region-01/content/d2c0ff62-4ea1-4d1f-ba7f-d5f7996847a9/010000000030_HappyWestRoad/GIS"
}
}
]
}

Get Model Archive Files

Get archive files by TDIS Identifier

Authorizations:

ApiKeyAuth

path Parameters

model_tdis_identifier

required

string

Responses

Response samples

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-fb6c9598-9fa7-11ee-9e44-c9f3204fbf5a",
"username": "edaniel",
"upload_type": "archive",
"name": "090000000014_CityofAndrewsPlaya.zip",
"mime_type": "application/zip",
"path": "twdb-region-09/archive/c9426447-4d90-4ba7-9a1f-81e8ea8ef1c5/090000000014_CityofAndrewsPlaya.zip",
"archived": false,
"uploaded": "2024-01-04T16:00:00.000Z"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-fb6c9598-9fa7-11ee-9e44-c9f3204fbf5a",
"username": "edaniel",
"upload_type": "archive",
"name": "090000000014_CityofAndrewsPlaya.zip",
"mime_type": "application/zip",
"path": "twdb-region-09/archive/113900de-ccf2-4877-8981-67e1f0422d29/090000000014_CityofAndrewsPlaya.zip",
"archived": false,
"uploaded": "2024-03-11T15:24:00.000Z"
}
}
]
}

This endpoint is to capture the user downloading t

This endpoint is to capture the user downloading the file. This is for TDIS Audit purposes.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

emailId

any

Responses

Request samples

Payload

Content type

application/json

{"emailId": "download_user@example.org"
}