Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 2.84 KB

QRCodesApi.md

File metadata and controls

93 lines (64 loc) · 2.84 KB

eliona.api_client.QRCodesApi

All URIs are relative to https://name.eliona.io/v2

Method HTTP request Description
get_qr_code_by_asset_id GET /qr-codes/assets/{asset-id} QR code for assets

get_qr_code_by_asset_id

file_type get_qr_code_by_asset_id(asset_id)

QR code for assets

Generates QR code linking to an asset in the Eliona frontend.

Example

  • Api Key Authentication (ApiKeyAuth):
  • Bearer (JWT) Authentication (BearerAuth):
import time
import eliona.api_client
from eliona.api_client.api import qr_codes_api
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qr_codes_api.QRCodesApi(api_client)
    asset_id = 4711 # int | The id of the asset

    # example passing only required values which don't have defaults set
    try:
        # QR code for assets
        api_response = api_instance.get_qr_code_by_asset_id(asset_id)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling QRCodesApi->get_qr_code_by_asset_id: %s\n" % e)

Parameters

Name Type Description Notes
asset_id int The id of the asset

Return type

file_type

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/png

HTTP response details

Status code Description Response headers
200 Successfully returned QR code -
404 Asset with id not found -

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