Skip to content

Latest commit

 

History

History
110 lines (76 loc) · 3.24 KB

LocationsApi.md

File metadata and controls

110 lines (76 loc) · 3.24 KB

studio_ghibli_api_sdk.LocationsApi

All URIs are relative to https://ghibliapi.herokuapp.com

Method HTTP request Description
locations_get GET /locations Return all locations
locations_id_get GET /locations/{id} Location ID

locations_get

list[Locations] locations_get(fields=fields, limit=limit)

Return all locations

The Locations endpoint returns information about all of the Studio Ghibli locations. This broadly includes lands, countries, and places.

Example

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

# create an instance of the API class
api_instance = studio_ghibli_api_sdk.LocationsApi()
fields = 'fields_example' # str | comma-separated list of fields to include in the response (optional)
limit = 789 # int | amount of results (default 50) (maximum 250) (optional)

try:
    # Return all locations
    api_response = api_instance.locations_get(fields=fields, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->locations_get: %s\n" % e)

Parameters

Name Type Description Notes
fields str comma-separated list of fields to include in the response [optional]
limit int amount of results (default 50) (maximum 250) [optional]

Return type

list[Locations]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

locations_id_get

object locations_id_get(id, fields=fields)

Location ID

Returns an individual location.

Example

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

# create an instance of the API class
api_instance = studio_ghibli_api_sdk.LocationsApi()
id = '789' # str | location `id`
fields = 'fields_example' # str | comma-separated list of fields to include in the response (optional)

try:
    # Location ID
    api_response = api_instance.locations_id_get(id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->locations_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str location `id`
fields str comma-separated list of fields to include in the response [optional]

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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