School Grade

Get School Grade

GET - /schoolgrade/pk_school_grade/

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_school_grade`	path variables	string	None	No	Obtained in *List School Grade*

Response Body

200

application/json

{
    "results": {
        "pk_school_grade": 10,
        "name": "1-serie",
        "fk_school_level": 3,
        "school_level": "ensino medio"
    }
}

Schema

{
    "results": {
        "pk_school_grade": integer,
        "name": string,
        "fk_school_level": integer,
        "school_level": string
    }
}

400

Error 1

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

Schema

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

500

Error 1

    {
        "detail":  "Não foi possivel encontrar este SchoolGrade.",
        "error": "descrição do erro interno"
    }

Schema

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

List School Grade

GET - /schoolgrade/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
`level`	query param	string	None	Yes	Name of the subject to search

Response Body

200

application/json

{
    "navigation": {
        "next": "http://alppi/sys/api/v1/schoolgrade/list/?page=3&page_size=20", // link para proxima pagina
        "previous": "http://alppi/sys/api/v1/schoolgrade/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_school_grade": 1,
                "name": "1-ano",
                "fk_school_level": 1,
                "school_level": "ensino fundamental I"
            }
        ]
    }

Schema

{
    "navigation": {
        "next": string,
        "previous": string
    },
    "next": integer,
    "previous": integer,
    "count": integer,
    "results": array of objects {
        "pk_school_grade": integer,
        "name": string,
        "fk_school_level": integer,
        "school_level": string
    }
}

500

Error 1

    {
        "detail": "Problemas ao listar todos os SchoolGrade.",
        "error": "descrição do erro interno"
    }

Schema

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

Create School Grade

POST - /schoolgrade/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
`fk_school_level`	body	integer	None	No	Obtained in List School Level

Request Body

application/json

{
    "name": "create",
    "fk_school_level": 1
}

Body Schema

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

Response Body

200

application/json

{
    "results": {
        "pk_school_grade": 25,
        "name": "Create",
        "fk_school_level": 1,
        "school_level": "ensino fundamental I"
    }
}

Schema

{
    "results": {
        "pk_school_grade": integer,
        "name": string,
        "fk_school_level": integer,
        "school_level": string
    }
}

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

Update School Grade

PUT - /schoolgrade/pk_school_grade/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_school_grade`	path variables	string	None	No	Obtained in *List School Grade*

Request Body

application/json

{
    "name": "1-ano",
    "fk_school_level": 1
}

Schema

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

Response Body

200

application/json

{
    "results": {
        "pk_school_grade": 1,
        "name": "1-Ano",
        "fk_school_level": 1,
        "school_level": "ensino fundamental I"
    }
}

Schema

{
    "results": {
        "pk_school_grade": integer,
        "name": string,
        "fk_school_level": integer,
        "school_level": string
    }
}

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

Delete School Grade

DELL - /schoolgrade/pk_school_grade/delete/

Description

Rota para excluir uma Area do Conhecimento.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_school_grade`	path variables	string	None	No	Obtained in *List School Grade*

Response Body

204 No Content

400

Error 1

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

Schema

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

500

Error 1

    {
        "detail": "Não foi possivel encontrar este SchoolGrade.",
        "error": "descrição do erro interno"
    }

Schema

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