MS2 API (1.0.0)

Download OpenAPI specification:Download

MS2 API

Published for maintaing 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

200
400

Content type

application/json

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

External Partners

APIs to manage models

Create Model

Add a new model.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

twdb_flood_planning_project_ids	string Identifier(s) associated with FMP, FME, FMS in the regional flood plan. Each entry is a 9 digit number where the first 2 digits are the Flood Planning Region identifier; followed by "1" (for FME), "2" (for FMS), or "3" (for FMP); followed by a 6-digit unique sequence generated by vendor.
collection_id	string
counties	string County or counties that your model spans.
cities	string Comma seperated values. City or cities that your model spans; will be used for spatial analysis.
time_periods	Array of strings[ items ]
model_name	string A name given to the model and its associated configuration.
model_description	string The description may include an abstract, a table of contents, or a free-text account of the model.
model_types	string
external_model_identifier	string MODEL_ID from ModelCoverage feature class. This is a 12-digit number where the first 2-digits are the Flood Planning Region identifier, followed by regionally unique 10-digit number.
software_abbreviation	string The name of the software used. Refer get-software-list API endpoint to get the supported list.
software_version	string The version of the software used.
origination_agency_id	integer The name of organization(s) or person(s) who should be cited as contributing to the creation of the model. Also referred to as an "author", "contributor", "creator".
model_created	string <date> YYYY-MM-DD The date the model was created.
model_last_updated	string <date> YYYY-MM-DD The date when the model was last updated.
model_update_interval	string Default: "None"
use_constraints	string Default: "Public"
contacts	string Primary point(s) of contact for this model. At least one contact is required. [{User_Id,Role_Id},{User_Id,Role_Id}]
documentation_filenames	string List of filenames of any supporting documentation to be included in the model upload (e.g. "about.txt").
chain_custody	string Comma sepearetd values. A statement of any changes in ownership and custody of the model since its creation that are significant for its authenticity, integrity, and interpretation. The statement may include a description of any changes successive custodians made to the model.
huc	string Comma seperated value.12-digit Hydrologic Unit Code(s) identifying the watershed(s).
model_purpose	string A description of the purpose for the creation of this model and/or the expected use.
license	string
tdis_identifier	string Flood Planning Region number.
userId	integer

Responses

Request samples

Payload

Content type

application/json

{"twdb_flood_planning_project_ids": "023000091,023000092",
"collection_id": "string",
"counties": "Denton,Archer",
"cities": "Frisco,Agua Dulce",
"time_periods": [["2023-12-01",
"2024-03-11"
]
],
"model_name": "string",
"model_description": "string",
"model_types": "string",
"external_model_identifier": "020000000091",
"software_abbreviation": "string",
"software_version": "string",
"origination_agency_id": 0,
"model_created": "2019-08-24",
"model_last_updated": "2019-08-24",
"model_update_interval": "None",
"use_constraints": "Public",
"contacts": "{277,1},{277,9}",
"documentation_filenames": "string",
"chain_custody": "Chain of Custody,Chain of custody 1",
"huc": "111201040402,111201040602",
"model_purpose": "string",
"license": "string",
"tdis_identifier": "string",
"userId": 0
}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TL-5a6be22e-a0d5-11ed-afda-0242ac1b0002"
}
}
]
}

Update Model

Update an existing model.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

