Term (Unused)

Get Term

GET - /term/pk_term/

Description

Captura as informações detalhadas de uma Etapa específica.

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

Response Body

200

application/json

{
    "results": {
        "pk_term": 1,
        "fk_term_type": 1,
        "name": "1-bimestre",
        "term_type": "bimestre"
    }
}

Schema

{
    "results": {
        "pk_term": integer,
        "fk_term_type": integer,
        "name": string,
        "term_type": string
    }
}

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

List Term

GET - /term/list/

Description

Lista todos as Etapas cadastradas 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/term/list/?page=3&page_size=20", // link para proxima pagina
        "previous": "http://alppi/sys/api/v1/term/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_term_type": 1,
                "fk_term_type": 1,
                "name": "1-bimestre",
                "term_type": "bimestre"
            }
        ]
    }

Schema

{
    "navigation": {
        "next": string,
        "previous": string
    },
    "next": integer,
    "previous": integer,
    "count": integer,
    "results": array of objects {
        "pk_term_type": integer,
        "fk_term_type": integer,
        "name": string,
        "term_type": string
    }
}

500

Error 1

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

Schema

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

Create Term

POST - /term/create/

Description

Rota para criação de uma nova Etapa.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`fk_term_type`	body	integer	None	No	Obtained in List Term Type

Request Body

application/json

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

Body Schema

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

Response Body

200

application/json

{
    "results": {
        "pk_term": 10,
        "fk_term_type": 1,
        "name": "Create",
        "term_type": "bimestre"
    }
}

Schema

{
    "results": {
        "pk_term": integer,
        "fk_term_type": integer,
        "name": string,
        "term_type": string
    }
}

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

Update Term

PUT - /term/pk_term/update/

Description

Rota para a atualização dos dados de uma Etapa.

Name	In	Type	Default	Nullable	Description
`Authorization`	header	string	None	No	Obtained in Login
`pk_term`	path variables	string	None	No	Obtained in *List Term*
`fk_term_type`	body	integer	None	No	Obtained in List Term Type

Request Body

application/json

{
    "name": "update",
    "fk_term_type": 1
}

Schema

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

Response Body

200

application/json

{
    "results": {
        "pk_term": 10,
        "fk_term_type": 1,
        "name": "Update",
        "term_type": "bimestre"
    }
}

Schema

{
    "results": {
        "pk_term": integer,
        "fk_term_type": integer,
        "name": string,
        "term_type": string
    }
}

400

Error 1Error 2

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

Schema

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

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

Schema

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

500

Error 1

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

Schema

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

Delete Term

DELL - /term/pk_term/delete/

Description

Rota para excluir uma Etapa.

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

Response Body

204 No Content

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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