recdotgov-client

recdotgov_client.MediaApi

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

Method HTTP request Description
get_all_facility_media GET /facilities/{facilityId}/media Retrieve all media for a facility
get_all_media GET /media Retrieve all media
get_all_rec_area_media GET /recareas/{recAreaId}/media Retrieve all media for a RecArea
get_facility_media GET /facilities/{facilityId}/media/{mediaId} Retrieve a specific media by id for a facility
get_media GET /media/{mediaId} Retrieve a specific media by id
get_rec_area_media GET /recareas/{recAreaId}/media/{mediaId} Retrieve a specific media by id for a RecArea

get_all_facility_media

InlineResponse20013 get_all_facility_media(facility_id, query=query, limit=limit, offset=offset)

Retrieve all media for a facility

This endpoint retrieves all media 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.MediaApi(recdotgov_client.ApiClient(configuration))
facility_id = 'facility_id_example' # str | Id of the facility
query = 'query_example' # str | Query filter criteria. Searches on title, subtitle, description, credits, and media type (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 media for a facility
    api_response = api_instance.get_all_facility_media(facility_id, query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->get_all_facility_media: %s\n" % e)

Parameters

Name Type Description Notes
facility_id str Id of the facility  
query str Query filter criteria. Searches on title, subtitle, description, credits, and media type [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

InlineResponse20013

Authorization

Apikey

HTTP request headers

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

get_all_media

InlineResponse20013 get_all_media(query=query, limit=limit, offset=offset)

Retrieve all media

This endpoint retrieves all media.

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.MediaApi(recdotgov_client.ApiClient(configuration))
query = 'query_example' # str | Query filter criteria. Searches on title, subtitle, description, credits, and media type (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 media
    api_response = api_instance.get_all_media(query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->get_all_media: %s\n" % e)

Parameters

Name Type Description Notes
query str Query filter criteria. Searches on title, subtitle, description, credits, and media type [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

InlineResponse20013

Authorization

Apikey

HTTP request headers

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

get_all_rec_area_media

InlineResponse20013 get_all_rec_area_media(rec_area_id, query=query, limit=limit, offset=offset)

Retrieve all media for a RecArea

This endpoint retrieves all media 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.MediaApi(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 title, subtitle, description, credits, and media type (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 media for a RecArea
    api_response = api_instance.get_all_rec_area_media(rec_area_id, query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->get_all_rec_area_media: %s\n" % e)

Parameters

Name Type Description Notes
rec_area_id str Id of the RecArea  
query str Query filter criteria. Searches on title, subtitle, description, credits, and media type [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

InlineResponse20013

Authorization

Apikey

HTTP request headers

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

get_facility_media

Media get_facility_media(facility_id, media_id)

Retrieve a specific media by id for a facility

This endpoint retrieves a specific media 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.MediaApi(recdotgov_client.ApiClient(configuration))
facility_id = 'facility_id_example' # str | Id of the facility
media_id = 'media_id_example' # str | Id of the media

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

Parameters

Name Type Description Notes
facility_id str Id of the facility  
media_id str Id of the media  

Return type

Media

Authorization

Apikey

HTTP request headers

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

get_media

Media get_media(media_id)

Retrieve a specific media by id

This endpoint retrieves a specific media.

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.MediaApi(recdotgov_client.ApiClient(configuration))
media_id = 'media_id_example' # str | Id of the media

try:
    # Retrieve a specific media by id
    api_response = api_instance.get_media(media_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MediaApi->get_media: %s\n" % e)

Parameters

Name Type Description Notes
media_id str Id of the media  

Return type

Media

Authorization

Apikey

HTTP request headers

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

get_rec_area_media

Media get_rec_area_media(rec_area_id, media_id)

Retrieve a specific media by id for a RecArea

This endpoint retrieves a specific media 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.MediaApi(recdotgov_client.ApiClient(configuration))
rec_area_id = 'rec_area_id_example' # str | Id of the RecArea
media_id = 'media_id_example' # str | Id of the media

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

Parameters

Name Type Description Notes
rec_area_id str Id of the RecArea  
media_id str Id of the media  

Return type

Media

Authorization

Apikey

HTTP request headers

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

This site is open source. Improve this page.