Documentação da API Minha UFCSPA

Postman collection → OpenAPI spec →

Introduction

Base URL: https://api.producao.minha.ufcspa.edu.br

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include a token header with the value "{YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can get your token by copying the token header in a request when you log in the application.

Academico

Planos de Ensino - Atividade Currículo Discente

Endpoint para gerenciar a Atividade Curricular do Discente

Index

GET

https://api.producao.minha.ufcspa.edu.br

/academico/atividade-curriculo-discente

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idVinculo

string

required

int Filtrar por id do vinculo. Obrigatorio.

codigoAtividade

integer

Filtrar por id do vinculo.

nomeAtividade

integer

Filtrar por id do vinculo.

estrutura

integer

Filtrar por id do vinculo.

ano

integer

Filtrar por id do vinculo.

periodo

integer

Filtrar por id do vinculo.

chTotal

boolean

Define se a listagem deve ser paginada. Padrão é true.

idSituacao

integer

Filtrar por situacao do discente na atividade.

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

orderByCodigoAtividade

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByNomeAtividade

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByEstrutura

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAno

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByPeriodo

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByChTotal

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacao

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/academico/atividade-curriculo-discente?idVinculo=" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Gerar PDF

Gera o pdf do plano de ensino

Show

GET

https://api.producao.minha.ufcspa.edu.br

/academico/planos-ensino/gerar-pdf/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id.

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/academico/planos-ensino/gerar-pdf/" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Situações de Atividade do Currículo

Endpoint para gerenciar o Vinculo Discente

Index

GET

https://api.producao.minha.ufcspa.edu.br

/academico/situacoes-atividade-curriculo

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idSituacoesAtividadeCurricular

integer

Filtrar por id da situação.

situacao

string

Filtrar por situação.

sigla

string

Filtrar por sigla da situação.

orderByIdSituacoesAtividadeCurricular

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacao

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySigla

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/academico/situacoes-atividade-curriculo" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Vinculo Discente

Endpoint para gerenciar o Vinculo Discente

Index

GET

https://api.producao.minha.ufcspa.edu.br

/academico/vinculo-discente

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

matricula

integer

Filtrar por id do vinculo.

vinculo

integer

Filtrar por id do vinculo.

nivelCurso

integer

Filtrar por id do vinculo.

anoIngresso

integer

Filtrar por id do vinculo.

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

orderByMatricula

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByVinculo

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByNivelCurso

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAnoIngresso

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacao

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByHabilitado

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/academico/vinculo-discente" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Almoxarifado de Químicos

API do almoxarifado de químicos

Aprova Movimentações

Endpoints para gerenciar as aprovações de movimentações

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/aprova-movimentacoes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se a resposta deve ser paginada. Padrão: falso.

itemsPerPage

integer

Quantidade de itens por página. Padrão: 10.

page

integer

Página na paginação.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/aprova-movimentacoes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/aprova-movimentacoes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do pedido de aprovação.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/aprova-movimentacoes/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/aprova-movimentacoes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

rejeitar

boolean

Rejeitar uma movimentação. Padrão é false.

Body Parameters

id_movimentacao

integer

required

Id da movimentacao.

Headers

Query Parameters

Body

{ "id_movimentacao": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/aprova-movimentacoes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_movimentacao\": null
}"

Materiais

Endpoints para gerenciar os materiais

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/materiais

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Optação da paginação.

Example:

true

page

integer

Página na paginação.

Example:

itemsPerPage

integer

Itens por paginação.

Example:

titulo

string

Titulo do material.

catmat

string

Catmat do material.

cas

string

Cas do material.

export

boolean

Define se o retorno deve ser um arquivo excel.

descricao

string

Descricao do material.

tipoControle

string

Filtrar pelo tipo de controle.

formatoPlanilha

string

Define o formato do arquivo a ser exportado. Podendo ser xlsx ou csv. Padrão é csv.

orderByTitulo

string

Coluna a ser ordenada.

Example:

asc

orderByCatmat

string

Coluna a ser ordenada. Example:

orderByUnidadeMedida

string

Coluna a ser ordenada. Example:

orderByCas

string

Coluna a ser ordenada. Example:

orderByEstadoFisico

string

Coluna a ser ordenada. Example:

orderByTipoDeControle

string

Coluna a ser ordenada. Example:

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/materiais?pagination=1&page=1&itemsPerPage=10&orderByTitulo=asc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/materiais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do material

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/materiais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/materiais

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

titulo

string

required

Example:

Álcool

catmat

string

Example:

348275

descricao

string

required

Example:

itaque

id_unidade_medida

integer

required

Example:

numero_cas

string

Example:

67-63-0

estado_fisico

char

required

Example:

id_tipo_controle

integer

Example:

fispq

string

Example:

dolor

link_fispq

string

Example:

est

riscos

object[]

criado_por

integer

required

Example:

alterado_por

integer

required

Example:

Headers

Body

{ "titulo": "\u00c1lcool", "catmat": "348275", "descricao": "itaque", "id_unidade_medida": 6, "numero_cas": "67-63-0", "estado_fisico": "L", "id_tipo_controle": 1, "fispq": "dolor", "link_fispq": "est", "riscos": [ { "id_classificacao_risco": 15 } ], "criado_por": 15, "alterado_por": 12 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/materiais" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"titulo\": \"Álcool\",
    \"catmat\": \"348275\",
    \"descricao\": \"itaque\",
    \"id_unidade_medida\": 6,
    \"numero_cas\": \"67-63-0\",
    \"estado_fisico\": \"L\",
    \"id_tipo_controle\": 1,
    \"fispq\": \"dolor\",
    \"link_fispq\": \"est\",
    \"riscos\": [
        {
            \"id_classificacao_risco\": 15
        }
    ],
    \"criado_por\": 15,
    \"alterado_por\": 12
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/materiais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do material

Example:

Body Parameters

titulo

string

required

Example:

Álcool

catmat

string

Example:

348275

descricao

string

required

Example:

voluptatem

id_unidade_medida

integer

required

Example:

numero_cas

string

Example:

67-63-0

estado_fisico

char

required

Example:

laudantium

id_tipo_controle

integer

Example:

fispq

string

Example:

recusandae

link_fispq

string

Example:

tempora

riscos

object[]

alterado_por

integer

required

Example:

Headers

URL Parameters

Body

{ "titulo": "\u00c1lcool", "catmat": "348275", "descricao": "voluptatem", "id_unidade_medida": 2, "numero_cas": "67-63-0", "estado_fisico": "laudantium", "id_tipo_controle": 9, "fispq": "recusandae", "link_fispq": "tempora", "riscos": [ { "id_classificacao_risco": 4 } ], "alterado_por": 19 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/materiais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"titulo\": \"Álcool\",
    \"catmat\": \"348275\",
    \"descricao\": \"voluptatem\",
    \"id_unidade_medida\": 2,
    \"numero_cas\": \"67-63-0\",
    \"estado_fisico\": \"laudantium\",
    \"id_tipo_controle\": 9,
    \"fispq\": \"recusandae\",
    \"link_fispq\": \"tempora\",
    \"riscos\": [
        {
            \"id_classificacao_risco\": 4
        }
    ],
    \"alterado_por\": 19
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/materiais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do material

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/materiais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Classificações de Risco

Endpoints para gerenciar as classificações de risco

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/classificacoes-risco

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se a resposta deve ser paginada. Padrão: falso.

itemsPerPage

integer

Quantidade de itens por página. Padrão: 10.

page

integer

Página na paginação.

orderByPictograma

string

Ordenar pelo pictograma.

orderByRisco

string

Ordenar pelo risco.

orderByDescricao

string

Ordernar pela descricao.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/classificacoes-risco" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/classificacoes-risco/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da classificação

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/classificacoes-risco/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/classificacoes-risco

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_icone_risco

integer

required

Example:

risco

string

required

Example:

facilis

descricao

string

Example:

odio

criado_por

integer

required

Example:

alterado_por

integer

required

Example:

Headers

Body

