Regions

>>>

GET /api/v1/regions/location_and_machine_counts.json
Get location and machine counts

Get location and machine counts

Supported Formats

json

Params

Param name Description
region_name
optional

region_name to limit counts to

Validations:

  • Must be a String
>>>

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/contact.json
Contact regional administrator

Send a message to the admins for a region

Supported Formats

json

Params

Param name Description
message
required

Message to admins

Validations:

  • Must be a String
region_id
optional

ID of the region to send a message to

Validations:

  • Must be a Integer
lat
optional

Latitude

Validations:

  • Must be a String
lon
optional

Longitude

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