Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 3.61 KB

LandingPageApi.md

File metadata and controls

87 lines (60 loc) · 3.61 KB

unity_sps_ogc_processes_api_python_client.LandingPageApi

All URIs are relative to http://localhost

Method HTTP request Description
get_landing_page_get GET / Retrieve the OGC API landing page for this service.

get_landing_page_get

LandingPage get_landing_page_get(f=f)

Retrieve the OGC API landing page for this service.

Example

  • Bearer (JWT) Authentication (bearerAuth):
import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.models.landing_page import LandingPage
from unity_sps_ogc_processes_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unity_sps_ogc_processes_api_python_client.LandingPageApi(api_client)
    f = 'f_example' # str | The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are 'json' or 'html'. (optional)

    try:
        # Retrieve the OGC API landing page for this service.
        api_response = api_instance.get_landing_page_get(f=f)
        print("The response of LandingPageApi->get_landing_page_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LandingPageApi->get_landing_page_get: %s\n" % e)

Parameters

Name Type Description Notes
f str The format of the response. If no value is provided, the accept header is used to determine the format. Accepted values are 'json' or 'html'. [optional]

Return type

LandingPage

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The landing page provides links to the API definition (link relation `service-desc`, in this case path `/api`), to the Conformance declaration (path `/conformance`, link relation `http://www.opengis.net/def/rel/ogc/1.0/conformance`), and to other resources. -
406 Content negotiation failed. For example, the `Accept` header submitted in the request did not support any of the media types supported by the server for the requested resource. -
422 Validation Error -
500 A server error occurred. -

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