{ "id_icone_risco": 1, "risco": "facilis", "descricao": "odio", "criado_por": 6, "alterado_por": 11 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/classificacoes-risco" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_icone_risco\": 1,
    \"risco\": \"facilis\",
    \"descricao\": \"odio\",
    \"criado_por\": 6,
    \"alterado_por\": 11
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/classificacoes-risco/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da classificação

Example:

Body Parameters

id_icone_risco

integer

required

Example:

risco

string

required

Example:

commodi

descricao

string

Example:

est

criado_por

integer

required

Example:

alterado_por

integer

required

Example:

Headers

URL Parameters

Body

{ "id_icone_risco": 1, "risco": "commodi", "descricao": "est", "criado_por": 19, "alterado_por": 13 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/classificacoes-risco/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_icone_risco\": 1,
    \"risco\": \"commodi\",
    \"descricao\": \"est\",
    \"criado_por\": 19,
    \"alterado_por\": 13
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/classificacoes-risco/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da classificação

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/classificacoes-risco/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Empresas

Endpoints para gerenciar as empresas

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/empresas

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Incluí paginação na response. Padrão é false.

page

string

Determina a página na paginação..

nome

string

Filtrar por nome.

cnpj

string

Filtrar por CNPJ.

idTipoEmpresa

integer

Filtrar por pelo id do tipo de empresa.

orderByNome

string

Ordenar por nome. Valores: "asc", "desc".

orderByCnpj

string

Ordenar por CNPJ. Valores: "asc", "desc".

orderByTipo

string

Ordenar por tipo. Valores: "asc", "desc".

itemsPerPage

integer

Número de itens por página. Padrão é 10.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/empresas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/empresas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da empresa

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/empresas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/empresas

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

Example:

quis

cnpj

string

required

Example:

magni

id_tipo_empresa

integer

required

Example:

criado_por

integer

required

Example:

alterado_por

integer

required

Example:

Headers

Body

{ "nome": "quis", "cnpj": "magni", "id_tipo_empresa": 1, "criado_por": 1, "alterado_por": 12 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/empresas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": \"quis\",
    \"cnpj\": \"magni\",
    \"id_tipo_empresa\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 12
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/empresas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da empresa

Example:

Body Parameters

nome

string

Example:

optio

cnpj

string

Example:

similique

id_tipo_empresa

integer

required

Example:

criado_por

integer

required

Example:

alterado_por

integer

required

Example:

Headers

URL Parameters

Body

{ "nome": "optio", "cnpj": "similique", "id_tipo_empresa": 1, "criado_por": 17, "alterado_por": 19 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/empresas/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": \"optio\",
    \"cnpj\": \"similique\",
    \"id_tipo_empresa\": 1,
    \"criado_por\": 17,
    \"alterado_por\": 19
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/empresas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da empresa

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/empresas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Estoques

Endpoints para visualizar os estoques

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/estoques

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se o resultado deve ser paginado. O padrão é true.

comLote

boolean

Indica se o resultado deve vir com lote. O padrão é flase.

idLocalFim

integer

Filtra estoques pelo ID do local Fim.

idLocalArmazenado

integer

Filtra estoques pelo ID do local armazenado.

idMaterial

integer

Filtra estoques pelo id do material.

titulo

string

Filtra estoques pelo título do material.

descricao

string

Filtra estoques pela descrição do material.

cas

string

Filtra estoques pelo número CAS do material.

catmat

string

Filtra estoques pelo código CATMAT do material.

idTipoControle

string

Filtra os estoques pelo tipo de controle.

itemsPerPage

integer

Número de itens por página, se a paginação estiver habilitada. O padrão é 10.

page

integer

Página na paginação.

orderByMaterial

string

Define a ordenação pela coluna "Material".

orderByCatMat

string

Define a ordenação pela coluna "CatMat".

orderByCas

string

Define a ordenação pelo "Cas".

orderByQuantidade

string

Define a ordenação pela coluna quantidade.

OrderByUnidadeMedida

string

Define a ordenação pela Unidade de Medida.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/estoques" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/estoques/{id}:{id_local_fim}:{id_local_armazenado}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do lote.

id_local_fim

string

required

Id do local de pertencimento.

id_local_armazenado

string

required

Id do local armazenado.

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/estoques/::" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/estoques

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_lote

integer

required

Example:

id_local_fim

integer

required

Example:

id_local_armazenado

integer

required

Example:

quantidade

integer

required

Example:

Headers

Body

{ "id_lote": 1, "id_local_fim": 1, "id_local_armazenado": 1, "quantidade": 1 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/estoques" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_lote\": 1,
    \"id_local_fim\": 1,
    \"id_local_armazenado\": 1,
    \"quantidade\": 1
}"

Tipos de Movimentações

Endpoints para visualizar os tipos de movimentaçõs

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-movimentacao

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-movimentacao" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-movimentacao/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do tipo de movimentação

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-movimentacao/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Lotes

Endpoints para gerenciar os lotes

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/lotes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se a resposta deve ser paginada. Padrão: falso.

page

integer

Página na paginação.

codLote

string

Código do lote a ser filtrado.

dataVenc

string

Data de vencimento do lote no formato YYYY-MM-DD.

fabricante

string

Nome do fabricante a ser filtrado.

idFabricante

string

Id do fabricante a ser filtrado.

titulo

string

Título do material a ser filtrado.

descricao

string

Descrição do material.

itemsPerPage

integer

Quantidade de itens por página. Padrão: 10.

export

boolean

Define se o retorno deve ser um arquivo excel.

formatoPlanilha

string

Define o formato do arquivo a ser exportado. Podendo ser xlsx ou csv. Padrão é csv.

orderByCodLote

string

Ordenar pelo código do lote.

orderByMaterial

string

Ordenar pelo Material.

orderByFabricante

string

Ordenar pelo fabricante.

orderByDataVenc

string

Ordenar pela Data de Vencimento.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/lotes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/lotes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do lote

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/lotes/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/lotes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_material

integer

required

id_fabricante

integer

required

cod_lote

string

Example:

564564564

data_venc

date

Example:

2024-09-23

quantidade

integer

required

Example:

motivo

string

id_local

integer

required

id_local_destino

integer

notas_fiscais

object[]

Headers

Body

{ "id_material": null, "id_fabricante": null, "cod_lote": "564564564", "data_venc": "2024-09-23", "quantidade": 10, "motivo": null, "id_local": null, "id_local_destino": null, "notas_fiscais": [ { "id_nota_fiscal": 15 } ] }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/lotes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_material\": null,
    \"id_fabricante\": null,
    \"cod_lote\": \"564564564\",
    \"data_venc\": \"2024-09-23\",
    \"quantidade\": 10,
    \"id_local\": null,
    \"notas_fiscais\": [
        {
            \"id_nota_fiscal\": 15
        }
    ]
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/lotes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do lote

Body Parameters

id_material

integer

required

id_fabricante

integer

required

cod_lote

string

data_venc

string

notas_fiscais

object[]

motivo

string

Headers

URL Parameters

Body

{ "id_material": null, "id_fabricante": null, "cod_lote": null, "data_venc": null, "notas_fiscais": [ { "id_nota_fiscal": null } ], "motivo": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/lotes/" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_material\": null,
    \"id_fabricante\": null,
    \"notas_fiscais\": [
        []
    ]
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/lotes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do lote

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/lotes/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Notas Fiscais

Endpoints para gerenciar as notas fiscais

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/notas-fiscais

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se a resposta deve ser paginada. Padrão: false.

page

integer

Indica a pagina na paginação.

numeroNf

string

Número da nota fiscal a ser filtrado.

processoSei

string

Número do processo SEI a ser filtrado.

idTransportadora

integer

Filtra notas ficais pelo ID da empresa transportadora do material.

idFornecedor

integer

Filtra notas ficais pelo ID da empresa fornecedora do material.

fornecedor

string

Nome do fornecedor a ser filtrado.

transportadora

string

Nome da transportadora a ser filtrada.

dataEmissao

string

Filtrar pela data de emissão.

dataRecebimento

string

Filtrar pela data de recebimento.

orderByNumeroNF

string

Define a ordenação pela coluna "número da nota fiscal".

orderByFornecedor

string

Define a ordenação pela coluna "fornecedor".

orderByTransportadora

string

Define a ordenação pela coluna "transportadora".

orderByProcessoSei

string

Define a ordenação pela coluna "processo SEI".

orderByDataEmissao

string

Define a ordenação pela coluna "Data de emissão".

orderByDataRecebimento

string

Define a ordenação pela coluna "Data de recebimento".

itemsPerPage

integer

Quantidade de itens por página. Padrão: 10.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/notas-fiscais" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/notas-fiscais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da Nota Fiscal

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/notas-fiscais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/notas-fiscais

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

numero_nf

string

required

Example:

12313

id_transportadora

integer

required

Example:

id_fornecedor

integer

required

Example:

data_emissao

date

Example:

2024-09-23

data_recebimento

date

Example:

2024-09-23

processo_sei

string

Example:

fugiat

link_nf

string

Example:

https://www.nfe.fazenda.gov.br/portal/principal.aspx

lotes

object[]

id_material

integer

required

id_fabricante

integer

required

cod_lote

string

Example:

564564564

data_venc

date

Example:

2024-09-23

quantidade

integer

required

Example:

id_local

integer

required

id_local_destino

integer

Headers

Body

{ "numero_nf": "12313", "id_transportadora": 1, "id_fornecedor": 1, "data_emissao": "2024-09-23", "data_recebimento": "2024-09-23", "processo_sei": "fugiat", "link_nf": "https:\/\/www.nfe.fazenda.gov.br\/portal\/principal.aspx", "lotes": [ { "id_material": null, "id_fabricante": null, "cod_lote": "564564564", "data_venc": "2024-09-23", "quantidade": 10, "id_local": null, "id_local_destino": null } ] }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/notas-fiscais" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"numero_nf\": \"12313\",
    \"id_transportadora\": 1,
    \"id_fornecedor\": 1,
    \"data_emissao\": \"2024-09-23\",
    \"data_recebimento\": \"2024-09-23\",
    \"processo_sei\": \"fugiat\",
    \"link_nf\": \"https:\\/\\/www.nfe.fazenda.gov.br\\/portal\\/principal.aspx\",
    \"lotes\": [
        {
            \"id_material\": null,
            \"id_fabricante\": null,
            \"cod_lote\": \"564564564\",
            \"data_venc\": \"2024-09-23\",
            \"quantidade\": 10,
            \"id_local\": null
        }
    ]
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/notas-fiscais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da nota fiscal

Example:

Body Parameters

numero_nf

string

required

Example:

12313

id_transportadora

integer

required

Example:

id_fornecedor

integer

required

Example:

data_emissao

date

Example:

2024-09-23

data_recebimento

date

Example:

2024-09-23

processo_sei

string

Example:

exercitationem

link_nf

string

Example:

velit

lotes

object[]

id_material

number

This field is required when lotes is true.

Example:

24617

id_fabricante

number

This field is required when lotes is true.

Example:

718.9051

cod_lote

string

Must not be greater than 50 characters.

Example:

fvtkdqdvoczel

data_venc

string

Must be a valid date.

Example:

2025-09-30T19:30:13

quantidade

number

This field is required when lotes is true.

Example:

79744.4963244

id_local

number

This field is required when lotes is true.

Example:

36906787

id_local_destino

number

Example:

298.922

Headers

URL Parameters

Body

{ "numero_nf": "12313", "id_transportadora": 1, "id_fornecedor": 1, "data_emissao": "2024-09-23", "data_recebimento": "2024-09-23", "processo_sei": "exercitationem", "link_nf": "velit", "lotes": [ { "id_material": 24617, "id_fabricante": 718.9051, "cod_lote": "fvtkdqdvoczel", "data_venc": "2025-09-30T19:30:13", "quantidade": 79744.4963244, "id_local": 36906787, "id_local_destino": 298.922 } ] }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/notas-fiscais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"numero_nf\": \"12313\",
    \"id_transportadora\": 1,
    \"id_fornecedor\": 1,
    \"data_emissao\": \"2024-09-23\",
    \"data_recebimento\": \"2024-09-23\",
    \"processo_sei\": \"exercitationem\",
    \"link_nf\": \"velit\",
    \"lotes\": [
        {
            \"id_material\": 24617,
            \"id_fabricante\": 718.9051,
            \"cod_lote\": \"fvtkdqdvoczel\",
            \"data_venc\": \"2025-09-30T19:30:13\",
            \"quantidade\": 79744.4963244,
            \"id_local\": 36906787,
            \"id_local_destino\": 298.922
        }
    ]
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/notas-fiscais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da nota fiscal

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/notas-fiscais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Riscos dos Materiais

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/riscos-material

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/riscos-material" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/riscos-material/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do risco do material.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/riscos-material/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/riscos-material

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_classificacao_risco

integer

required

Example:

id_material

integer

required

Example:

criado_por

integer

required

Example:

alterado_por

integer

required

Example:

Headers

Body

{ "id_classificacao_risco": 1, "id_material": 1, "criado_por": 4, "alterado_por": 13 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/riscos-material" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_classificacao_risco\": 1,
    \"id_material\": 1,
    \"criado_por\": 4,
    \"alterado_por\": 13
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/riscos-material/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do risco do material.

Example:

Body Parameters

id_classificacao_risco

integer

required

Example:

id_material

integer

required

Example:

alterado_por

integer

required

Example:

Headers

URL Parameters

Body

{ "id_classificacao_risco": 1, "id_material": 1, "alterado_por": 5 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/riscos-material/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_classificacao_risco\": 1,
    \"id_material\": 1,
    \"alterado_por\": 5
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/riscos-material/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do risco do material.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/riscos-material/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Movimentações no Estoque

Endpoints para gerenciar as movimentações no estoque

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/movimentacoes-estoque

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Define se a listagem deve ser paginada. Padrão é false. No-exmaple

Example:

false

itemsPerPage

integer

Número de itens por página para a paginação.

idLocalDestino

integer

ID do local de destino.

idLocalOrigem

integer

ID do local de origem.

idLote

integer

ID do lote.

idTipoMovimentacao

integer

ID do tipo de movimentação.

tipoControle

integer

Id do tipo de controle.

titulo

string

Título do material para pesquisa.

descricao

string

Descrição do material para pesquisa.

material

string

Filtrar pelo titulo ou descrição.

codLote

string

Filtrar pelo código do lote.

criadoEm

string

Data de criação da movimentação no formato 'Y/m/d'.

dataVenc

string

Data de vencimento do lote no formato 'Y/m/d'.

status

integer

Numero do status da movimentação.

pendentesAprovacao

boolean

Define se o retorno deve ser de apenas movimentações que precisam ser aprovadas. Padrão é false.

export

boolean

Define se o retorno deve ser um arquivo em excel. Padrão é false.

formatoPlanilha

string

Define o formato do arquivo a ser exportado. Podendo ser xlsx ou csv. Padrão é csv.

orderByMaterial

string

Coluna a ser ordenada.

orderByCodLote

string

Coluna a ser ordenada.

orderByTipoMovimentacao

string

Coluna a ser ordenada.

orderByQuantidade

string

Coluna a ser ordenada.

orderByUnidadeMedida

string

Coluna a ser ordenada.

orderByOrigem

string

Coluna a ser ordenada.

orderByDestino

string

Coluna a ser ordenada.

orderByData

string

Coluna a ser ordenada.

orderByStatus

string

Coluna a ser ordenada

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/movimentacoes-estoque?pagination=" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/movimentacoes-estoque/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da movimentação.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/movimentacoes-estoque/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/movimentacoes-estoque

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

movimentacoes

object[]

Array de movimentacoes.

id_lote

integer

required

ID do lote.

id_tipo_movimentacao

integer

required

Tipo de movimentação.

id_local_origem_fim

integer

Local de origem (fim). Obrigatório se o tipo de movimentação for 3, 4 ou 5.

id_local_destino_fim

integer

Local de destino (fim). Obrigatório se o tipo de movimentação for 1, 2 ou 3.

id_local_origem_arm

integer

Local de origem (armazenado).

id_local_destino_arm

integer

Local de destino (armazenado).

quantidade

integer

Quantidade movimentada.

observacao

string

Observação sobre a movimentação. Máximo de 500 caracteres.

fl_estorno

string

required

Flag indicando se é um estorno.

id_nota_fiscal

integer

Id Da nota fiscal.

lote

object

Headers

Body

{ "movimentacoes": [ { "id_lote": null, "id_tipo_movimentacao": null, "id_local_origem_fim": null, "id_local_destino_fim": null, "id_local_origem_arm": null, "id_local_destino_arm": null, "quantidade": null, "observacao": null, "fl_estorno": null, "id_nota_fiscal": null, "lote": { "id_material": null, "id_fabricante": null, "cod_lote": null, "data_venc": null } } ] }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/movimentacoes-estoque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"movimentacoes\": [
        {
            \"id_lote\": null,
            \"id_tipo_movimentacao\": null,
            \"fl_estorno\": null,
            \"lote\": {
                \"id_material\": 3.897,
                \"id_fabricante\": 157.671,
                \"cod_lote\": \"mr\",
                \"data_venc\": \"2025-09-30T19:30:13\"
            }
        }
    ]
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/movimentacoes-estoque/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

Id da movimentação.

Body Parameters

id_lote

integer

required

ID do lote.

id_local_origem_fim

integer

Local de origem (fim). Obrigatório se o tipo de movimentação for 3, 4 ou 5.

id_local_destino_fim

integer

Local de destino (fim). Obrigatório se o tipo de movimentação for 1, 2 ou 3.

id_local_origem_arm

integer

Local de origem (armazenado).

id_local_destino_arm

integer

Local de destino (armazenado).

quantidade

integer

Quantidade movimentada.

observacao

string

Observação sobre a movimentação. Máximo de 500 caracteres.

lote

object

fl_estorno

string

required

Flag indicando se é um estorno.

Headers

URL Parameters

Body

{ "id_lote": null, "id_local_origem_fim": null, "id_local_destino_fim": null, "id_local_origem_arm": null, "id_local_destino_arm": null, "quantidade": null, "observacao": null, "lote": { "id_material": null, "id_fabricante": null, "cod_lote": null, "data_venc": null }, "fl_estorno": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/movimentacoes-estoque/{id}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_lote\": null,
    \"lote\": {
        \"id_material\": null,
        \"id_fabricante\": null
    },
    \"fl_estorno\": null
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/movimentacoes-estoque/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da movimentação.

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/movimentacoes-estoque/" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Item Nota Fiscal

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/item-nota-fiscal

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/item-nota-fiscal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/item-nota-fiscal/{id}:{idNotaFiscal}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do item nota fiscal.

Example:

idNotaFiscal

string

required

Example:

cum

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/item-nota-fiscal/1:cum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/item-nota-fiscal

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_nota_fiscal

integer

required

Example:

id_lote

integer

required

Example:

Headers

Body

{ "id_nota_fiscal": 1, "id_lote": 1 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/item-nota-fiscal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_nota_fiscal\": 1,
    \"id_lote\": 1
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/item-nota-fiscal/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do item nota fiscal.

Example:

Body Parameters

id_nota_fiscal

integer

required

Example:

id_lote

integer

required

Example:

Headers

URL Parameters

Body

{ "id_nota_fiscal": 1, "id_lote": 1 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/item-nota-fiscal/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_nota_fiscal\": 1,
    \"id_lote\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/item-nota-fiscal/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do item nota fiscal.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/item-nota-fiscal/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Icones de Risco

Endpoints para visualizar os icones de risco

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/icones-risco

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/icones-risco" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/icones-risco/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do icone de risco.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/icones-risco/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/icones-risco

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

icone

string

required

Example:

Icone

nome

string

required

Example:

Imagem

descricao

string

Example:

Perigo

Headers

Body

{ "icone": "Icone", "nome": "Imagem", "descricao": "Perigo" }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/icones-risco" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"icone\": \"Icone\",
    \"nome\": \"Imagem\",
    \"descricao\": \"Perigo\"
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/icones-risco/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do icone de risco.

Example:

Body Parameters

icone

string

required

Example:

Icone

nome

string

required

Example:

Imagem

descricao

string

Example:

Perigo

Headers

URL Parameters

Body

{ "icone": "Icone", "nome": "Imagem", "descricao": "Perigo" }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/icones-risco/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"icone\": \"Icone\",
    \"nome\": \"Imagem\",
    \"descricao\": \"Perigo\"
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/icones-risco/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do icone de risco.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/icones-risco/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Responsaveis por Laboratórios

Endpoints para gerenciar os responsaveis por laboratórios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/responsaveis-laboratorio

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se a resposta deve ser paginada. Padrão: falso.

itemsPerPage

integer

Quantidade de itens por página. Padrão: 10.

page

integer

Página na paginação.

nomeResponsavel

string

Filtrar pelo nome do responsável.

nomeLaboratorio

string

Filtrar pelo nome do laboratatório.

idLaboratorio

integer

Filtrar pelo id do laboratório.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/responsaveis-laboratorio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/responsaveis-laboratorio/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do responsável do laboratório.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/responsaveis-laboratorio/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/responsaveis-laboratorio

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_pessoa

integer

requried Id da pessoa.

id_local

integer

required

Id da movimentacao.

data_fim

string

required

Data fim.

Headers

Body

{ "id_pessoa": null, "id_local": null, "data_fim": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/responsaveis-laboratorio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_local\": null,
    \"data_fim\": null
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/responsaveis-laboratorio/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do responsável do laboratório.

Body Parameters

data_fim

string

required

Data fim.

Headers

URL Parameters

Body

{ "data_fim": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/responsaveis-laboratorio/" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"data_fim\": null
}"

Tipos de Empresas

Endpoints para visualizar os tipos de empresas

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-empresas

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-empresas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-empresas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do tipo de empresa

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-empresas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-empresas

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

descricao

string

required

Example:

Transportadora

obriga_cnpj

string

required

Example:

Headers

Body

{ "descricao": "Transportadora", "obriga_cnpj": "N" }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-empresas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"descricao\": \"Transportadora\",
    \"obriga_cnpj\": \"N\"
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-empresas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do tipo de empresa

Example:

Body Parameters

descricao

string

required

Example:

Transportadora

obriga_cnpj

string

required

Example:

Headers

URL Parameters

Body

{ "descricao": "Transportadora", "obriga_cnpj": "N" }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-empresas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"descricao\": \"Transportadora\",
    \"obriga_cnpj\": \"N\"
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-empresas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do tipo de empresa

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-empresas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Unidades de Medida

Endpoints para visualizar as unidades de medida

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/unidades-medida

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/unidades-medida" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/unidades-medida/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da unidade de medida

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/unidades-medida/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Tipos de Controles

Endpoints para visualizars os tipos de controles sobre os materiais

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-controle

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-controle" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/tipos-controle/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da substância controlada

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/tipos-controle/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Locais

Endpoints para visualizar os locais utilizados pelo almoxarifado de químicos

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/locais

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Indica se a resposta deve ser paginada. Padrão: falso.

page

integer

Página na paginação.

itemsPerPage

integer

Quantidade de itens por página. Padrão: 10.

filtrarPorTecnico

boolean

Filtrar Laboratórios de um técnico especifíco. Padrão é false.

trazerTecnicos

boolean

Trazer juntos dos laboratórios seus técnicos. Padrão é false.

idResponsavel

integer

Filtrar os ids dos responsáveis de laboratório. Funciona apenas se 'trazerTecnicos' estiver como true.

idLotacao

integer

Filtrar os ids dos locais.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/locais" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/locais/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do local

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/locais/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Status de movimentação

Endpoint para consultar os status de movimentação

Index

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/status-movimentacao

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/status-movimentacao" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/almoxarifadoquimicos/status-movimentacao/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/almoxarifadoquimicos/status-movimentacao/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Arquivos Digitais

API para armazenar arquivos digitais.

Index

GET

https://api.producao.minha.ufcspa.edu.br

/arquivosdigitais/arquivos-digitais

Headers

api-key

Example:

nihil

app-name

Example:

accusamus

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idTabelaOrigem

integer

Filtrar pelo Id da Tabela de Origem.

nomeTabelaOrigem

integer

Filtrar pelo nome da Tabela de Origem.

apenasInformacao

boolean

Mostrar apenas a informaçãoo do arquivo.

verificarArquivos

boolean

Verificar se o arquivo existe.

idsDosArquivos

integer[]

Array de ids para se verificar a existência.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/arquivosdigitais/arquivos-digitais" \
    --header "api-key: nihil" \
    --header "app-name: accusamus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/arquivosdigitais/arquivos-digitais/{id}

Headers

api-key

Example:

recusandae

app-name

Example:

dignissimos

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

Selecionar o arquivo com o id específico.

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/arquivosdigitais/arquivos-digitais/{id}" \
    --header "api-key: recusandae" \
    --header "app-name: dignissimos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/arquivosdigitais/arquivos-digitais

Headers

api-key

Example:

voluptates

app-name

Example:

tenetur

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome_original_arquivo

string

Nome original do arquivo.

conteudo_arquivo

string

O arquivo, codificado em base64.

id_tabela_origem

integer

O id da tabela de origem.

nome_tabela_origem

string

O nome da tabela de origem.

cpf_documento

string

O cpf.

cpf_registro

string

O cpf 2.

Headers

Body

{ "nome_original_arquivo": null, "conteudo_arquivo": null, "id_tabela_origem": null, "nome_tabela_origem": null, "cpf_documento": null, "cpf_registro": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/arquivosdigitais/arquivos-digitais" \
    --header "api-key: voluptates" \
    --header "app-name: tenetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/arquivosdigitais/arquivos-digitais/{idTabelaOrigem}:{nomeTabelaOrigem}

Headers

api-key

Example:

rerum

app-name

Example:

laborum

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

idTabelaOrigem

integer

Selecionar por id.

nomeTabelaOrigem

string

Selecionar por nome.

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/arquivosdigitais/arquivos-digitais/{idTabelaOrigem}:{nomeTabelaOrigem}" \
    --header "api-key: rerum" \
    --header "app-name: laborum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Institucional

Funcionarios Ativos

Endpoint que busca pelos funcionários e bolsistas ativos.

Index

GET

https://api.producao.minha.ufcspa.edu.br

/institucional/funcionarios-ativos

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Optação da paginação. Padrão é true.

page

integer

Página na paginação.

itemsPerPage

integer

Itens por paginação.

cpf

string

Filtrar pelo cpf.

nomeCivil

string

Filtrar pelo nome cívil.

nomeSocial

string

Filtrar pelo nome social.

naturezaJuridica

string

Filtrar pela natureza jurídica.

ultimaAlteracao

string

Filtrar pela última alteração.

orderByCpf

string

Ordenar pelo cpf.

orderByNomeCivil

string

Ordenar pelo nome cívil.

orderByNomeSocial

string

Ordernar pelo nome social.

orderByNaturezaJuridica

string

Ordernar pela natureza jurídica.

ordernarByUltimaAlteracao

string

Ordernar pela última alteração.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/institucional/funcionarios-ativos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/institucional/funcionarios-ativos/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/institucional/funcionarios-ativos/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Noticias

para mostrar as últimas notícias da UFCSPA

Index

GET

https://api.producao.minha.ufcspa.edu.br

/institucional/noticias

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

items

integer

Especificar quantas notícias serão retornadas.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/institucional/noticias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Usuarios Ldap

Endpoint que busca pelos usuarios do sistema.

Index

GET

https://api.producao.minha.ufcspa.edu.br

/institucional/usuarios-ldap

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

retornarContasGerenciais

boolean

Parametro para retornar apenas as contas gerenciais do usuário. Padrão é false.

employeetype

string

Parametro para filtragem pelo cpf do usuário.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/institucional/usuarios-ldap" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/institucional/usuarios-ldap/{email}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

string

Email do usuário.

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/institucional/usuarios-ldap/{email}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/institucional/usuarios-ldap/{email}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

string

Email do usuário.

Query Parameters

editarContasGerenciais

boolean

Parametro para permitir a edição de contas gerenciais.

suspenderConta

string

bool. Paramêtro para permitir a suspenção de uma conta gerencial.

adicionarContaGerencialCvr

string

Paramêtro para adicionar uma conta gerencial ao usuário.

adicionarContaGerencialSenha

string

Paramêtro para adicionar uma conta gerencial ao usuário, utilizando email e senha.

gerarCodigoCvr

boolean

Paramêtro para gerar o código cvr de uma conta gerencial, retornará erro caso a conta ja tenha uma senha.

Body Parameters

string

Email do novo gerente da conta.

codigo_cvr

string

Codigo da cvr da conta a ser modificada.

senha

string

Senha ca conta departamental a ser vinculada.

Headers

URL Parameters

Query Parameters

Body

{ "email": null, "codigo_cvr": null, "senha": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/institucional/usuarios-ldap/{email}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \

Grupo que trabalha no login de um usuário

POST

https://api.producao.minha.ufcspa.edu.br

/auth/login

Headers

App_name

Example:

Sigla do Sistema

Appversion

Example:

Versão da aplicação/sistema

Api_key

Example:

Chave de acesso ao sistema

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

username

string

required

Usuário institucional (Sem @ufcspa.edu.br)

Example:

accusamus

password

string

required

Senha do usuário LDAP

Example:

.ENxg1ll%8<

token

string

required

Token do usuário

Example:

alias

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/auth/login" \
    --header "App_name: Sigla do Sistema" \
    --header "Appversion: Versão da aplicação/sistema" \
    --header "Api_key: Chave de acesso ao sistema" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"username\": \"accusamus\",
    \"password\": \".ENxg1ll%8<\",
    \"token\": \"alias\"
}"

PUT

https://api.producao.minha.ufcspa.edu.br

/auth/senha

Headers

app-name

Example:

Sigla do Sistema

api-key

Example:

Chave de acesso ao sistema

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

username

string

required

Usuário institucional (Sem @ufcspa.edu.br)

Example:

qui

password

string

required

Senha do usuário LDAP

Example:

:DW;|.;s:lo3Ac0s

Headers

Body

{ "username": "qui", "password": ":DW;|.;s:lo3Ac0s" }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/auth/senha" \
    --header "app-name: Sigla do Sistema" \
    --header "api-key: Chave de acesso ao sistema" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"username\": \"qui\",
    \"password\": \":DW;|.;s:lo3Ac0s\"
}"

Permissões

Controllers

Endpoints para gerenciar os controllers no sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/controllers

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

nome

string

Filtrar pelo nome do controller.

situacao

string

Filtrar pela situação. A ou I.

siglaSistema

string

Filtrar pela sigla do sistema.

itemsPerPage

integer

Definir o número de itens por página. Padrão é 10.

page

integer

Definir a página.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/controllers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/controllers/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do controller

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/controllers/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/controllers

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

required

Nome do controller.

situacao

char

required

A ou I.

id_sistema

integer

required

Id do sistema.

Headers

Body

{ "nome": null, "situacao": null, "id_sistema": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/controllers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"situacao\": null,
    \"id_sistema\": null
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/controllers/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do controller

Example:

Body Parameters

nome

string

required

Nome do controller.

situacao

char

required

A ou I.

id_sistema

integer

required

Id do sistema.

Headers

URL Parameters

Body

{ "nome": null, "situacao": null, "id_sistema": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/controllers/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"situacao\": null,
    \"id_sistema\": null
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/controllers/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do controller.

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/controllers/" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Itens Menus

Endpoints para gerenciar os itens de menus no sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/itens-menus

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/itens-menus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/itens-menus/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do item menu

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/itens-menus/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/itens-menus

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

required

situacao

char

required

Example:

A ou I

id_menu

integer

required

Example:

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

id_controller

integer

Example:

Headers

Body

{ "nome": null, "situacao": "A ou I", "id_menu": 1, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null, "id_controller": 4 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/itens-menus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"situacao\": \"A ou I\",
    \"id_menu\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1,
    \"id_controller\": 4
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/itens-menus/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do Item menu

Example:

Body Parameters

nome

string

required

situacao

char

required

Example:

A ou I

id_menu

integer

required

Example:

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

id_controller

integer

Example:

Headers

URL Parameters

Body

{ "nome": null, "situacao": "A ou I", "id_menu": 1, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null, "id_controller": 4 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/itens-menus/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"situacao\": \"A ou I\",
    \"id_menu\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1,
    \"id_controller\": 4
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/itens-menus/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do item menu

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/itens-menus/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Menus

Endpoints para gerenciar os menus no sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/menus

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/menus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/menus/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do menu

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/menus/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/menus

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

id_sistema

integer

required

Example:

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

Body

{ "nome": null, "descricao": null, "situacao": "A ou I", "id_sistema": 1, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/menus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"id_sistema\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/menus/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do menu

Example:

Body Parameters

nome

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

id_sistema

integer

required

Example:

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

URL Parameters

Body

{ "nome": null, "descricao": null, "situacao": "A ou I", "id_sistema": 1, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/menus/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"id_sistema\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/menus/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do menu

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/menus/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Autenticações

Endpoints para gerenciar as autenticações no sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/parametros-acesso-api

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/parametros-acesso-api" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/parametros-acesso-api/{}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

string

required

Example:

labore

token

string

required

Token da autenticação

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/parametros-acesso-api/labore" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/autenticacoes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/autenticacoes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/autenticacoes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

string

required

The ID of the autenticaco.

Example:

optio

token

string

required

Token da autenticação No example

Example:

officia

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/autenticacoes/optio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Perfis

Endpoints para gerenciar os perfis do sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

Pagination

boolean

Optação da paginação.

Example:

true

Page

integer

Página na paginação.

Example:

ItensPerPage

integer

Itens por paginação.

Example:

Nome

string

Nome do perfil.

Descricao

string

Descrição do Perfil.

Situacao

string

char Situação que se encontra o perfil.

Example:

A ou I

Sistema

integer

Id do sistema.

Example:

Id_pessoa

integer

Id da pessoa logada.

Example:

OrderByNome

string

Coluna a ser ordenada.

Example:

asc

OrderByDescricao

string

Coluna a ser ordenada.

Example:

asc

OrderBySituacao

string

Coluna a ser ordenada.

Example:

asc

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis?Pagination=1&Page=1&ItensPerPage=10&Situacao=A+ou+I&Sistema=5&Id_pessoa=5&OrderByNome=asc&OrderByDescricao=asc&OrderBySituacao=asc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

id_sistema

integer

required

Example:

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

Body

{ "nome": null, "descricao": null, "situacao": "A ou I", "id_sistema": 1, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"id_sistema\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil

Example:

Body Parameters

nome

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

id_sistema

integer

Example:

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

URL Parameters

Body

{ "nome": null, "descricao": null, "situacao": "A ou I", "id_sistema": 1, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"id_sistema\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Perfis Recursos

Endpoints para gerenciar os perfis quando relacionados a recursos no sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recursos

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

page

integer

Número da Página.

itemsPerPage

string

Número de itens por página. Padrão é 10.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recursos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recursos/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil recurso

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recursos/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Perfis Recursos Itens

Endpoints para gerenciar os perfis recursos quando estão relacionados a itens de menus no sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recrusos-itens

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recrusos-itens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recrusos-itens/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil recurso item

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recrusos-itens/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recrusos-itens

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

descricao

string

required

Must not be greater than 200 characters.

Example:

yfwictyojutvsrhnxyv

situacao

char

required

Example:

A ou I

id_perfil

number

required

Example:

7208.15226697

id_recurso

number

required

Example:

285947825.438

id_perfil_recurso

integer

required

Example:

id_item_menu

integer

required

Example:

id_controller

integer

Example:

funcao

string

modulo

string

required

css

string

nivel

integer

required

Example:

ordem

integer

required

Example:

link_externo

string

modal

string

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

Body

{ "descricao": "yfwictyojutvsrhnxyv", "situacao": "A ou I", "id_perfil": 7208.15226697, "id_recurso": 285947825.438, "id_perfil_recurso": 1, "id_item_menu": 1, "id_controller": 1, "funcao": null, "modulo": null, "css": null, "nivel": 1, "ordem": 1, "link_externo": null, "modal": null, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recrusos-itens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"descricao\": \"yfwictyojutvsrhnxyv\",
    \"situacao\": \"A ou I\",
    \"id_perfil\": 7208.15226697,
    \"id_recurso\": 285947825.438,
    \"id_perfil_recurso\": 1,
    \"id_item_menu\": 1,
    \"id_controller\": 1,
    \"modulo\": null,
    \"nivel\": 1,
    \"ordem\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recrusos-itens/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil recurso item

Example:

Body Parameters

descricao

string

required

Must not be greater than 200 characters.

Example:

jlfmrqqfffc

situacao

char

required

Example:

A ou I

id_perfil

number

required

Example:

962.8384

id_recurso

number

required

Example:

11883.980726

id_perfil_recurso

integer

required

Example:

id_item_menu

integer

required

Example:

id_controller

integer

Example:

funcao

string

modulo

string

required

css

string

nivel

integer

required

Example:

ordem

integer

required

Example:

link_externo

string

modal

string

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

URL Parameters

Body

{ "descricao": "jlfmrqqfffc", "situacao": "A ou I", "id_perfil": 962.8384, "id_recurso": 11883.980726, "id_perfil_recurso": 1, "id_item_menu": 1, "id_controller": 1, "funcao": null, "modulo": null, "css": null, "nivel": 1, "ordem": 1, "link_externo": null, "modal": null, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recrusos-itens/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"descricao\": \"jlfmrqqfffc\",
    \"situacao\": \"A ou I\",
    \"id_perfil\": 962.8384,
    \"id_recurso\": 11883.980726,
    \"id_perfil_recurso\": 1,
    \"id_item_menu\": 1,
    \"id_controller\": 1,
    \"modulo\": null,
    \"nivel\": 1,
    \"ordem\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/perfis-recrusos-itens/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da perfil recurso item

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/perfis-recrusos-itens/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Recursos

Endpoints para gerenciar os recursos do sistema de permissões

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/recursos

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

page

integer

Página na paginação.

itemsPerPage

integer

Numero de páginas. Padrão é 10.

idRecurso

integer

Id do recurso a ser filtrado.

idSistema

integer

Id do sistema a ser filtrado.

nome

string

Nome a ser filtrado.

descricao

string

Descricao a ser filtrada.

situacao

string

Situacao a ser filtrada.

siglaSistema

string

Sigla do sistema a ser filtrado.

situacaoSistema

string

Situacao do sistema a ser filtrado.

descricaoSistema

string

Descricao do sistema a ser filtrada.

OrderByNome

string

Coluna a ser ordenada.

Example:

asc

OrderBySituacao

string

Coluna a ser ordenada.

Example:

asc

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/recursos?OrderByNome=asc&OrderBySituacao=asc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/recursos/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do recurso

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/recursos/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/recursos

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

tipo

char

required

Example:

G ou U

id_sistema

integer

required

Example:

ordem

integer

Example:

Headers

Body

{ "nome": null, "descricao": null, "situacao": "A ou I", "tipo": "G ou U", "id_sistema": 1, "ordem": 1 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/recursos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"tipo\": \"G ou U\",
    \"id_sistema\": 1,
    \"ordem\": 1
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/recursos/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do recurso

Example:

Body Parameters

nome

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

tipo

char

required

Example:

G ou U

id_sistema

integer

required

Example:

ordem

integer

Example:

Headers

URL Parameters

Body

{ "nome": null, "descricao": null, "situacao": "A ou I", "tipo": "G ou U", "id_sistema": 1, "ordem": 1 }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/recursos/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"tipo\": \"G ou U\",
    \"id_sistema\": 1,
    \"ordem\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/recursos/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do recurso

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/recursos/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Sistemas

Endpoints para gerenciar a tabela de sistemas

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/sistemas

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

page

integer

Página na paginação.

itemsPerPage

integer

Numero de páginas. Padrão é 10.

id_sistema

integer

Id do sistema a ser filtrado.

id_orgao

integer

Id do orgao a ser filtrado.

sigla

string

Sigla a ser filtrada.

descricao

string

Descricao a ser filtrada.

pagina_inicial

string

Pagina inicial a ser filtrada.

situacao

string

Situacao a ser filtrada.

OrderBySituacao

string

Coluna a ser ordenada.

Example:

asc

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/sistemas?OrderBySituacao=asc" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/sistemas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do sistema

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/sistemas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/sistemas

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

nome

string

required

Must not be greater than 100 characters.

Example:

nhirhgkymt

sigla

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

tipo

string

required

Must not be greater than 1 character.

Example:

versao_atual

string

id_orgao

integer

required

Example:

pagina_inicial

string

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

Body

{ "nome": "nhirhgkymt", "sigla": null, "descricao": null, "situacao": "A ou I", "tipo": "c", "versao_atual": null, "id_orgao": 1, "pagina_inicial": null, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/sistemas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": \"nhirhgkymt\",
    \"sigla\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"tipo\": \"c\",
    \"id_orgao\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/sistemas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do sistema

Example:

Body Parameters

nome

string

required

Must not be greater than 100 characters.

Example:

cjgtzfjurzarzlkk

sigla

string

required

descricao

string

required

situacao

char

required

Example:

A ou I

tipo

string

required

Must not be greater than 1 character.

Example:

versao_atual

string

id_orgao

integer

required

Example:

pagina_inicial

string

criado_por

integer

Example:

alterado_por

integer

Example:

criado_em

date

alterado_em

date

Headers

URL Parameters

Body

{ "nome": "cjgtzfjurzarzlkk", "sigla": null, "descricao": null, "situacao": "A ou I", "tipo": "b", "versao_atual": null, "id_orgao": 1, "pagina_inicial": null, "criado_por": 1, "alterado_por": 1, "criado_em": null, "alterado_em": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/sistemas/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"nome\": \"cjgtzfjurzarzlkk\",
    \"sigla\": null,
    \"descricao\": null,
    \"situacao\": \"A ou I\",
    \"tipo\": \"b\",
    \"id_orgao\": 1,
    \"criado_por\": 1,
    \"alterado_por\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/sistemas/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do sistema

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/sistemas/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Permissões

Endpoints para gerenciar as permissões no sistema

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/permissoes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idPessoa

integer

Id da pessoa a ser filtrado.

idPerfil

integer

Id do perfil a ser filtrado.

idController

integer

id do Controller a ser filtrado.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/permissoes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/permissoes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da pessoa

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/permissoes/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/permissoes

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

ids_perfis

integer[]

Array de id_perfil.

id_tipo_permissao

integer

Id do tipo da permissão.

ids_pessoas

integer[]

Array de id_pessoa.

dta_inicio

string

Data de inicio da permissão.

dta_fim

string

Data de fim da permissão

situacao

string

Situação da(s) permissão(ões) criadas. A ou I.

Headers

Body

{ "ids_perfis": null, "id_tipo_permissao": null, "ids_pessoas": null, "dta_inicio": null, "dta_fim": null, "situacao": null }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/permissoes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \

Update

PUT

https://api.producao.minha.ufcspa.edu.br

/permissoes/permissoes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

Ida da permissão a ser atualizada.

Body Parameters

id_tipo_permissao

integer

Id do tipo da permissão.

dta_fim

string

Data de fim da permissão

situacao

string

Situação da(s) permissão(ões) criadas. A ou I.

Headers

URL Parameters

Body

{ "id_tipo_permissao": null, "dta_fim": null, "situacao": null }

Received response

Example request:

curl --request PUT \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/permissoes/{id}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/permissoes/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

Id da permissão a ser inativada.

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/permissoes/{id}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Endpoints para gerenciar o menu lateral

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/menu_lateral

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/menu_lateral" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Show

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/menu_lateral/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id do perfil

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/menu_lateral/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Acesso Ambiente

Endpoints para gerenciar as permissões do Acesso ao Ambiente no sistema

Index

GET

https://api.producao.minha.ufcspa.edu.br

/permissoes/acesso-ambiente

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

pagination

boolean

Optação da paginação. Padrão é true.

idPessoa

integer

Id da pessoa a ser filtrado.

nomeSocial

string

a ser filtrado.

situacao

string

Filtrar pela situação. A ou I.

page

integer

Página na paginação.

itemsPerPage

integer

Numero de páginas. Padrão é 10.

criadoEm

string

Filtrar pela data de criação.

alteradoEm

string

Filtrar pela data de alteração.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/permissoes/acesso-ambiente" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Store

POST

https://api.producao.minha.ufcspa.edu.br

/permissoes/acesso-ambiente

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Body Parameters

id_pessoa

integer

required.

Example:

Headers

Body

{ "id_pessoa": 1 }

Received response

Example request:

curl --request POST \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/acesso-ambiente" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token" \
    --data "{
    \"id_pessoa\": 1
}"

Destroy

DELETE

https://api.producao.minha.ufcspa.edu.br

/permissoes/acesso-ambiente/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

URL Parameters

integer

required

Id da pessoa

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.producao.minha.ufcspa.edu.br/permissoes/acesso-ambiente/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Relatórios

Relatorios

Endpoint que retorna todos os relatorios disponíveis ao usuário

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/relatorios

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

descricao

string

Filtrar pela descrição do relatório.

situacao

string

Filtrar pela situação do relatório.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/relatorios" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Relatorios Parametros

Endpoint que retorna os paramêtros de um dado relatório.

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/relatorios-parametros

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

id_relatorio

integer

Filtrar por id do relatório. Obrigatorio.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/relatorios-parametros" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Docentes por Plano e por Tramitação

Endpoints para gerenciar os relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/planos-ensino/docentes-plano-tramitacao

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idCursoPlano

integer

Filtra pelo id do curso do plano de ensino.

departamento

integer

Filtra pelo nome do apartamento do plano de ensino.

tramitacaoAtual

string

Filtra pelo trâmite do plano de ensino.

ano

integer

Filtra pelo ano do plano de ensino.

semestre

integer

Filtra pelo semestre do plano de ensino.

situacaoCodigo

string

Filtra pelo código da situacao do plano de ensino.

idServidor

integer

Filtra pelo código de identificação do docente do plano de ensino.

docentePlano

string

Filtra pelo nome do docente do plano de ensino.

modalidade

string

Filtra pela modalidade do plano de ensino.

pagination

boolean

Define se a listagem deve ser paginada. Padrão é true.

itemsPerPage

integer

Número de itens por página para a paginação.

orderByNomeDisciplina

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDepartamento

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtual

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAno

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySemestre

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByIdServidor

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtualPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/planos-ensino/docentes-plano-tramitacao" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Planos Cadastrados

Endpoints para gerenciar os relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/planos-ensino/planos-cadastrados

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idCursoPlano

integer

Filtra pelo id do curso do plano de ensino.

nomeCursoPlano

string

Filtra pelo nome do curso do plano de ensino.

idUnidadeDepartamento

integer

Filtra pelo id do departamento do plano de ensino.

departamento

string

Filtra pelo nome do departamento do plano de ensino.

tramitacaoAtual

string

Filtra pelo trâmite do plano de ensino.

ano

integer

Filtra pelo ano do plano de ensino.

semestre

integer

Filtra pelo semestre do plano de ensino.

situacaoCodigo

string

Filtra pelo código da situacao do plano de ensino.

idServidor

integer

Filtra pelo código de identificação do docente do plano de ensino.

docentePlano

string

Filtra pelo nome do docente do plano de ensino.

modalidade

string

Filtra pela modalidade do plano de ensino.

orderByIdCursoPlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByNomeCursoPlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDepartamento

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByIdUnidadeDepartamento

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtual

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAno

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySemestre

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoCodigo

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByIdServidor

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDocentePlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByModalidade

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtualPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/planos-ensino/planos-cadastrados" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Situação por Tempo

Endpoints para gerenciar os relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/planos-ensino/planos-situacao-tempo

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

ano

integer

Filtra pelo ano do plano de ensino.

semestre

integer

Filtra pelo semestre do plano de ensino.

dias

integer

Filtrar pelos dias anterior ao de hoje.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/planos-ensino/planos-situacao-tempo" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Situação por Curso

Endpoints para gerenciar os relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/planos-ensino/situacao-planos-curso

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idCursoPlano

integer

Filtra pelo id do curso do plano de ensino.

departamento

integer

Filtra pelo nome do apartamento do plano de ensino.

tramitacaoAtual

string

Filtra pelo trâmite do plano de ensino.

ano

integer

Filtra pelo ano do plano de ensino.

semestre

integer

Filtra pelo semestre do plano de ensino.

situacaoCodigo

string

Filtra pelo código da situacao do plano de ensino.

idServidor

integer

Filtra pelo código de identificação do docente do plano de ensino.

docentePlano

string

Filtra pelo nome do docente do plano de ensino.

modalidade

string

Filtra pela modalidade do plano de ensino.

pagination

boolean

Define se a listagem deve ser paginada. Padrão é true.

itemsPerPage

integer

Número de itens por página para a paginação.

orderByNomeDisciplina

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDepartamento

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtual

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAno

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySemestre

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByIdServidor

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtualPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/planos-ensino/situacao-planos-curso" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Situação por Departamento

Endpoints para gerenciar os relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/planos-ensino/situacao-planos-departamento

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idCursoPlano

integer

Filtra pelo id do curso do plano de ensino.

departamento

integer

Filtra pelo nome do apartamento do plano de ensino.

tramitacaoAtual

string

Filtra pelo trâmite do plano de ensino.

ano

integer

Filtra pelo ano do plano de ensino.

semestre

integer

Filtra pelo semestre do plano de ensino.

situacaoCodigo

string

Filtra pelo código da situacao do plano de ensino.

idServidor

integer

Filtra pelo código de identificação do docente do plano de ensino.

docentePlano

string

Filtra pelo nome do docente do plano de ensino.

modalidade

string

Filtra pela modalidade do plano de ensino.

pagination

boolean

Define se a listagem deve ser paginada. Padrão é true.

itemsPerPage

integer

Número de itens por página para a paginação.

orderByNomeDisciplina

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDepartamento

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtual

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAno

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySemestre

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByIdServidor

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtualPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/planos-ensino/situacao-planos-departamento" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Planos de Ensino - Tramitação Atual por Curso

Endpoints para gerenciar os relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/planos-ensino/tramitacao-atual-curso

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

idCursoPlano

integer

Filtra pelo id do curso do plano de ensino.

departamento

integer

Filtra pelo nome do apartamento do plano de ensino.

tramitacaoAtual

string

Filtra pelo trâmite do plano de ensino.

ano

integer

Filtra pelo ano do plano de ensino.

semestre

integer

Filtra pelo semestre do plano de ensino.

situacaoCodigo

string

Filtra pelo código da situacao do plano de ensino.

idServidor

integer

Filtra pelo código de identificação do docente do plano de ensino.

docentePlano

string

Filtra pelo nome do docente do plano de ensino.

modalidade

string

Filtra pela modalidade do plano de ensino.

pagination

boolean

Define se a listagem deve ser paginada. Padrão é true.

itemsPerPage

integer

Número de itens por página para a paginação.

orderByNomeDisciplina

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDepartamento

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtual

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByAno

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySemestre

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPlano

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByIdServidor

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderBySituacaoPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTramitacaoAtualPorcentagem

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/planos-ensino/tramitacao-atual-curso" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Almoxarifado de Químicos - Materiais Estocados

Endpoints para gerar relatórios de materiais estocados

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/almoxarifado-quimicos/materiais-estocados

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

material

string

Filtrar tanto pelo título quanto pela descrição do material.

numero_cas

string

Filtrar pelo número CAS.

unid_medida

string

Filtrar pela unidade de medida.

fabricante

string

Filtrar pelo fabricante.

local_armazenado

string

Filtrar pelo local de armazenamento.

local_responsavel

string

Filtrar pelo local responsável.

quantidade

integer

filtrar pela quantidade.

cod_lote

string

Filtar pelo Código do lote.

retornarVazio

boolean

Opção para retornar estoques vazios. Padrão é false.

orderByTitulo

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDescricao

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByNumeroCas

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByUnidMedida

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByFabricante

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByLocalArmazenado

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByLocalResponsavel

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByCodLote

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByQuantidade

string

string Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

pdf

boolean

Retornar um pdf para download.

planilha

boolean

Retornar os dados em planilha para download.

formatoPlanilha

string

Define se o retorno deve ser em xlsx ou csv. Padrão é csv.

orientacao

string

Define a orientação da pagina landscape ou portrait. Padrão é portrait.

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/almoxarifado-quimicos/materiais-estocados" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Almoxarifado de Químicos - Saída de Materiais

Endpoints para gerenciar as relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/almoxarifado-quimicos/saida-materiais

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

id_material

integer

Filtrar por id do tipo de relatorio.

numero_cas

string

Filtrar por código do cas.

titulo

string

Filtrar por titulo.

unid_medida

string

Filtrar por tipo de unidade de medida.

operacao

string

Filtrar por tipo de operação.

pdf

boolean

Retornar um pdf para download.

planilha

boolean

Retornar os dados em planilha para download.

formatoPlanilha

string

Define se o retorno deve ser em xlsx ou csv. Padrão é csv.

orientacao

string

Define a orientação da pagina landscape ou portrait. Padrão é portrait.

dt_entrada

string

Filtrar por data de movimentação.

dt_saida

string

Filtrar por quantidade de movimentação.

qt_movimentada

integer

Filtrar pela quantidade movimentada.

dt_periodo_inicial

string

Filtrar por um período inicial específico da data de saída.

dt_periodo_final

string

Filtrar por um período final específico da data de saída.

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

orderByNumeroCas

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByTitulo

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByDescricao

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByUnidMedida

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByFabricante

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByOperacao

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByDataEntrada

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByDataSaida

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByLocalArmazenado

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByLocalResponsavel

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

orderByQuantidadeMovimentada

string

Dita se o resultado deve ser ordenado pelo respectivo campo.

Must be one of:

asc
desc

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/almoxarifado-quimicos/saida-materiais" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Almoxarifado de Químicos - Materiais Controlados

Endpoints para gerenciar as relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/almoxarifado-quimicos/materiais-controlados

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

id_material

integer

Filtrar por id do tipo de relatorio.

id_tipo_controle

string

Filtrar por id do tipo de controle.

id_local_reponsavel

string

Filtrar por id do laboratorio reponsável.

id_local_armazenado

string

Filtrar por id do laboratorio armazenado.

numero_cas

string

Filtrar por código do cas.

org_coontrolador

string

Filtrar por orgão controlador.

titulo

string

Filtrar por titulo.

unid_medida

string

Filtrar por tipo de unidade de medida.

qt_armazenada

string

Filtrar por quantidade armazenada.

pdf

boolean

Retornar um pdf para download.

planilha

boolean

Retornar os dados em planilha para download.

formatoPlanilha

string

Define se o retorno deve ser em xlsx ou csv. Padrão é csv.

orientacao

string

Define a orientação da pagina landscape ou portrait. Padrão é portrait.

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

orderByNumeroCas

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTitulo

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByUnidMedida

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByQuantidadeArmazenada

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByOrgCoontrolador

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByLocalResponsavel

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByLocalArmazenado

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/almoxarifado-quimicos/materiais-controlados" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response:

Almoxarifado de Químicos - Movimentações de Materiais Controlados

Endpoints para gerenciar as relatorios

Index

GET

https://api.producao.minha.ufcspa.edu.br

/relatorios/almoxarifado-quimicos/movimentacoes-materiais-controlados

Headers

Content-Type

Example:

application/json

Example:

application/json

token

Example:

Your token

Query Parameters

id_material

integer

Filtrar por id do tipo de relatorio.

id_tipo_controle

string

Filtrar por id do tipo de controle.

numero_cas

string

Filtrar por código do cas.

org_coontrolador

string

Filtrar por orgão controlador.

titulo

string

Filtrar por titulo.

unid_medida

string

Filtrar por tipo de unidade de medida.

operacao

string

Filtrar por tipo de operação.

dt_movimentacao

string

Filtrar por data de movimentação.

dt_periodo_inicial

string

Filtrar por um período inicial específico.

dt_periodo_final

string

Filtrar por um período final específico.

qt_movimentacao

integer

Filtrar por quantidade de movimentação.

cod_lote

string

Filtrar pelo código do lote.

fabricante

string

Filtrar pelo Fabricante.

nota_fiscal

string

Filtrar pelo número da nota fiscal.

id_responsavel

integer

Filtrar pelo id do laboratório responsável.

id_armazenado

integer

Filtrar pelo id do laboratório de armazenamento.

armazenado

string

Filtrar pelo laboratório de armazenamento.

responsavel

string

Filtrar pelolaboratório responsavel.

pdf

boolean

Retornar um pdf para download.

planilha

boolean

Retornar os dados em planilha para download.

formatoPlanilha

string

Define se o retorno deve ser em xlsx ou csv. Padrão é csv.

orientacao

string

Define a orientação da pagina landscape ou portrait. Padrão é landscape.

itemsPerPage

integer

Número de itens por página. Padrão é 10.

page

integer

Número da página.

orderByNumeroCas

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByCodLote

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByFabricante

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByNotaFiscal

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByResponsavel

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByArmazenado

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByTitulo

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByUnidMedida

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByOperacao

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByDataMovimentacao

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByQuantidadeMovimentada

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

orderByOrgCoontrolador

string

Dita se o resultado deve ser ordenado pelo respectivo campo. Aceita asc ou desc.

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.producao.minha.ufcspa.edu.br/relatorios/almoxarifado-quimicos/movimentacoes-materiais-controlados" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your token"

Example response: