uclouvain / osis-attribution-sdk

SDK package for attribution api communication

openapi-client

A set of API endpoints that allow you to get information about attribution

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.00
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dev.osis.uclouvain.be/api/v1/attribution
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://dev.osis.uclouvain.be/api/v1/attribution"
)

# 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: Token
configuration.api_key['Token'] = 'YOUR_API_KEY'

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.ApplicationApi(api_client)
    
    try:
        api_response = api_instance.applicationcoursescalendars_list()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApplicationApi->applicationcoursescalendars_list: %s\n" % e)
    

Documentation for API Endpoints

All URIs are relative to https://dev.osis.uclouvain.be/api/v1/attribution

Class	Method	HTTP request	Description
ApplicationApi	applicationcoursescalendars_list	GET /application/calendars

Documentation For Models

• ApplicationCourseCalendar
• Error

Documentation For Authorization

Token

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author