API Reference

Search locations

get
https://{host}/platform/riskdata/v1/exposures//locations

Returns a list of locations.

A location is a property, building, business, or other asset that may be damaged by catastrophe events.

Path Params
int64
required
≥ 1

ID of EDM.

Query Params
string

Query string to select response data based on property values.

Depending on the property, you may use comparison operators and list operators. String values must be enclosed in double quotes, and the keywords IN, NOT IN, LIKE, and NOT LIKE must be uppercase.

PropertyComparisonList
accountId=, !=, >, <, >=, <=IN, NOT IN
addressType=, !=, >, <, >=, <=IN, NOT IN
admin1Code=, !=, LIKE, NOT LIKEIN, NOT IN
admin1Name=, !=, LIKE, NOT LIKEIN, NOT IN
admin2Code=, !=, LIKE, NOT LIKEIN, NOT IN
admin2Name=, !=, LIKE, NOT LIKEIN, NOT IN
admin3Code=, !=, LIKE, NOT LIKEIN, NOT IN
admin3Name=, !=, LIKE, NOT LIKEIN, NOT IN
admin4Code=, !=, LIKE, NOT LIKEIN, NOT IN
admin4Name=, !=, LIKE, NOT LIKEIN, NOT IN
area=, !=, >, <, >=, <=IN, NOT IN
areaUnit=, !=, >, <, >=, <=IN, NOT IN
bldgHeight=, !=, >, <, >=, <=IN, NOT IN
bldgValuation=, !=, >, <, >=, <=IN, NOT IN
block=, !=, LIKE, NOT LIKEIN, NOT IN
blockGroup=, !=, LIKE, NOT LIKEIN, NOT IN
buildingClass=, !=, LIKE, NOT LIKEIN, NOT IN
buildingClassScheme=, !=, LIKE, NOT LIKEIN, NOT IN
buildingId=, !=, LIKE, NOT LIKEIN, NOT IN
buildingName=, !=, LIKE, NOT LIKEIN, NOT IN
buildings=, !=, >, <, >=, <=IN, NOT IN
cityCode=, !=, LIKE, NOT LIKEIN, NOT IN
cityName=, !=, LIKE, NOT LIKEIN, NOT IN
contentLossTrigger=, !=, >, <, >=, <=IN, NOT IN
country=, !=, LIKE, NOT LIKEIN, NOT IN
countryRmsCode=, !=, LIKE, NOT LIKEIN, NOT IN
countryScheme=, !=, LIKE, NOT LIKEIN, NOT IN
currency=, !=, LIKE, NOT LIKEIN, NOT IN
dwellTime=, !=, >, <, >=, <=IN, NOT IN
expireDate=, !=, >, <, >=, <=
floodDefenseElevation=, !=, >, <, >=, <=IN, NOT IN
floodDefenseElevationUnit=, !=, >, <, >=, <=IN, NOT IN
floodDefHtAboveGrnd=, !=, >, <, >=, <=IN, NOT IN
floorArea=, !=, >, <, >=, <=IN, NOT IN
floorOccupancy=, !=, LIKE, NOT LIKEIN, NOT IN
geoResolutionCode=, !=, LIKE, NOT LIKEIN, NOT IN
heightUnit=, !=, >, <, >=, <=IN, NOT IN
huZone=, !=, LIKE, NOT LIKEIN, NOT IN
inceptDate=, !=, >, <, >=, <=
isPrimaryBldg=, !=IN, NOT IN
latitude=, !=, >, <, >=, <=IN, NOT IN
locationCode=, !=, LIKE, NOT LIKEIN, NOT IN
locationId=, !=, >, <, >=, <=IN, NOT IN
locationName=, !=, LIKE, NOT LIKEIN, NOT IN
locationNumber=, !=, LIKE, NOT LIKEIN, NOT IN
longitude=, !=, >, <, >=, <=IN, NOT IN
mfdSubcategory=, !=, >, <, >=, <=IN, NOT IN
nship=, !=, >, <, >=, <=IN, NOT IN
occupancyType=, !=, >, <, >=, <=IN, NOT IN
occupancyTypeScheme=, !=, LIKE, NOT LIKEIN, NOT IN
otherZone=, !=, LIKE, NOT LIKEIN, NOT IN
postalCode=, !=, LIKE, NOT LIKEIN, NOT IN
propertyReference=, !=, LIKE, NOT LIKEIN, NOT IN
rentalPropertyIdentifier=, !=, >, <, >=, <=IN, NOT IN
siteName=, !=, LIKE, NOT LIKEIN, NOT IN
slope=, !=, >, <, >=, <=IN, NOT IN
stories=, !=, >, <, >=, <=IN, NOT IN
streetAddress=, !=, LIKE, NOT LIKEIN, NOT IN
tiv=, !=, >, <, >=, <=IN, NOT IN
updateDate=, !=, >, <, >=, <=
useContentValue=, !=, >, <, >=, <=IN, NOT IN
userBfe=, !=, >, <, >=, <=IN, NOT IN
userGroundElev=, !=, >, <, >=, <=IN, NOT IN
userId1=, !=, LIKE, NOT LIKEIN, NOT IN
userId2=, !=, LIKE, NOT LIKEIN, NOT IN
userText1=, !=, LIKE, NOT LIKEIN, NOT IN
userText2=, !=, LIKE, NOT LIKEIN, NOT IN
yearBuilt=, !=, LIKE, NOT LIKEIN, NOT IN
zone1=, !=, LIKE, NOT LIKEIN, NOT IN
zone3Name=, !=, LIKE, NOT LIKEIN, NOT IN
zone4Name=, !=, LIKE, NOT LIKEIN, NOT IN

Use the AND and OR logical operators to combine two or more expressions into a complex query. See Filtering Responses.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties; accountId, addressType, admin1Code, admin1Name, admin2Code, admin2Name, admin3Code, admin3Name, admin4Code, admin4Name, area, areaUnit, bldgHeight, bldgValuation, block, blockGroup, buildingClass, buildingClassScheme, buildingId, buildingName, buildings, cityCode, cityName, contentLossTrigger, countryRmsCode, countryScheme, currency, dwellTime, expireDate, floodDefenseElevation, floodDefenseElevationUnit, floodDefHtAboveGrnd, floorArea, floorOccupancy, geoResolutionCode, heightUnit, huZone, inceptDate, isPrimaryBldg, latitude, locationCode, locationId, locationName, locationNumber, longitude, mfdSubcategory, nship, occupancyType, occupancyTypeScheme, otherZone, postalCode, propertyReference, rentalPropertyIdentifier, siteName, slope, stories, streetAddress, tiv, updateDate, useContentValue, userBfe, userGroundElev, userId1, userId2, userText1, userText2, yearBuilt, zone1, zone3Name, zone4Name

See Response Pagination.

int32

Number of records returned per page. See Response Pagination

int32

Number of the page displaying the returned records, starting at 0

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago

Did this page help you?