osis_admission_sdk

This API delivers data for the Admission project.

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

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/uclouvain/osis

Requirements.

Python >= 3.6

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 osis_admission_sdk

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 osis_admission_sdk

Getting Started

Please follow the installation procedure and then run the following:

import time
import osis_admission_sdk
from pprint import pprint
from osis_admission_sdk.api import autocomplete_api
from osis_admission_sdk.model.accepted_language_enum import AcceptedLanguageEnum
from osis_admission_sdk.model.doctorat_dto import DoctoratDTO
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.inline_response200 import InlineResponse200
from osis_admission_sdk.model.inline_response2001 import InlineResponse2001
from osis_admission_sdk.model.sector_dto import SectorDTO
# Defining the host is optional and defaults to https://dev.osis.uclouvain.be/api/v1/admission
# See configuration.py for a list of all supported configuration parameters.
configuration = osis_admission_sdk.Configuration(
    host = "https://dev.osis.uclouvain.be/api/v1/admission"
)

# 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 osis_admission_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = autocomplete_api.AutocompleteApi(api_client)
    sigle = "sigle_example" # str | 
accept_language = AcceptedLanguageEnum("en") # AcceptedLanguageEnum | The header advertises which languages the client is able to understand, and which locale variant is preferred. (By languages, we mean natural languages, such as English, and not programming languages.) (optional)
x_user_first_name = "X-User-FirstName_example" # str |  (optional)
x_user_last_name = "X-User-LastName_example" # str |  (optional)
x_user_email = "X-User-Email_example" # str |  (optional)
x_user_global_id = "X-User-GlobalID_example" # str |  (optional)

    try:
        api_response = api_instance.list_doctorat_dtos(sigle, accept_language=accept_language, x_user_first_name=x_user_first_name, x_user_last_name=x_user_last_name, x_user_email=x_user_email, x_user_global_id=x_user_global_id)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling AutocompleteApi->list_doctorat_dtos: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request
AutocompleteApi	list_doctorat_dtos	GET /autocomplete/sector/{sigle}/doctorates
AutocompleteApi	list_persons	GET /autocomplete/person
AutocompleteApi	list_sector_dtos	GET /autocomplete/sector
AutocompleteApi	list_tutors	GET /autocomplete/tutor
PropositionsApi	create_proposition	POST /propositions
PropositionsApi	list_propositions	GET /propositions
PropositionsApi	retrieve_cotutelle	GET /propositions/{uuid}/cotutelle
PropositionsApi	retrieve_proposition	GET /propositions/{uuid}
PropositionsApi	retrieve_supervision	GET /propositions/{uuid}/supervision
PropositionsApi	update_cotutelle	PUT /propositions/{uuid}/cotutelle
PropositionsApi	update_proposition	PUT /propositions/{uuid}
PropositionsApi	update_supervision	PUT /propositions/{uuid}/supervision

Documentation For Models

Documentation For Authorization

Token

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

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in osis_admission_sdk.apis and osis_admission_sdk.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

from osis_admission_sdk.api.default_api import DefaultApi
from osis_admission_sdk.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import osis_admission_sdk
from osis_admission_sdk.apis import *
from osis_admission_sdk.models import *

isabella232 / osis-admission-sdk Goto Github PK