recdotgov-client

recdotgov_client.ZonesApi

All URIs are relative to https://ridb.recreation.gov/api/v1

Method HTTP request Description
get_permit_entrance_zone GET /permitentrances/{permitEntranceId}/zones/{zoneId} Retrieve a zone for a permit entrance
get_permit_entrance_zones GET /permitentrances/{permitEntranceId}/zones Retrieve all zones for a permit entrance

get_permit_entrance_zone

Zone get_permit_entrance_zone(permit_entrance_id, zone_id)

Retrieve a zone for a permit entrance

This endpoint retrieves a specific zone for a specific permit entrance.

Example

from __future__ import print_function
import time
import recdotgov_client
from recdotgov_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# create an instance of the API class
api_instance = recdotgov_client.ZonesApi(recdotgov_client.ApiClient(configuration))
permit_entrance_id = 'permit_entrance_id_example' # str | Id of the permit entrance
zone_id = 'zone_id_example' # str | Id of the zone

try:
    # Retrieve a zone for a permit entrance
    api_response = api_instance.get_permit_entrance_zone(permit_entrance_id, zone_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZonesApi->get_permit_entrance_zone: %s\n" % e)

Parameters

Name Type Description Notes
permit_entrance_id str Id of the permit entrance  
zone_id str Id of the zone  

Return type

Zone

Authorization

Apikey

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_permit_entrance_zones

InlineResponse20010 get_permit_entrance_zones(permit_entrance_id)

Retrieve all zones for a permit entrance

This endpoint retrieves all zones for a specific permit entrance.

Example

from __future__ import print_function
import time
import recdotgov_client
from recdotgov_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = recdotgov_client.Configuration()
configuration.api_key['apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# create an instance of the API class
api_instance = recdotgov_client.ZonesApi(recdotgov_client.ApiClient(configuration))
permit_entrance_id = 'permit_entrance_id_example' # str | Id of the permit entrance

try:
    # Retrieve all zones for a permit entrance
    api_response = api_instance.get_permit_entrance_zones(permit_entrance_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZonesApi->get_permit_entrance_zones: %s\n" % e)

Parameters

Name Type Description Notes
permit_entrance_id str Id of the permit entrance  

Return type

InlineResponse20010

Authorization

Apikey

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]