twdb_flood_planning_project_ids	string Identifier(s) associated with FMP, FME, FMS in the regional flood plan. Each entry is a 9 digit number where the first 2 digits are the Flood Planning Region identifier; followed by "1" (for FME), "2" (for FMS), or "3" (for FMP); followed by a 6-digit unique sequence generated by vendor.
collection_id	string
counties	string County or counties that your model spans.
cities	string Comma seperated values. City or cities that your model spans; will be used for spatial analysis.
time_periods	Array of strings[ items ]
model_name	string A name given to the model and its associated configuration.
model_description	string The description may include an abstract, a table of contents, or a free-text account of the model.
model_types	string
external_model_identifier	string MODEL_ID from ModelCoverage feature class. This is a 12-digit number where the first 2-digits are the Flood Planning Region identifier, followed by regionally unique 10-digit number.
software_abbreviation	string The name of the software used. Refer get-software-list API endpoint to get the supported list.
software_version	string The version of the software used.
origination_agency_id	integer The name of organization(s) or person(s) who should be cited as contributing to the creation of the model. Also referred to as an "author", "contributor", "creator".
model_created	string <date> YYYY-MM-DD The date the model was created.
model_last_updated	string <date> YYYY-MM-DD The date when the model was last updated.
model_update_interval	string Default: "None"
use_constraints	string Default: "Public"
contacts	string Primary point(s) of contact for this model. At least one contact is required. [{User_Id,Role_Id},{User_Id,Role_Id}]
documentation_filenames	string List of filenames of any supporting documentation to be included in the model upload (e.g. "about.txt").
chain_custody	string Comma sepearetd values. A statement of any changes in ownership and custody of the model since its creation that are significant for its authenticity, integrity, and interpretation. The statement may include a description of any changes successive custodians made to the model.
huc	string Comma seperated value.12-digit Hydrologic Unit Code(s) identifying the watershed(s).
model_purpose	string A description of the purpose for the creation of this model and/or the expected use.
license	string
tdis_identifier	string Flood Planning Region number.
userId	integer

Responses

Request samples

Payload

Content type

application/json

{"twdb_flood_planning_project_ids": "023000091,023000092",
"collection_id": "string",
"counties": "Denton,Archer",
"cities": "Frisco,Agua Dulce",
"time_periods": [["2023-12-01",
"2024-03-11"
]
],
"model_name": "string",
"model_description": "string",
"model_types": "string",
"external_model_identifier": "020000000091",
"software_abbreviation": "string",
"software_version": "string",
"origination_agency_id": 0,
"model_created": "2019-08-24",
"model_last_updated": "2019-08-24",
"model_update_interval": "None",
"use_constraints": "Public",
"contacts": "{277,1},{277,9}",
"documentation_filenames": "string",
"chain_custody": "Chain of Custody,Chain of custody 1",
"huc": "111201040402,111201040602",
"model_purpose": "string",
"license": "string",
"tdis_identifier": "string",
"userId": 0
}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TL-5a6be22e-a0d5-11ed-afda-0242ac1b0002"
}
}
]
}

Clone Model

Duplicate an existing model.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

tdis_identifier

string

Responses

Request samples

Payload

Content type

application/json

{"tdis_identifier": "string"
}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TL-5a6be22e-a0d5-11ed-afda-0242ac1b0002"
}
}
]
}

Delete Model

Delete an existing model.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

tdis_identifier

string

Responses

Request samples

Payload

Content type

application/json

{"tdis_identifier": "string"
}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TL-5a6be22e-a0d5-11ed-afda-0242ac1b0002"
}
}
]
}

Get Model by ID

Get Models by TDIS Identifier.

Authorizations:

ApiKeyAuth

path Parameters

model_tdis_identifier

required

string

Responses

Response samples

200
400

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"
}
},
{"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"
}
},
{"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"
}
},
{"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",
"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",
"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",
"external_identifier": "010000000029"
}
}
]
}

Get Models By User

Get all the models by user.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string

Responses

Response samples

200
400

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"
}
},
{"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"
}
},
{"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"
}
},
{"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",
"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",
"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",
"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

200
400

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"
}
},
{"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"
}
},
{"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"
}
},
{"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",
"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",
"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",
"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

200
400

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"
}
},
{"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"
}
},
{"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"
}
},
{"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",
"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",
"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",
"external_identifier": "010000000029"
}
}
]
}

Search Models

Search models by search terms

path Parameters

search_terms

required

string

Responses

Response samples

200
400

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"
}
}
]
}

Accept Model

Authorizations:

ApiKeyAuth

Request Body schema: application/json

