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 @param Boolean 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 @param Integer 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 @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 @param Boolean Boolean functions indica se devolve a informação relativa às funções associadas a cada ação de formação.
@param @param DateTime 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 @param Boolean Boolean cf_courses indica se devolve informação dos campos de utilizador referentes ao curso

@param Boolean Boolean installments indica se devolve informação referente às prestações da ação de formação


Configurações do site

EsteParâmetros métodode devolve a seguinte informação:saída:


@return Parâmetros 
por curso com only_courses=1 

curso.

@return Text 
humantrain.



















formato 



curso.
Designação da área.

curso.




@return 













o.
Programa do curso.





curso.









web.








curso.




o.




Designação da modalidade 




Integer 



@return Integer 

humantrain.














0 Horário da ação.
E para Boolean Publicação das datas 










o.




o.




o.




o.
 Local 


o.












postal.
Publicação 


e 



o.




o.








zona.








o 







o no 







candidatura no 



candidatura no 







idioma.
Vagas da ação.






o.




capa 



Designação do estado da Array courses Cursos campo
filtrados.

designação tabela


@return Integer course_id


id Id do curso courses


course_code


có Código do curso no humantrain 
@return Text area_code 


course


designação do curso  
area_code cóCódigo da árearea.
(
@return Text mode_code Código da tabelamodalidade de áreascurso.
do
humantrain)@return associadoFloat ao curso duration_effect 


area


designação da área  


duration_effect


duraçDuração do curso emno horas hh.

@return Integer edition 
edition ediçEdição do curso 
@return Text area 

@return Text course_type


có Código do tipo de curso 
@return Text course 


course_type_description


designaçDesignação do tipocurso.
de
curso Text destination 


mode_code


código da modalidade de curso  


mode_code_description


designação da modalidade do curso  


destination


a A quem se destina a formação 
@return Text program 

@return program
Text 

programaobjectives Objectivos do curso

@return Text guidelines 


objectives


objectivosEnquadramento do curso 
@return Text webarea_code 


guidelines


   


webarea_code





cóCódigo da área web 
@return Text webarea_description 




webarea_description




designaçDesignação da área web

@return Text evaluation_method 


evaluation_method









méMétodo de avaliação definidadefinido na ficha de curso 
@return Float default_cost 


default_cost





Valor do curso por omissão 
@return Text occupational_areas 


occupational_areas





áÁreas de ocupação.

@return  Text course_type_description Designação  do tipo de curso.

@return  Text mode_code_description 
do curso.

@return Text access_conditions


 Condições de acesso ao cursocurso.
(linkado
comParâmetros o campo outras condições de acesso com only_courses=0 
Campos que são devolvidos se o parâmetro only_courses não definido ou passadoNULL.
com
o
valor@return zero


id


id Id da tabelaação.
courseactions courseactions




courseaction_id




id Id da ação no humantriain 
@return Integer action_number 


action_number









n.º da ação  
laboral indica se a ação é laboral ou pós-laboral  


web_schedule


informação horáriaNúmero da ação.
normalmente
usado@return Boolean laboral Horário da ação, 1 para mostrarlaboral noe site para pós-laboral.

@return Text web_schedule 

@return Text courseaction_status Estado 
da ação, D para 
"A 
Decorrer", estado"Em Espera", N para "Não se Realiza" e T para "Terminada".

@return Boolean web_pub Publicação da ação (D:no decorrer,site, E:1 Espera,para N:"Publicar" e 0 para "Não sePublicar".
realiza,
T:@return Terminada) pub_date 




web_pub




indica se ada ação estáno definidasite, 1 para ser"Publicar" publicadae no site  


pub_date


indica se as datas são0 para publicar"Não noPublicar".
site @return  Text courseaction_ref 


courseaction_ref





referêReferência da ação de formação 
@return Float courseaction_coust 


courseaction_coust





Valor da ação de formação 
@return  Float courseaction_special 




courseaction_special




Valor especial da ação de formação 
@return Text local_code 






local_code






cóCódigo do local deda formação 
@return  Text local 






local






local deda formação 
@return Text  postal_code 


postal_code


cóCódigo postal definido para a ação de formação

@return Text postal_description 


postal_description


designaçDesignação do código postal

@return Text address 


address


endereçEndereço postal 
@return Boolean web_pub_local 


web_pub_local


indica se odo local podeno sersite, 1 publicadopara na"Publicar" web 0 para "Não Publicar".

@return  Text latitude 


latitude


coordenadaCoordenada latitude da ação 
@return  Text longitude 


longitude


coordenadaCoordenada longitude da ação 
@return Text obs 


obs


Devolve as observações da ação de formação. Se não definido, devolve as observações do curso.

@return Integer zone_code 


zone_code


cóCódigo da zona 
@return DateTime max_matriculation_date 


max_matriculation_date


limiteLimite de aceitação de inscrições na ação de formação  no formato YYYY-MM-DD hh:mm:ss.

@return DateTime evt_start 


evt_start


dataData de início da ação. no formato YYYY-MM-DD hh:mm:ss.

@return DateTime evt_end 


evt_end


dataData de fim deda ação  no formato YYYY-MM-DD hh:mm:ss.

@return  DateTime courseaction_start 




courseaction_start




data deDe início efetiva da ação formato YYYY-MM-DD hh:mm:ss.

@return DateTime courseaction_end 




courseaction_end




dataData de fim efetiva da ação  no formato YYYY-MM-DD hh:mm:ss.

@return Date plan_start_date 


plan_start_date


dataData de início definida na candidatura formato YYYY-MM-DD.

@return Date plan_end_date 


plan_end_date


dataData de fim definida na candidatura formato YYYY-MM-DD.

@return  Text language_code 


language_code


cóCódigo do idioma definidadefinido para a ação  de acordo com a norma ISO 639-1.

@return Text language 


language


designaçãoPaís do idioma 
@return  Integer openings 

@return openingsText 

province   


province


concelho Concelho do local de formação 
@return Text image 


status_code


Estado da ação definido pelo utilizador na fichaImagem de projecto do curso.

@return Text status_code 


status_description


designaçãoCódigo do estado da ação  específico do utilizador na ficha de projecto.

@return Text status_description 
ação específico do utilizador na ficha de projecto.

Parâmetros por curso com modules=1 



@return Array modules


@return Integer id Id do módulo.


@return Text module Nome do módulo.


@return Integer hours Número de horas do módulo.


@return Array modules Sub-Módulos.




 

Parâmetros por ação com trainers=1 ou trainers=2 (não disponível quando only_courses=1)



@return Array trainers


coursemodule_id

trainer_code

name

nationality_code

nationality

areas




 

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.



 
 
 



 
            
    

            
        

        
            
                            
        
    

    

    
    
        
             Back to top