recdotgov-client

recdotgov_client.EventsApi

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

Method	HTTP request	Description
get_event	GET /events/{eventId}	Retrieve a specific event by id
get_events	GET /events	Retrieve all events
get_facility_event	GET /facilities/{facilityId}/events/{eventId}	Retrieve a specific event by id for a facility
get_facility_events	GET /facilities/{facilityId}/events	Retrieve all events for a facility
get_rec_area_event	GET /recareas/{recAreaId}/events/{eventId}	Retrieve a specific event by id for a RecArea
get_rec_area_events	GET /recareas/{recAreaId}/events	Retrieve all events for a RecArea

get_event

Event get_event(event_id)

Retrieve a specific event by id

This endpoint retrieves a specific event.

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.EventsApi(recdotgov_client.ApiClient(configuration))
event_id = 'event_id_example' # str | Id of the event

try:
    # Retrieve a specific event by id
    api_response = api_instance.get_event(event_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->get_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_id	str	Id of the event

Return type

Event

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_events

InlineResponse20011 get_events(query=query, limit=limit, offset=offset)

Retrieve all events

This endpoint retrieves all events.

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.EventsApi(recdotgov_client.ApiClient(configuration))
query = 'query_example' # str | Query filter criteria. Searches on event name, start/end date, description, age group, ADA access, fee description, scope description, and type description (optional)
limit = 50 # int | Number of records to return (max 50) (optional) (default to 50)
offset = 0 # int | Start record of overall result set (optional) (default to 0)

try:
    # Retrieve all events
    api_response = api_instance.get_events(query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->get_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query filter criteria. Searches on event name, start/end date, description, age group, ADA access, fee description, scope description, and type description	[optional]
limit	int	Number of records to return (max 50)	[optional] [default to 50]
offset	int	Start record of overall result set	[optional] [default to 0]

Return type

InlineResponse20011

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_facility_event

Event get_facility_event(facility_id, event_id)

Retrieve a specific event by id for a facility

This endpoint retrieves a specific event for a specific facility.

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.EventsApi(recdotgov_client.ApiClient(configuration))
facility_id = 'facility_id_example' # str | Id of the facility
event_id = 'event_id_example' # str | Id of the event

try:
    # Retrieve a specific event by id for a facility
    api_response = api_instance.get_facility_event(facility_id, event_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->get_facility_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
facility_id	str	Id of the facility
event_id	str	Id of the event

Return type

Event

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_facility_events

InlineResponse20011 get_facility_events(facility_id, query=query, limit=limit, offset=offset)

Retrieve all events for a facility

This endpoint retrieves all events for a specific facility.

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.EventsApi(recdotgov_client.ApiClient(configuration))
facility_id = 'facility_id_example' # str | Id of the facility
query = 'query_example' # str | Query filter criteria. Searches on event name, start/end date, description, age group, ADA access, fee description, scope description, and type description (optional)
limit = 50 # int | Number of records to return (max 50) (optional) (default to 50)
offset = 0 # int | Start record of overall result set (optional) (default to 0)

try:
    # Retrieve all events for a facility
    api_response = api_instance.get_facility_events(facility_id, query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->get_facility_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
facility_id	str	Id of the facility
query	str	Query filter criteria. Searches on event name, start/end date, description, age group, ADA access, fee description, scope description, and type description	[optional]
limit	int	Number of records to return (max 50)	[optional] [default to 50]
offset	int	Start record of overall result set	[optional] [default to 0]

Return type

InlineResponse20011

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_rec_area_event

Event get_rec_area_event(rec_area_id, event_id)

Retrieve a specific event by id for a RecArea

This endpoint retrieves a specific event for a specific RecArea.

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.EventsApi(recdotgov_client.ApiClient(configuration))
rec_area_id = 'rec_area_id_example' # str | Id of the RecArea
event_id = 'event_id_example' # str | Id of the event

try:
    # Retrieve a specific event by id for a RecArea
    api_response = api_instance.get_rec_area_event(rec_area_id, event_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->get_rec_area_event: %s\n" % e)

Parameters

Name	Type	Description	Notes
rec_area_id	str	Id of the RecArea
event_id	str	Id of the event

Return type

Event

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_rec_area_events

InlineResponse20011 get_rec_area_events(rec_area_id, query=query, limit=limit, offset=offset)

Retrieve all events for a RecArea

This endpoint retrieves all events for a specific RecArea.

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.EventsApi(recdotgov_client.ApiClient(configuration))
rec_area_id = 'rec_area_id_example' # str | Id of the RecArea
query = 'query_example' # str | Query filter criteria. Searches on event name, start/end date, description, age group, ADA access, fee description, scope description, and type description (optional)
limit = 50 # int | Number of records to return (max 50) (optional) (default to 50)
offset = 0 # int | Start record of overall result set (optional) (default to 0)

try:
    # Retrieve all events for a RecArea
    api_response = api_instance.get_rec_area_events(rec_area_id, query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->get_rec_area_events: %s\n" % e)

Parameters

Name	Type	Description	Notes
rec_area_id	str	Id of the RecArea
query	str	Query filter criteria. Searches on event name, start/end date, description, age group, ADA access, fee description, scope description, and type description	[optional]
limit	int	Number of records to return (max 50)	[optional] [default to 50]
offset	int	Start record of overall result set	[optional] [default to 0]

Return type

InlineResponse20011

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

This site is open source. Improve this page.