userId	string
tdis_identifiers	string
username	string
comments	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"tdis_identifiers": "string",
"username": "string",
"comments": "string"
}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TL-5a6be22e-a0d5-11ed-afda-0242ac1b0002"
}
}
]
}

List Models

Get all the models by admin user.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string

Responses

Response samples

200
400

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"
}
},
{"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"
}
},
{"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"
}
},
{"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",
"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",
"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",
"external_identifier": "010000000029"
}
}
]
}

Set Model Status

Authorizations:

ApiKeyAuth

Request Body schema: application/json

userId	string
tdis_identifiers	string
status	string Enum: "accepted" "pending" "rejected" "in progress"
username	string
comments	string

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"tdis_identifiers": "string",
"status": "accepted",
"username": "string",
"comments": "string"
}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"Status": "accepted"
}
}
]
}

Metadata

APIs to support models

List Contacts

Get List of Contacts

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"contact_id": 153,
"first_name": "Lincoln",
"last_name": "Abbott",
"agency": "Freese and Nichols",
"comments": null,
"work_phone": "936-755-3427",
"email": "lincoln.abbott@freese.com"
}
}
]
}

Get Contact Roles

Get list of contact roles.

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"id": 3,
"name": "Curator",
"description": "Contact responsible for the quality and formatting of the digital object and its metadata to enable reuse.",
"metadata_level": "TBD"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"id": 9,
"name": "Digital Object Creator",
"description": "Originator.",
"metadata_level": "TBD"
}
}
]
}

List Existing Collections

Get the list of existing collections

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"collection_id": 116,
"tdis_identifier": "TC-c86e5088-8ec3-11ec-ba2a-59ebf1ac4488",
"user_id": 6
}
},
{"type": "Feature",
"geometry": "",
"properties": {"collection_id": 117,
"tdis_identifier": "TC-c86e5089-8ec3-11ec-ba2a-59ebf1ac4488",
"user_id": 6
}
}
]
}

List Softwares

Get list of softwares in the system.

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"software_id": 43,
"software_abbr": "ADCIRC",
"software_name": "ADvanced CIRCulation Model",
"software_description": "ADCIRC is a system of computer programs for solving time dependent, free surface circulation and transport problems in two and three dimensions. These programs utilize the finite element method in space allowing the use of highly flexible, unstructured grids."
}
},
{"type": "Feature",
"geometry": "",
"properties": {"software_id": 53,
"software_abbr": "Delft3D",
"software_name": "Delft3D",
"software_description": "3D modeling suite to investigate hydrodynamics, sediment transport and morphology and water quality for fluvial, estuarine and coastal environments. As per 1 January 2011, the Delft3D flow (FLOW), morphology (MOR) and waves (WAVE) modules are available in open source."
}
}
]
}

List Agencies

Get the list of agencies in the system.

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"id": 863,
"abbreviation": "4801108",
"name": "Ackerly"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"id": 864,
"abbreviation": "4801240",
"name": "Addison"
}
}
]
}

List files of Model

Get the list of uploaded files by TDIS identifier.

Authorizations:

ApiKeyAuth

path Parameters

tdis_identifier

required

string

Responses

Response samples

200
400

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

Auth Server

https://api-ms2authn.dev.cloud.tdis.io/api/metadata/get-model-archive/{model_tdis_identifier}

DEV Server

https://api-midware.dev.cloud.tdis.io/api/metadata/get-model-archive/{model_tdis_identifier}

Auth PROD Server

https://api-ms2authn.cloud.tdis.io/api/metadata/get-model-archive/{model_tdis_identifier}

PROD Server

https://api-midware.cloud.tdis.io/api/metadata/get-model-archive/{model_tdis_identifier}

Response samples

200
400

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"
}
}
]
}

Messages

Get all the messages of a model.

Authorizations:

ApiKeyAuth

path Parameters

tdis_identifier

required

string

