Skip to content

uclouvain/osis-internship-sdk

Repository files navigation

osis_internship_sdk

This API delivers data for the Internship project.

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

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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_internship_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_internship_sdk

Getting Started

Please follow the installation procedure and then run the following:

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

# Configure API key authorization: Token
configuration = osis_internship_sdk.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = osis_internship_sdk.DefaultApi(osis_internship_sdk.ApiClient(configuration))

try:
    api_response = api_instance.cohorts_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->cohorts_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
DefaultApi cohorts_get GET /cohorts
DefaultApi cohorts_uuid_get GET /cohorts/{uuid}
DefaultApi internships_get GET /internships
DefaultApi internships_uuid_get GET /internships/{uuid}
DefaultApi masters_allocations_uuid_get GET /masters_allocations/{uuid}
DefaultApi masters_get GET /masters
DefaultApi masters_uuid_activate_account_put PUT /masters/{uuid}/activate_account/
DefaultApi masters_uuid_allocations_get GET /masters/{uuid}/allocations/
DefaultApi masters_uuid_get GET /masters/{uuid}
DefaultApi organizations_get GET /organizations
DefaultApi organizations_uuid_get GET /organizations/{uuid}
DefaultApi periods_get GET /periods
DefaultApi periods_uuid_get GET /periods/{uuid}
DefaultApi scores_student_uuid_period_uuid_get GET /scores/{student_uuid}/{period_uuid}
DefaultApi scores_student_uuid_period_uuid_put PUT /scores/{student_uuid}/{period_uuid}
DefaultApi specialties_get GET /specialties
DefaultApi specialties_uuid_get GET /specialties/{uuid}
DefaultApi students_affectations_specialty_organization_get GET /students_affectations/{specialty}/{organization}
DefaultApi students_affectations_uuid_get GET /students_affectations/{uuid}
DefaultApi students_get GET /students
DefaultApi students_uuid_get GET /students/{uuid}

Documentation For Models

Documentation For Authorization

Token

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

Author

About

SDK package for internship api communication

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages