Subejct Area

Get Subejct Area

GET - /subjectarea/pk_subject_area/

Description

Captura as informações detalhadas de uma Area do Conhecimento específica.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_subject_area`	path variables	string	None	No	Obtained in *List Subejct Area*

Response Body

200

application/json

{
    "results": {
        "pk_subject_area": 2,
        "fk_campus": 1,
        "campus_name": "Atitus Educação Passo Fundo",
        "name": "Ciências da Natureza",
        "created": "2024-06-01T15:44:46",
        "edited": "2024-06-01T15:44:46",
        "status": 1
    }
}

Schema

{
    "results": {
        "pk_subject_area": integer,
        "fk_campus": integer,
        "campus_name": string,
        "name": string,
        "created": string, // Data e hora no formato ISO 8601
        "edited": string, // Data e hora no formato ISO 8601
        "status": integer // 1-True / 0-False
    }
}

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

List Subejct Area

GET - /subjectarea/list/

Description

Lista todos as Area do Conhecimentos cadastrados no sistema

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`page`	query param	string	1	Yes
`page_size`	query param	string	30	Yes

Response Body

200

application/json

{
    "navigation": {
        "next": "http://alppi/sys/api/v1/subjectarea/list/?page=3&page_size=20", // link para proxima pagina
        "previous": "http://alppi/sys/api/v1/subjectarea/list/?page=1&page_size=10" // link para pagina anterior
    },
    "next": 3, // numero da proxima pagina
    "previous": 1, // numero na pagina anterior
    "count": 1, // quantidade encontrata
    "results": [
            {
                "pk_subject_area": 5,
                "name": "Ciências da Exatas",
                "status": 1
            },
        ]
    }

Schema

{
    "navigation": {
        "next": string,
        "previous": string
    },
    "next": integer,
    "previous": integer,
    "count": integer,
    "results": array of objects {
        "pk_subject_area": integer,
        "name": string,
        "status": integer // 1-True / 0-False
    }
}

500

Error 1

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

Schema

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

Create Subejct Area

POST - /subjectarea/create/

Description

Rota para criação de uma nova Area do Conhecimento.

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

Request Body

application/json

{
    "name": "Ciências da Exatas"
}

Body Schema

{
    "name": string
}

Response Body

200

application/json

{
    "results": {
        "pk_subject_area": 5,
        "fk_campus": 1,
        "campus_name": "Atitus Educação Passo Fundo",
        "name": "Ciências da Exatas",
        "created": "2024-08-12T21:40:52",
        "edited": "2024-08-12T21:40:52",
        "status": 1
    }
}

Schema

{
    "results": {
        "pk_subject_area": integer,
        "fk_campus": integer,
        "campus_name": string,
        "name": string,
        "created": string,
        "edited": string,
        "status": integer // 1-True / 0-False
    }
}

400

Error 1

{
    "detail": "Informe o nome da Area do Conhecimento",
    "render": 1
}

Schema

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

500

Error 1

    {
        "detail": "Problemas ao cadastrar Subject Area",
        "error": "descrição do erro interno"
    }

Schema

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

Update Subejct Area

PUT - /subjectarea/pk_subject_area/update/

Description

Rota para a atualização dos dados de uma Area do Conhecimento.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_subject_area`	path variables	string	None	No	Obtained in *List Subejct Area*

Request Body

application/json

{
    "name": "linGuaGens de update",
    "status": 1
}

Schema

{
    "name": string,
    "status": integer
}

Response Body

200

application/json

{
    "results": {
        "pk_subject_area": 6,
        "fk_campus": 1,
        "campus_name": "Atitus Educação Passo Fundo",
        "name": "Linguagens de Update",
        "created": "2024-08-12T22:10:14",
        "edited": "2024-08-12T22:15:27",
        "status": 0
    }
}

Schema

{
    "results": {
        "pk_subject_area": integer,
        "fk_campus": integer,
        "campus_name": string,
        "name": string,
        "created": string,
        "edited": string,
        "status": integer // 1-True / 0-False
    }
}

400

Error 1Error 2

{
    "detail": "Informe o nome da Area do Conhecimento",
    "render": 1
}

Schema

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

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

Schema

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

500

Error 1

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

Schema

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

Change Status Subejct Area

PUT - /subjectarea/pk_subject_area/changestatus/

Description

Rota para a atualização de status de uma Area do Conhecimento.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_subject_area`	path variables	string	None	No	Obtained in *List Subejct Area*

Request Body

application/json

{
    "status": 1 // 1 ou 0
}

Body Schema

{
    "status": integer
}

Response Body

200

application/json

{
    "results": "Area do conhecimento atualizado com sucesso."
}

Schema

{
    "results": string
}

400

Error 1

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

Schema

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

500

Error 1

    {
        "detail": "Problemas ao alterar status do subject_area",
        "error": "descrição do erro interno"
    }

Schema

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

Delete Subejct Area

DELL - /subjectarea/pk_subject_area/delete/

Description

Rota para excluir uma Area do Conhecimento.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_subject_area`	path variables	string	None	No	Obtained in *List Subejct Area*

Response Body

204 No Content

400

Error 1

    {
        "detail":  "Não foi possivel encontrar este SubjectArea."
    }

Schema

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

500

Error 1

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

Schema

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