Responses

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"username": "tdis_admin",
"date": "2024-02-15T17:32:02.319Z",
"content": "WARNING: External ID associated with this TDIS ID(TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2), 010000000030 does not match external ID in file name: 01000000"
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"username": "gsmithhart",
"date": "2024-02-15T17:34:19.764Z",
"content": "Hello "
}
}
]
}

Upload Conflicts

Get Conflicts By Model.

Authorizations:

ApiKeyAuth

path Parameters

model_tdis_identifier

required

string

Responses

Auth Server

https://api-ms2authn.dev.cloud.tdis.io/api/metadata/get-upload-conflicts/{model_tdis_identifier}

DEV Server

https://api-midware.dev.cloud.tdis.io/api/metadata/get-upload-conflicts/{model_tdis_identifier}

Auth PROD Server

https://api-ms2authn.cloud.tdis.io/api/metadata/get-upload-conflicts/{model_tdis_identifier}

PROD Server

https://api-midware.cloud.tdis.io/api/metadata/get-upload-conflicts/{model_tdis_identifier}

Response samples

200
400

Content type

application/json

{"type": "string",
"features": [{"type": "string",
"properties": {"tdis_identifier": "string",
"filename": "string",
"username": "string",
"conflict_number": 0,
"conflict": "string",
"upload_id": "string",
"upload_batch_id": "string",
"archived": "string",
"uploaded": "string"
}
}
]
}

Notifications

Get Notifications By Model.

Authorizations:

ApiKeyAuth

path Parameters

model_tdis_identifier

required

string

Responses

Auth Server

https://api-ms2authn.dev.cloud.tdis.io/api/metadata/get-notifications/{model_tdis_identifier}

DEV Server

https://api-midware.dev.cloud.tdis.io/api/metadata/get-notifications/{model_tdis_identifier}

Auth PROD Server

https://api-ms2authn.cloud.tdis.io/api/metadata/get-notifications/{model_tdis_identifier}

PROD Server

https://api-midware.cloud.tdis.io/api/metadata/get-notifications/{model_tdis_identifier}

Response samples

200
400

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"username": null,
"status": "pending",
"content": "System validated upload."
}
},
{"type": "Feature",
"geometry": "",
"properties": {"tdis_identifier": "TM-7c136612-cc27-11ee-9a0b-7c1e5208b5a2",
"username": "gsmithhart",
"status": "accepted",
"content": ""
}
}
]
}

Model History

Get the changes made on the model.

Authorizations:

ApiKeyAuth

path Parameters

tdis_identifier

required

string

Responses

Response samples

200
400

Content type

application/json

{"type": "string",
"properties": {"tdis_identifier": "string",
"event_time": "2019-08-24T14:15:22Z",
"operation": 0,
"new_values": {"title": "string",
"external_identifier": "string",
"tdis_identifier": "string",
"hucs": ["string"
],
"twdb_flood_planning_project_ids": ["string"
],
"description": "string",
"purpose": "string",
"model_types": ["string"
],
"model_last_updated": "2019-08-24",
"model_created": "2019-08-24",
"custody_chain": ["string"
],
"counties": ["string"
],
"cities": ["string"
],
"time_periods": ["string"
],
"documentation_filenames": ["string"
],
"software": "string",
"software_version": "string",
"origination_agency": "string",
"model_contacts": [[0
]
],
"file_size": "string",
"file_path": "string"
},
"old_values": {"title": "string",
"external_identifier": "string",
"tdis_identifier": "string",
"hucs": ["string"
],
"twdb_flood_planning_project_ids": ["string"
],
"description": "string",
"purpose": "string",
"model_types": ["string"
],
"model_last_updated": "2019-08-24",
"model_created": "2019-08-24",
"custody_chain": ["string"
],
"counties": ["string"
],
"cities": ["string"
],
"time_periods": ["string"
],
"documentation_filenames": ["string"
],
"software": "string",
"software_version": "string",
"origination_agency": "string",
"model_contacts": [[0
]
],
"file_size": "string",
"file_path": "string"
}
}
}