Publicação de cursos/ações de formação

Link: api/courses/get.json

Devolve informação sobre cursos/ações de formação. A informação devolvida estará restringida pelos filtros definidos no ecrã "Configurações do site" no caso do parâmetro only_courses ser 0 ou NULL).

Parâmetros suportados para filtrar informação:

@param Integer page informação relativa a paginação: número da página;
@param Integer item_per_page informação relativa a paginação: número de registos por página;
@param Boolean only_courses indica se devolve apenas informação dos cursos (ignora ações de formação);
@param Text course_type filtra por tipo de curso;
@param Boolean web_pub filtra pelo campo "Pub.Web" na ficha de curso ou ação de formação, dependendo do parâmetro only_courses;
@param Boolean modules indica se devolve os módulos de cada ação de formação;
@param Boolean planning indica se devolve a planificação dos módulos de cada ação de formação. Apenas funciona se o parâmetro modules for passado com o valor 1;
@param Integer trainers indica se devolve informação sobre os formadores de cada ação de formação.
- 0 não devolve os formadores;
- 1 devolve os formadores planeados ao nível das sessões de cada ação de formação;
- 2 devolve os formadores negociados para cada ação de formação;
@param Boolean tolerances indica se filtra pelas tolerâncias de inscrições;
@param DateTime evt_start filtra por ações de formação que iniciam depois desta data. As datas a ter em conta são data de inicio na planificação, e quando esta não está definida, data de inicio da ação definida em candidatura;
@param Text keywords filtro que será aplicado tendo em conta os campos definidos no ecrã "Configurações do site" em "Selecione os campos que pretende que sejam usados na pesquisa de texto livre";
@param Boolean functions indica se devolve a informação relativa às funções associadas a cada ação de formação.
@param DateTime updated_since quando passada, apenas são devolvidos os cursos que foram alterados a partir daquela data. O formato deve ser YYYY-MM-DD hh:mm.

Quando se usa esta funcionalidade (solicitar apenas cursos alterados a partir daquela data), aconselha-se a efetuar, pelo menos uma vez por dia, uma chamada a este método (durante uma hora com pouco tráfego - geralmente à noite), para atualização de todos os cursos. Isto porque este método não tem em conta informação de dados eliminados.
@param Boolean cf_courses indica se devolve informação dos campos de utilizador referentes ao curso
@param Boolean installments indica se devolve informação referente às prestações da ação de formação

Configurações do site

Este método devolve a seguinte informação:

campo	designação	tabela
course_id	id do curso	courses
course_code	código do curso no humantrain
course	designação do curso
area_code	código da área (da tabela de áreas do humantrain) associado ao curso
area	designação da área
duration_effect	duração do curso em horas
edition	edição do curso
course_type	código do tipo de curso
course_type_description	designação do tipo de curso
mode_code	código da modalidade de curso
mode_code_description	designação da modalidade do curso
destination	a quem se destina a formação
program	programa do curso
objectives	objectivos do curso
guidelines
webarea_code	código da área web
webarea_description	designação da área web
evaluation_method	método de avaliação definida na ficha de curso
default_cost	Valor do curso por omissão
occupational_areas	áreas de ocupação
access_conditions	Condições de acesso ao curso (linkado com o campo outras condições de acesso
*Campos que são devolvidos se o parâmetro only_courses não definido ou passado com o valor zero*
id	id da tabela courseactions	courseactions
courseaction_id	id da ação no humantriain
action_number	n.º da ação
laboral	indica se a ação é laboral ou pós-laboral
web_schedule	informação horária da ação. normalmente usado para mostrar no site
courseaction_status	estado da ação (D: decorrer, E: Espera, N: Não se realiza, T: Terminada)
web_pub	indica se a ação está definida para ser publicada no site
pub_date	indica se as datas são para publicar no site
courseaction_ref	referência da ação de formação
courseaction_coust	Valor da ação de formação
courseaction_special	Valor especial da ação de formação
local_code	código do local de formação
local	local de formação
postal_code	código postal definido para a ação de formação
postal_description	designação do código postal
address	endereço postal
web_pub_local	indica se o local pode ser publicado na web
latitude	coordenada latitude da ação
longitude	coordenada longitude da ação
obs	Devolve as observações da ação de formação. Se não definido, devolve as observações do curso.
zone_code	código da zona
max_matriculation_date	limite de aceitação de inscrições na ação de formação
evt_start	data de início da ação.
evt_end	data de fim de ação
courseaction_start	data de início efetiva da ação
courseaction_end	data de fim efetiva da ação
plan_start_date	data de início definida na candidatura
plan_end_date	data de fim definida na candidatura
language_code	código do idioma definida para a ação
language	designação do idioma
openings
province	concelho do local de formação
status_code	Estado da ação definido pelo utilizador na ficha de projecto
status_description	designação do estado da ação
*Campos devolvidos dos módulos quando o parâmetro modules=1. a informação é devolvida em array para cada ação de formação*
id	id do módulo	coursemodules
module	nome do módulo
hours	n.º de horas do módulo
level	nível do módulo
Campos devolvidos dos formadores planeados ou negociados para cada ação de formação. trainers=1: formadores planeados, trainers=2: formadores negociados. Informação devolvida em array
coursemodule_id	id do módulo	coursesessions
trainer_code	código do formador
nationality_code	código da nacionalidade
nationality	nacionalidade
areas	áreas onde o formador está habilitado (apenas as áreas com pub_web = 1)
curriculum_resumed	Resumo curricular
photo	link para a foto do formador
Campos das prestações de cada ação de formação quando o parâmetro installments=1. informação devolvida em array
description	designação da prestação	courseactions_installments
installment_num	n.º da prestação (0: taxas, 1: valor a pagar para uma prestação, 2: valor para duas prestações)
value	valor da prestação
*Para devolver campos de utilizador, é necessário passar cf_courses=1. Os valores são devolvidos em cada campo criado no humantrain.*