Campus

Get Campus

---

GET - /campus/pk_campus/

Description

Description

Captura as informações detalhadas em do campus.

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

    {
        "results": {
            "pk_campus": 1,
            "cnpj": "02353336035",
            "campus_code": 1,
            "campus_name": "Atitus Educação Passo Fundo",
            "trading_name": "Atitus Educação",
            "company_name": "Atitus Educação",
            "public_place": "Av. brasil",
            "fk_city": 4911,
            "city_name": "Passo Fundo",
            "fk_fu": 23,
            "fu_name": "Rio Grande do Sul",
            "email": "atitus.passofundo@atitus.com",
            "phone": "54992358847",
            "created": "2024-05-27T23:13:43",
            "edited": "2024-05-27T23:13:43",
            "status": 1
        }
    }

Schema

    {
        "results": {
            "pk_campus": integer,
            "cnpj": string,
            "campus_code": integer,
            "campus_name": string,
            "trading_name": string,
            "company_name": string,
            "public_place": string,
            "fk_city": integer,
            "city_name": string,
            "fk_fu": integer,
            "fu_name": string,
            "email": string,
            "phone": string,
            "created": string,
            "edited": string,
            "status": integer
        }
    }

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

---

List Campus

GET - /campus/list/

Description

Description

Lista todos os campus 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/campus/list/?page=3&page_size=20", // link para proxima pagina
        "previous": "http://alppi/sys/api/v1/campus/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_campus": 1,
            "cnpj": "02353336035",
            "campus_code": 1,
            "campus_name": "Atitus Educação Passo Fundo",
            "trading_name": "Atitus Educação",
            "company_name": "Atitus Educação",
            "public_place": "Av. brasil",
            "fk_city": 4911,
            "city_name": "Passo Fundo",
            "fk_fu": 23,
            "fu_name": "Rio Grande do Sul",
            "email": "atitus.passofundo@atitus.com",
            "phone": "54992358847",
            "created": "2024-05-27T23:13:43",
            "edited": "2024-05-27T23:13:43",
            "status": 1
        }
    ]
}

Schema

{
    "navigation": {
        "next": string
        "previous": string
    },
    "next": integer
    "previous": integer
    "count": integer
    "results": [
        {
            "pk_campus": integer,
            "cnpj": string,
            "campus_code":integer,
            "campus_name": string,
            "trading_name": string,
            "company_name": string,
            "public_place": string,
            "fk_city": integer,
            "city_name": string,
            "fk_fu": integer,
            "fu_name": string,
            "email": string,
            "phone": string,
            "created": string,
            "edited": string",
            "status": integer
        }
    ]
}

400

Error 1

    {
        "detail":  "Não foi possivel encontrar todos os Campus."
    }

Schema

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

500

Error 1

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

Schema

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

---

Create Campus

POST - /campus/create/

Description

Description

Rota para criação de um novo campus.

Name	In	Type	Default	Nullable	Description
Authorization	header	string	None	No	Obtained in Login
fk_city	body	integer	None	No	Obtained in List City
fk_fu	body	integer	None	No	Obtained in List City

Request Body

application/json

{
    "cnpj": "02353336035",
    "campus_code": 1,
    "campus_name": "Atitus Educação Passo Fundo",
    "trading_name": "Atitus Educação",
    "company_name": "Atitus Educação",
    "public_place": "Av. brasil",
    "fk_city": 4911,
    "fk_fu": 23,
    "email": "atitus.passofundo@atitus.com",
    "phone": "54992358847"
}

Body Schema

{
    "cnpj": string,
    "campus_code": integer,
    "campus_name": string,
    "trading_name": string,
    "company_name": string,
    "public_place": string,
    "fk_city": integer,
    "fk_fu": integer,
    "email": string,
    "phone": string
}

Response Body

200

application/json

{
    "results": {
        "pk_campus": 2,
        "cnpj": "02353336035",
        "campus_code": 2,
        "campus_name": "Atitus Educação Passo Fundo",
        "trading_name": "Atitus Educação",
        "company_name": "Atitus Educação",
        "public_place": "Av. brasil",
        "fk_city": 4911,
        "city_name": "Passo Fundo",
        "fk_fu": 23,
        "fu_name": "Rio Grande do Sul",
        "email": "atitus.passofundo@atitus.com",
        "phone": "54992358847",
        "created": "2024-07-23T17:49:24",
        "edited": "2024-07-23T17:49:22",
        "status": 1
    }
}

