Campus Settings

Get Campus Settings

GET - /campussettings/pk_campus/

Description

Captura as informações detalhadas em do campus settings

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_campus`	path variables	string	None	No	Obtained in *List Campus*

Response Body

200

application/json

    {
        "pk_campus_settings": 1,
        "smpt_host": "smtp.gmail.com",
        "smpt_port": "587",
        "email_user": "patrick.berlatto@gmail.com",
        "email_password": "!8A0kXhtgNPeTw#",
        "use_tls": true,
        "email_auth_credentials": null
    }

Schema

    {
        "pk_campus_settings": integer,
        "smpt_host": string,
        "smpt_port": string,
        "email_user": string,
        "email_password": string,
        "use_tls": boolean,
        "email_auth_credentials": string | null
    }

400

Error 1Error 2

    {
        "detail": "Não foi possivel encontrar este CampusSettings.",
        "render": 0
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": {
            "smpt_host": [
                "This field is required."
            ]
        },
        "render": 0|
    }

Schema

    {
        "detail": object,
        "render": integer
    }

500

Error 1

    {
        "detail": "Problemas ao visualizar CampusSettings",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string
        "error": string
    }

Update Campus Settings

PUT - /campussettings/pk_campus/update/

Description

Rota para a atualização de senha padrão da instituição

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_campus`	path variables	string	None	No	Obtained in *List Campus Settings*

Request Body

application/json

{
    "email_password": "Senha_do_email",
    "email_user": "email@gmail.com",
    "smpt_host": "smtp.gmail.com",
    "smpt_port": "587",
    "use_tls": true
}

Body Schema

{
    "email_password": string,
    "email_user": string,
    "smpt_host": string,
    "smpt_port": string,
    "use_tls": boolean
}

Response Body

200

application/json

Schema

400

Error 1Error 2

    {
        "detail": "Não foi possivel encontrar este CampusSettings.",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": {
            "password": [
                "This field is required."
            ]
        },
        "render": 0|
    }

Schema

    {
        "detail": object,
        "render": integer
    }

500

Error 1

    {
        "detail": "Problemas ao editar CampusSettings",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string
        "error": string
    }

Change Passwrod Campus Settings

PUT - /campussettings/change-password/

Description

Rota para mudar senha padrão do campus.

É mudado a senha do campus do usuario logado.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login

Request Body

application/json

{
    "old_password" : "EscolaTiradentes@2025",
    "new_password": "Teste@2025"
}

Body Schema

{
    "old_password" : string,
    "new_password": string
}

Response Body

200

application/json

{
    "results": "Senha atualizada com sucesso."
}

Schema

{
    "results": string
}

400

Error 1Error 2

    {
        "detail": "Não foi possível encontrar este Campus.",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

    {
        "detail": "Senha atual incorreta.",
        "render": 1
    }

Schema

    {
        "detail": string,
        "render": integer
    }

500

Error 1

    {
        "detail": "Problemas ao mudar senha do Campus",
        "error": "descrição do erro interno"
    }

Schema

    {
        "detail": string,
        "error": string
    }