recdotgov-client

recdotgov_client.OrganizationsApi

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

Method	HTTP request	Description
get_organization	GET /organizations/{orgId}	Retrieve a specific organization by id
get_organizations	GET /organizations	Retrieve all organizations

get_organization

list[Organization] get_organization(org_id)

Retrieve a specific organization by id

This endpoint retrieves a specific organization.

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.OrganizationsApi(recdotgov_client.ApiClient(configuration))
org_id = 'org_id_example' # str | Id of the organization

try:
    # Retrieve a specific organization by id
    api_response = api_instance.get_organization(org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->get_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str	Id of the organization

Return type

list[Organization]

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_organizations

InlineResponse200 get_organizations(query=query, limit=limit, offset=offset)

Retrieve all organizations

This endpoint retrieves all organizations.

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.OrganizationsApi(recdotgov_client.ApiClient(configuration))
query = 'query_example' # str | Query filter criteria, searches on organization name and organization abbreviated name (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 organizations
    api_response = api_instance.get_organizations(query=query, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->get_organizations: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	Query filter criteria, searches on organization name and organization abbreviated name	[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

InlineResponse200

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.