GET /api/v1/regions/does_region_exist.json
Find if name corresponds to a known region

Find if name corresponds to a known region

Supported Formats

json

Params

Param name Description
name
required

name of region

Validations:

  • Must be a String


GET /api/v1/regions/closest_by_lat_lon.json
Find closest region based on lat/lon

Find closest region based on lat/lon

Supported Formats

json

Params

Param name Description
lat
required

Lat

Validations:

  • Must be a String

lon
required

Lon

Validations:

  • Must be a String


GET /api/v1/regions.json
Fetch all regions

Fetch data about all regions


GET /api/v1/regions/:id.json
Fetch information for a single region

Returns detail about a single region

Params

Param name Description
id
required

ID of the Region you want to see details about

Validations:

  • Must be a String


POST /api/v1/regions/suggest.json
Suggest a new region to add to the map

This doesn't actually create a new region, it just sends region information to pdx admins

Supported Formats

json

Params

Param name Description
region_name
required

Region name

Validations:

  • Must be a String

comments
optional

Things we should know about this region

Validations:

  • Must be a String


POST /api/v1/regions/contact.json
Contact regional administrator

Send a message to the admins for a region

Supported Formats

json

Params

Param name Description
region_id
required

ID of the region to send a message to

Validations:

  • Must be a Integer

message
required

Message to admins

Validations:

  • Must be a String

name
optional

Sender's name

Validations:

  • Must be a String

email
optional

Sender's email address

Validations:

  • Must be a String


POST /api/v1/regions/app_comment.json
Send comments about the app

Send a message to app maintainers about the app

Supported Formats

json

Params

Param name Description
region_id
required

ID of the region to send a message to

Validations:

  • Must be a Integer

os
required

OS Type

Validations:

  • Must be a String

os_version
required

OS Version

Validations:

  • Must be a String

device_type
required

Device Type

Validations:

  • Must be a String

app_version
required

App version

Validations:

  • Must be a String

email
required

Your email address

Validations:

  • Must be a String

name
optional

Your name

Validations:

  • Must be a String

message
required

Message to app maintainer

Validations:

  • Must be a String