CitiesApi.md

oldp_client.CitiesApi

All URIs are relative to https://de.openlegaldata.io/api

Method	HTTP request	Description
cities_list	GET /cities/
cities_read	GET /cities/{id}/

cities_list

InlineResponse2005 cities_list(state_id=state_id, limit=limit, offset=offset)

Example

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

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

# create an instance of the API class
api_instance = oldp_client.CitiesApi(oldp_client.ApiClient(configuration))
state_id = 'state_id_example' # str |  (optional)
limit = 56 # int | Number of results to return per page. (optional)
offset = 56 # int | The initial index from which to return the results. (optional)

try:
    api_response = api_instance.cities_list(state_id=state_id, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CitiesApi->cities_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
state_id	str		[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]

Return type

InlineResponse2005

Authorization

api_key

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/xml

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

cities_read

City cities_read(id)

Example

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

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

# create an instance of the API class
api_instance = oldp_client.CitiesApi(oldp_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this city.

try:
    api_response = api_instance.cities_read(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CitiesApi->cities_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this city.

Return type

City

Authorization

api_key

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/xml

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