Skip to content

Latest commit

 

History

History
395 lines (304 loc) · 16.8 KB

AutocompleteApi.md

File metadata and controls

395 lines (304 loc) · 16.8 KB
Raw

osis_admission_sdk.AutocompleteApi

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

Method HTTP request Description
list_doctorat_dtos GET /autocomplete/sector/{sigle}/doctorates
list_persons GET /autocomplete/person
list_sector_dtos GET /autocomplete/sector
list_tutors GET /autocomplete/tutor

list_doctorat_dtos

[DoctoratDTO] list_doctorat_dtos(sigle)

Autocomplete doctorates given a sector

Example

  • Api Key Authentication (Token):
import time
import osis_admission_sdk
from osis_admission_sdk.api import autocomplete_api
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.doctorat_dto import DoctoratDTO
from osis_admission_sdk.model.accepted_language_enum import AcceptedLanguageEnum
from pprint import pprint
# 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)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.list_doctorat_dtos(sigle)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling AutocompleteApi->list_doctorat_dtos: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    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)

Parameters

Name Type Description Notes
sigle str
accept_language 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 str [optional]
x_user_last_name str [optional]
x_user_email str [optional]
x_user_global_id str [optional]

Return type

[DoctoratDTO]

Authorization

Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 Bad request -
401 Unauthorized -
404 The specified resource was not found -

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

list_persons

InlineResponse2001 list_persons(search)

Autocomplete person

Example

  • Api Key Authentication (Token):
import time
import osis_admission_sdk
from osis_admission_sdk.api import autocomplete_api
from osis_admission_sdk.model.inline_response2001 import InlineResponse2001
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.accepted_language_enum import AcceptedLanguageEnum
from pprint import pprint
# 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)
    search = "search_example" # str | The term to search the persons on
    limit = 1 # int | Number of results to return per page. (optional)
    offset = 1 # int | The initial index from which to return the results. (optional)
    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)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.list_persons(search)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling AutocompleteApi->list_persons: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.list_persons(search, limit=limit, offset=offset, 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_persons: %s\n" % e)

Parameters

Name Type Description Notes
search str The term to search the persons on
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]
accept_language 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 str [optional]
x_user_last_name str [optional]
x_user_email str [optional]
x_user_global_id str [optional]

Return type

InlineResponse2001

Authorization

Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 Bad request -
401 Unauthorized -
404 The specified resource was not found -

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

list_sector_dtos

[SectorDTO] list_sector_dtos()

Autocomplete sectors

Example

  • Api Key Authentication (Token):
import time
import osis_admission_sdk
from osis_admission_sdk.api import autocomplete_api
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.accepted_language_enum import AcceptedLanguageEnum
from osis_admission_sdk.model.sector_dto import SectorDTO
from pprint import pprint
# 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)
    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)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.list_sector_dtos(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_sector_dtos: %s\n" % e)

Parameters

Name Type Description Notes
accept_language 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 str [optional]
x_user_last_name str [optional]
x_user_email str [optional]
x_user_global_id str [optional]

Return type

[SectorDTO]

Authorization

Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 Bad request -
401 Unauthorized -
404 The specified resource was not found -

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

list_tutors

InlineResponse200 list_tutors(search)

Autocomplete tutors

Example

  • Api Key Authentication (Token):
import time
import osis_admission_sdk
from osis_admission_sdk.api import autocomplete_api
from osis_admission_sdk.model.inline_response200 import InlineResponse200
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.accepted_language_enum import AcceptedLanguageEnum
from pprint import pprint
# 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)
    search = "search_example" # str | The term to search the persons on
    limit = 1 # int | Number of results to return per page. (optional)
    offset = 1 # int | The initial index from which to return the results. (optional)
    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)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.list_tutors(search)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling AutocompleteApi->list_tutors: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.list_tutors(search, limit=limit, offset=offset, 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_tutors: %s\n" % e)

Parameters

Name Type Description Notes
search str The term to search the persons on
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]
accept_language 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 str [optional]
x_user_last_name str [optional]
x_user_email str [optional]
x_user_global_id str [optional]

Return type

InlineResponse200

Authorization

Token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 Bad request -
401 Unauthorized -
404 The specified resource was not found -

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