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: get_lattes_items_count

*Entrada*
* idpessoa: identificador da pessoa
* date: data limite da extração (se não for informada, 5 anos a partir da data da consulta)
* items: lista de ítens, passada como array json (entre colchetes, mesmo para um único item).

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

h2. Items do lattes

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

*Entrada*
* idpessoa
* date: data limite da extração (default 5 anos)
* items: lista de ítens, passada como array json (entre colchetes, mesmo para um único item).

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

h2. Indice H

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

*Entrada*
* idpessoa
* year
* date: data limite da extração

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

h2. Bolsista de produtividade

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

*Entrada*
- idpessoa
- date: data da bolsa

*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: get_sigpex_items_count -------------------------

*Entrada* entrada:
* - idpessoa
* types : sempre uma lista, mesmo pra um único - tipo de projeto ou lista de tipos
* date: - data de corte (entre início e término)
* participation_type: - tipo de participação (Coordenador (coordenador, Participante ou Participante). Omite-se o parâmetro se quiser todos. ambos)

*Saída* saída:
* - número

h2.

Items do SIGPEX

*Método*
* tipo: get
* nome: list_sigpex_items ---------------

*Entrada* entrada:
* - idpessoa
* types : sempre uma lista, mesmo pra um único - tipo de projeto ou lista de tipos
* date: - data de corte (entre início e término)
* participation_type: - tipo de participação (Coordenador (coordenador, Participante ou Participante). Omite-se o parâmetro se quiser todos. ambos)

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

h2. - número do projeto, tipo, coordenador, tipo de participação, titulo do projeto

Licenças

*Método*
* tipo: get
* nome: list_leaves --------

*Entrada* entrada:
* - idpessoa
* date: - data de corte (alguma licença com término após essa data)
* type: - tipo de licença (M - maternidade, )

*Saída* saída:
* leave_type
* beginning_date
* ending_date
* expected_return_date
* days - tipo de licença, data de início, data de término, data previsto de término

h2. Detalhes dos parâmetros

*Com relação às consultas referentes ao Currículo Lattes, são 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 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