osis_admission_sdk.PropositionsApi

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

Method	HTTP request	Description
create_proposition	POST /propositions
list_propositions	GET /propositions
retrieve_cotutelle	GET /propositions/{uuid}/cotutelle
retrieve_proposition	GET /propositions/{uuid}
retrieve_supervision	GET /propositions/{uuid}/supervision
update_cotutelle	PUT /propositions/{uuid}/cotutelle
update_proposition	PUT /propositions/{uuid}
update_supervision	PUT /propositions/{uuid}/supervision

create_proposition

PropositionIdentityDTO create_proposition()

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.proposition_identity_dto import PropositionIdentityDTO
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.initier_proposition_command import InitierPropositionCommand
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 = propositions_api.PropositionsApi(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)
    initier_proposition_command = InitierPropositionCommand(
        type_admission=AdmissionType("ADMISSION"),
        sigle_formation="sigle_formation_example",
        annee_formation=1,
        matricule_candidat="matricule_candidat_example",
        justification="justification_example",
        bureau_cde=ChoixBureauCDE("ECONOMY"),
        type_financement="type_financement_example",
        type_contrat_travail="type_contrat_travail_example",
        eft=1,
        bourse_recherche="bourse_recherche_example",
        duree_prevue=1,
        temps_consacre=1,
        titre_projet="titre_projet_example",
        resume_projet="resume_projet_example",
        documents_projet=[
            "documents_projet_example",
        ],
        graphe_gantt=[],
        proposition_programme_doctoral=[],
        projet_formation_complementaire=[],
        langue_redaction_these=ChoixLangueRedactionThese("FRENCH"),
        doctorat_deja_realise=ChoixDoctoratDejaRealise("YES"),
        institution="institution_example",
        date_soutenance=dateutil_parser('1970-01-01').date(),
        raison_non_soutenue="raison_non_soutenue_example",
    ) # InitierPropositionCommand |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.create_proposition(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, initier_proposition_command=initier_proposition_command)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->create_proposition: %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]
initier_proposition_command	InitierPropositionCommand		[optional]

Return type

PropositionIdentityDTO

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-
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_propositions

[PropositionSearchDTO] list_propositions()

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.proposition_search_dto import PropositionSearchDTO
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 = propositions_api.PropositionsApi(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_propositions(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 PropositionsApi->list_propositions: %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

[PropositionSearchDTO]

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]

retrieve_cotutelle

CotutelleDTO retrieve_cotutelle(uuid)

Get the cotutelle of a proposition

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.cotutelle_dto import CotutelleDTO
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 = propositions_api.PropositionsApi(api_client)
    uuid = "uuid_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.retrieve_cotutelle(uuid)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->retrieve_cotutelle: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
uuid	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

CotutelleDTO

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]

retrieve_proposition

PropositionDTO retrieve_proposition(uuid)

Get a single proposition

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.proposition_dto import PropositionDTO
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 = propositions_api.PropositionsApi(api_client)
    uuid = "uuid_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.retrieve_proposition(uuid)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->retrieve_proposition: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
uuid	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

PropositionDTO

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]

retrieve_supervision

SupervisionDTO retrieve_supervision(uuid)

Get the supervision group of a proposition

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.supervision_dto import SupervisionDTO
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 = propositions_api.PropositionsApi(api_client)
    uuid = "uuid_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.retrieve_supervision(uuid)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->retrieve_supervision: %s\n" % e)

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

Parameters

Name	Type	Description	Notes
uuid	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

SupervisionDTO

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]

update_cotutelle

PropositionIdentityDTO update_cotutelle(uuid)

Set the cotutelle of a proposition

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.proposition_identity_dto import PropositionIdentityDTO
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.definir_cotutelle_command import DefinirCotutelleCommand
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 = propositions_api.PropositionsApi(api_client)
    uuid = "uuid_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)
    definir_cotutelle_command = DefinirCotutelleCommand(
        uuid_proposition="uuid_proposition_example",
        motivation="motivation_example",
        institution="institution_example",
        document_demande_ouverture=[
            "document_demande_ouverture_example",
        ],
    ) # DefinirCotutelleCommand |  (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.update_cotutelle(uuid, 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, definir_cotutelle_command=definir_cotutelle_command)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->update_cotutelle: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	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]
definir_cotutelle_command	DefinirCotutelleCommand		[optional]

Return type

PropositionIdentityDTO

Authorization

Token

HTTP request headers

Content-Type: application/json
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]

update_proposition

PropositionIdentityDTO update_proposition(uuid)

Edit a proposition

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.proposition_identity_dto import PropositionIdentityDTO
from osis_admission_sdk.model.completer_proposition_command import CompleterPropositionCommand
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 = propositions_api.PropositionsApi(api_client)
    uuid = "uuid_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)
    completer_proposition_command = CompleterPropositionCommand(
        uuid="uuid_example",
        type_admission=AdmissionType("ADMISSION"),
        justification="justification_example",
        bureau_cde=ChoixBureauCDE("ECONOMY"),
        type_financement="type_financement_example",
        type_contrat_travail="type_contrat_travail_example",
        eft=1,
        bourse_recherche="bourse_recherche_example",
        duree_prevue=1,
        temps_consacre=1,
        titre_projet="titre_projet_example",
        resume_projet="resume_projet_example",
        documents_projet=[
            "documents_projet_example",
        ],
        graphe_gantt=[],
        proposition_programme_doctoral=[],
        projet_formation_complementaire=[],
        langue_redaction_these=ChoixLangueRedactionThese("FRENCH"),
        doctorat_deja_realise=ChoixDoctoratDejaRealise("YES"),
        institution="institution_example",
        date_soutenance=dateutil_parser('1970-01-01').date(),
        raison_non_soutenue="raison_non_soutenue_example",
    ) # CompleterPropositionCommand |  (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.update_proposition(uuid, 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, completer_proposition_command=completer_proposition_command)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->update_proposition: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	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]
completer_proposition_command	CompleterPropositionCommand		[optional]

Return type

PropositionIdentityDTO

Authorization

Token

HTTP request headers

Content-Type: application/json
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]

update_supervision

PropositionIdentityDTO update_supervision(uuid)

Add a supervision group member for a proposition

Example

Api Key Authentication (Token):

import time
import osis_admission_sdk
from osis_admission_sdk.api import propositions_api
from osis_admission_sdk.model.proposition_identity_dto import PropositionIdentityDTO
from osis_admission_sdk.model.error import Error
from osis_admission_sdk.model.add_supervision_actor import AddSupervisionActor
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 = propositions_api.PropositionsApi(api_client)
    uuid = "uuid_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)
    add_supervision_actor = AddSupervisionActor(
        type=ActorType("MAIN_PROMOTER"),
        person="person_example",
    ) # AddSupervisionActor |  (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.update_supervision(uuid, 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, add_supervision_actor=add_supervision_actor)
        pprint(api_response)
    except osis_admission_sdk.ApiException as e:
        print("Exception when calling PropositionsApi->update_supervision: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	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]
add_supervision_actor	AddSupervisionActor		[optional]

Return type

PropositionIdentityDTO

Authorization

Token

HTTP request headers

Content-Type: application/json
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]

Files

PropositionsApi.md

Latest commit

History

PropositionsApi.md

File metadata and controls

osis_admission_sdk.PropositionsApi

create_proposition

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_propositions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_cotutelle

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_proposition

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_supervision

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_cotutelle

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_proposition

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_supervision

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details