Schema

{
    "results": {
        "pk_campus": integer,
        "cnpj": string,
        "campus_code": integer,
        "campus_name": string,
        "trading_name": string,
        "company_name": string,
        "public_place": string,
        "fk_city": integer,
        "city_name": string,
        "fk_fu": integer,
        "fu_name": string,
        "email": string,
        "phone": string,
        "created": string,
        "edited": string,
        "status": integer
    }
}

400

Error 1Error 2

    {
        "detail": "CNPJ-CPF invalido",
        "render": 1
    }

Schema

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

    {
        "detail": {
            "campus_code": [
                "campus with this campus code already exists."
            ]
        },
        "render": 0
    }

Schema

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

500

Error 1

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

Schema

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

---

Update Campus

PUT - /campus/pk_campus/update/

Description

Description

Rota para a atualização dos dados de um campus.

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
fk_city	body	integer	None	No	Obtained in List City
fk_fu	body	integer	None	No	Obtained in List City

Request Body

application/json

{
    "cnpj": "02353336035",
    "campus_code": 1,
    "campus_name": "Atitus Educação Passo Fundo update",
    "trading_name": "Atitus Educação",
    "company_name": "Atitus Educação",
    "public_place": "Av. brasil",
    "fk_city": 4911,
    "fk_fu": 23,
    "email": "atitus.passofundo@atitus.com",
    "phone": "54992358847",
    "status": 1
}

Body Schema

{
    "cnpj": string,
    "campus_code": integer,
    "campus_name": string,
    "trading_name": string,
    "company_name": string,
    "public_place": string,
    "fk_city": integer,
    "fk_fu": integer,
    "email": string,
    "phone": string,
    "status": integer
}

Response Body

200

application/json

{
    "results": {
        "pk_campus": 2,
        "cnpj": "02353336035",
        "campus_code": 2,
        "campus_name": "Atitus Educação Passo Fundo update",
        "trading_name": "Atitus Educação",
        "company_name": "Atitus Educação",
        "public_place": "Av. brasil",
        "fk_city": 4911,
        "city_name": "Passo Fundo",
        "fk_fu": 23,
        "fu_name": "Rio Grande do Sul",
        "email": "atitus.passofundo@atitus.com",
        "phone": "54992358847",
        "created": "2024-07-23T17:49:24",
        "edited": "2024-07-23T18:04:17",
        "status": 1
    }
}

Schema

{
    "results": {
        "pk_campus": integer,
        "cnpj": string,
        "campus_code": integer,
        "campus_name": string,
        "trading_name": string,
        "company_name": string,
        "public_place": string,
        "fk_city": integer,
        "city_name": string,
        "fk_fu": integer,
        "fu_name": string,
        "email": string,
        "phone": string,
        "created": string,
        "edited": string,
        "status": integer
    }
}

400

Error 1Error 2Error 3

    {
        "detail": "Não foi possivel encontrar todos os Campus.",
        "render": 1
    }

Schema

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

    {
        "detail": "CNPJ-CPF invalido",
        "render": 1
    }

Schema

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

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

Schema

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

500

Error 1

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

Schema

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

---

Change Status Campus

PUT - /campus/pk_campus/changestatus/

Description

Description

Rota para a atualização de status de um campus.

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

Request Body

application/json

{
    "status": 0
}

Body Schema

{
    "status": integer
}

Response Body

200

application/json

{
    "results": "Status do campus atualizado com sucesso."
}

Schema

{
    "results": string
}

400

Error 1

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

Schema

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

500

Error 1

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

Schema

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

---

Delete Campus

DELL - /campus/pk_campus/delete/

Description

Description

Roda para excluir um campus específico.

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

{
    "results": "Campus deletado com sucesso."
}

Schema

{
    "results": "Campus deletado com sucesso."
}

400

Error 1

    {
        "detail": "Não foi possivel encontrar todos os Campus.",
        "render": 1
    }

Schema

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

500

Error 1

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

Schema

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

---