Manuais

h1. API do Sinfonia

{{toc}}

Todas as chamadas são feitas via REST e precisam passar como parâmetro um token_key, que deve ser solicitado previamente.

O path (URL) dos métodos é formada pelo endereço https://sinfonia.sistemas.ufsc.br/api/v1/ + nome do método desejado

h2. Número de itens do Lattes

*Método*
* tipo: get
* nome: lattes_items_count

*Entrada*
* idpessoa: identificador da pessoa
* types: lista de tipos de ítens, separados por vírgula no caso de mais de um valor.
* date (opcional): data limite da extração (se não informada, pega-se a extração mais recente)
* year (opcional): ano base das publicações (se não informado, considera-se 5 anos pra tŕas do ano corrente)

*Saída*
* número de itens encontrados

h2. Items do lattes

*Método*
* tipo: get
* nome: lattes_items

*Entrada*
* idpessoa: identificador da pessoa
* types: lista de tipos de ítens, separados por vírgula no caso de mais de um valor.
* date (opcional): data limite da extração (se não informada, pega-se a extração mais recente)
* year (opcional): ano base das publicações (se não informado, considera-se 5 anos pra tŕas do ano corrente)

*Saída*
* lista de items, com ano, titulo, orientando

h2. Indice H

*Método*
* tipo: get
*nome: h_index

*Entrada*
* idpessoa
* year: ano do índice (se não informado, considera-se o ano corrente)

*Saída*
* indice H da pessoa (número)

h2. Bolsista de produtividade

*Método*
* tipo: get
* nome: sholarship

*Entrada*
- idpessoa
- date: data amparada pela da bolsa (maior ou igual a data de início e menor ou igual a data de término)

*Saída*
* year
* area: grande área/área/sub-área
* item_type (PQ ou DT)
* level: 1A, 1B, 1C, 1D, 2
* beginning_date
* ending_date

h2. Número de Items do SIGPEX

*Método*
* tipo: get
* nome: sigpex_items_count

*Entrada*
* idpessoa
* types (opcional): lista de tipos, separados por vírgula no caso de mais de um valor.
* date (opcional): data amparada pelo projeto (maior ou igual a data de corte (entre início e menor ou igual a data de término)
* participation_type (opcional): tipo de participação (Coordenador ou Participante). Omite-se o parâmetro se quiser todos.

*Saída*
* número

h2. Items do SIGPEX

*Método*
* tipo: get
* nome: sigpex_items

*Entrada*
* idpessoa
* types (opcional): lista de tipos, separados por vírgula no caso de mais de um valor.
* date (opcional): data amparada pelo projeto (maior ou igual a data de corte (entre início e menor ou igual a data de término)
* participation_type (opcional): tipo de participação (Coordenador ou Participante). Omite-se o parâmetro se quiser todos.

*Saída*
* number
* title
* coordinator_name
* start_date
* end_date
* situation
* participation_type
* project_type

h2. Sigpex por número

*Método*
* tipo: get
* nome: sigpex_item_by_number

*Entrada*
* idpessoa
* number
* participation_type (opcional)
* types (opcional): lista de tipos, separados por vírgula no caso de mais de um valor.

*Saída*
* number
* title
* coordinator_name
* start_date
* end_date
* situation
* participation_type
* project_type

h2. Licenças

*Método*
* tipo: get
* nome: leaves

*Entrada*
* idpessoa
* date (opcional): data base (licença(s) de corte (alguma licença com término após essa data)
* types (opcional): lista com os tipos de licença. licença (M - maternidade )

*Saída*
* leave_type
* beginning_date
* ending_date
* expected_return_date
* days

h2. Detalhes dos parâmetros

*Com relação às consultas referentes ao Currículo Lattes, são types:* itens:*

* ORIENT_CONCL_DOUT: 'Orientações concluídas - Doutorado'
* ORIENT_CONCL_MEST: 'Orientações concluídas - Mestrado'
* ORIENT_CONCL_POS_DOC: 'Orientações concluídas - Pós-doutorado'
* ORIENT_CONCL_ESPEC: 'Orientações concluídas - Aprefeiçoamento/Especialização'
* ORIENT_CONCL_TCC: 'Orientações concluídas - TCC'
* ORIENT_CONCL_IC: 'Orientações concluídas - IC'
* ORIENT_ANDAM_DOUT: 'Orientações em andamento - Doutorado'
* ORIENT_ANDAM_MEST: 'Orientações em andamento - Mestrado'
* ORIENT_ANDAM_POS_DOC: 'Orientações em andamento - Pós-doutorado'
* ORIENT_ANDAM_ESPEC: 'Orientações em andamento - Aperfeiçoamento/Especialização'
* ORIENT_ANDAM_TCC: 'Orientações em andamento - TCC'
* ORIENT_ANDAM_IC: 'Orientações em andamento - IC'
* CO_ORIENT_CONCL_DOUT: 'Coorientações concluídas - Doutorado'
* CO_ORIENT_CONCL_MEST: 'Coorientações concluídas - Mestrado'
* CO_ORIENT_CONCL_POS_DOC: 'Coorientações concluídas - Pós-doutorado'
* CO_ORIENT_CONCL_ESPEC: 'Coorientações concluídas - Aprefeiçoamento/Especialização'
* CO_ORIENT_CONCL_TCC: 'Coorientações concluídas - TCC'
* CO_ORIENT_CONCL_IC: 'Coorientações concluídas - IC'
* CO_ORIENT_ANDAM_DOUT: 'Coorientações em andamento - Doutorado'
* CO_ORIENT_ANDAM_MEST: 'Coorientações em andamento - Mestrado'
* CO_ORIENT_ANDAM_POS_DOC: 'Coorientações em andamento - Pós-doutorado'
* CO_ORIENT_ANDAM_ESPEC: 'Coorientações em andamento - Aperfeiçoamento/Especialização'
* CO_ORIENT_ANDAM_TCC: 'Coorientações em andamento - TCC'
* CO_ORIENT_ANDAM_IC: 'Coorientações em andamento - IC'

*Para as consultas ao SIGPEX, o parâmetro types type pode assumir os seguintes valores:*

* DISCENTE: Atividade Discente
* DOCENTE: Atividade Docente
* EXTENSAO_CURSO: Curso de Extensão
* EXTENSAO_EVENTO: Evento de Extensão
* EXTENSAO_PROGRAMA: Programa de Extensão
* EXTENSAO_PROJETO: Projeto de Extensão
* PESQUISA: Projeto de Pesquisa

*Para consultas de Licenças, o parâmetro types pode assumir:
* M: Licença Maternidade