/api/open/v1/DataSets?$filename=OpenFEMADatasets.txt - Returns data set metadata and initiates a download to a filename called “OpenFEMADatasets.txt”.If no $format parameter is specified, JSON will be the result. The filename should not be surrounded by quotation marks even if the filename contains spaces. Note, all of the $filter, $orderby, and $select parameters will work with $filename. The data downloaded will be limited to fields specified using $select (all fields if none specified), will contain records limited by $filter, and will be sorted according to the $orderby parameter. /api/open/v2/DisasterDeclarationsSummaries - (Default) Returns without the record count (i.e., a record count of 0)Īllows for the specification of a download filename. ![]() /api/open/v2/DisasterDeclarationsSummaries?$count=false - Returns without the record count (i.e., a record count of 0)./api/open/v2/DisasterDeclarationsSummaries?$count=true - Returns the record count.false - Does not return the count (default).If retrieving large amounts of data or using complex $filter criteria through a "paging" technique, avoid specifying "$count=true" in each call. It must be used in conjunction with a file download as shown in the following example. Note, this will not have the effect of retrieving and displaying all records within a browser window. The $allrecords=true query string overrides this behavior. Currently, any query resulting in more records than specified by $top will require a "paging" technique to iterate through results to capture all of the data. It is an attempt to reduce the difficulty in downloading large sets of data. This query argument forces all records to be returned as part of a download rather than adhering to the maximum return limit. Performs a search of the entity using specified query string parameters. The following URI commands can be used to alter your request of OpenFEMA endpoint data – filtering the result, specifying a return type, or including additional metadata. This can be a URL to a website it can also be identify a specific resource as well as a location. Number of records to skip from the dataset.Ī Uniform Resource Identifier (URI) is a string of characters identifying an abstract or physical resource on the web. To specify if a total entity count should be returned with the query.Ĭontrols the presence of the metadata object in data set returns. To specify the format of the returned data.ĭEPRECATED. ![]() To specify if a total entity count should be returned with the query. To specify that all records are to be returned when downloading data. Working examples can be found on the Developer Resources page. See the URI commands below for information on how to page through all found records. By default, only 1,000 records are returned. Query strings including the data set/endpoint name are case sensitive.Ī successful response will include a both a metadata object (described below) and an array of entity objects (records). Q uery strings including the data set/endpoint name are case sensitive. The entity names can be found in the list of released datasets. entity: This corresponds to the name of the entity set you are requesting.The API version format is v1, v2, v3, etc. To use the APIs you must indicate which version you need. version: To support future enhancements we are using a versioning system for the APIs.To use the API, you will need to build a query string path in the following format: Major and minor version features (including the addition or deprecation of datasets) can be found on the Changelog page. See the Developer Resources page for additional information.Ī full list of Entities/endpoints supported by the API can be found at Data Sets. ![]() Other methods such as CURL or accessing with a programming language can also be used. This document provides information on how to use the API including command examples. The data is exposed using a RESTful interface that uses query string parameters to manage the query. Use of the service is free and does not require a subscription or API key. As part of the OpenFEMA initiative, FEMA is providing read-only API based access to datasets (Entities).
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |