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

Link: «Link_do_cliente»/api/courses/get.json?«parâmetro»=«valor»&«...»

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 @param Boolean only_courses  indica se devolve apenas informação dos cursos (ignora ações de formação).
• @param @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 @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.  O formato deve ser ser YYYY-MM-DD hh:mm.
• @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,definido, 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 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 cf_actions  indica se devolve informação dos campos de utilizador referentes à ação de formação.
• @param Boolean installments  indica se devolve informação referente às prestações da ação de formação.
• @param Boolean discounts  indica se devolve informação referente aos descontos da ação de formação.

Configurações do site

Parâmetros de saída:

• @return Array courses  Cursos filtrados. (Parâmetros Base)
  • @return Integer course_id  Id do curso.
  • @return Text course_code  Código do curso no humantrain.
  • @return Text area_code  Código da área.
  • @return Text mode_code  Código da modalidade de curso.
  • @return Float duration_effect  Duração do curso no formato hh.
  • @return Integer edition  Edição do curso.
  • @return Text area  Designação da área.
  • @return Text course_type  Código do tipo de curso.
  • @return Text course  Designação do curso.
  • @return Text destination A  A quem se destina a formação.
  • @return Text program  Programa do curso.
  • @return Text objectives  Objectivos do curso.
  • @return Text objectives_specific Objetivos específicos do curso.
  • @return Text guidelines  Enquadramento do curso.
  • @return Text webarea_code  Código da área web.
  • @return Text webarea_description  Designação da área web.
  • @return Text evaluation_method  Método de avaliação definido na ficha de curso.
  • @return Float default_cost  Valor do curso por omissão.
  • @return Text occupational_areas  Saídas profissionais.
  • @return Text course_type_description  Designação do tipo de curso.
  • @return Text mode_code_description  Designação da modalidade do curso.
  • @return Text access_conditions  Condições de acesso ao curso.
  • @return Text material  material de apoio do curso.
  • @return Text competences  competências definidas na ficha de curso.

Parâmetros com com only_courses=0  ou NULL.

• @return Integer id  Id da ação.
• @return Integer courseaction_id  Id da ação no humantrain.
• @return Integer action_number  Número da ação.
• @return Boolean laboral  Horário da ação, 1 para laboral e 0 para pós-laboral.
• @return Text web_schedule  Horário da ação.
• @return Text courseaction_status  Estado da ação,  D  para "A Decorrer", E  para "Em Espera", N  para "Não se Realiza" e e T  para "Terminada".
• @return Boolean web_pub  Publicação da ação no site, 1 para "Publicar" e 0 para "Não Publicar".
• @return Boolean pub_date  Publicação das datas da ação no site,  1 para "Publicar" e 0 para "Não Publicar".
• @return Text courseaction_ref  Referência da ação de formação.
• @return Float courseaction_coust  Valor da ação de formação.
• @return Float courseaction_special  Valor especial da ação de formação.
• @return Text local_code  Código do local da formação.
• @return Text local    Local da formação.
• @return Text postal_code  Código postal definido para a ação de formação.
• @return Text postal_description  Designação do código postal.
• @return Text address  Endereço postal.
• @return Boolean web_pub_local  Publicação do local no site,  1 para "Publicar" e 0 para "Não Publicar".
• @return Text latitude  Coordenada latitude da ação.
• @return Text longitude  Coordenada longitude da ação.
• @return Text 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  Código da zona.
• @return DateTime max_matriculation_date  Limite de aceitação de inscrições na ação de formação no formato formato YYYY-MM-DD hh:mm:ss.
• @return DateTime evt_start  Data de início da ação no formato formato YYYY-MM-DD hh:mm:ss.
• @return DateTime evt_end  Data de fim da ação no formato formato YYYY-MM-DD hh:mm:ss.
• @return DateTime courseaction_start  De início efetiva da ação o no formato formato YYYY-MM-DD hh:mm:ss.
• @return DateTime courseaction_end  Data de fim efetiva da ação no formato formato YYYY-MM-DD hh:mm:ss.
• @return Date plan_start_date  Data de início definida na candidatura candidatura no formato formato YYYY-MM-DD.
• @return Date plan_end_date  Data de fim definida na candidatura candidatura no formato formato YYYY-MM-DD.
• @return Text language_code  Código do idioma definido para a ação de acordo com a norma norma ISO 639-1.
• @return Text language  País do idioma.
• @return Integer openings  Vagas da ação.
• @return Text province Concelho  Concelho do local de formação.
• @return Text image  Imagem de capa do curso.
• @return Text status_code  Código do estado da ação específico do utilizador na ficha de projecto.
• @return Text status_description  Designação o do estado da ação específico do utilizador na ficha de projecto.
• @return Boolean highlighted  Indica se a ação está marcada como destaque,  1 para "Destaque" e 0 caso contrário.

Parâmetros por curso com modules=1  

• @return Array modules  Lista de módulos.
  • @return Integer id Id do módulo.
  • @return Text module  Nome do módulo.
  • @return Integer hours  Número mero de horas do módulo.
  • @return Array modules  Sub-Módulos.
  • @return Array sessions  Lista de sessões, apenas disponível para para planning=1  e para módulos sem sub-módulos.
    • @return Integer trainer_code  Id do formador.
    • @return Integer session_number  Id da sessão de formação.
    • @return DateTime evt_start  Data de início da sessão o no formato formato YYYY-MM-DD hh:mm:ss.
    • @return DateTime evt_end  Data de fim da sessão o no formato formato YYYY-MM-DD hh:mm:ss.

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

• @return Array trainers  Lista de formadores.
  
  • @return Integer coursemodule_id  Id do módulo.
  • @return Integer trainer_code  Id do formador.
  • @return Text curriculum_resumed  Resumo do Curriculum Vitae.
  • @return Text name  Nome do formador.
  • @return Text abbreviated_name Nome abreviado do formador.
  • @return Text nationality_code Código do país de acordo com a norma norma ISO 639-1.
  • @return Text nationality  País de nascimento.
  • @return Text areas  Áreas de interesse com Pub_web=1 separadas por ,.
  • @return Text photo Link para a foto do formador, quando definida. Quando o formador não tem foto associada, este campo não está definido.
  • @return Array collaborationtypes lista de tipos de colaboração da entidade.
    • @return Text collabtype_desc Descrição do tipo de colaboração.
    • @return Text collabtype_acronym Acrónimo do tipo de colaboração.

Parâmetros por ação com resp_technicians=1

• @return Array resp_technicians Lista de técnicos responsáveis.
  
  • @return Text name Nome do técnico responsável.
  • @return Text phone Telefone do técnico responsável.
  • @return Text email Emaildo formador.

Parâmetros metros por ação com installments=1

• @return Array installments  Lista de prestações.
  • @return Text description  Designação da prestação.
  • @return Integer installment_num  Número da prestação (0  para taxas, >0  para número total de prestações).
  • @return Integer value  Valor a pagar por prestação.

Parâmetros metros por ação com functions=1

• @return Array functions Lista de funções.
  • @return Text function_code Código da função.
  • @return Integer function  Designação da função.

Parâmetros metros por curso com cf_courses=1

• @return Mixed Mixed «custom_field_name»  Campos de utilizador referentes aos cursos. Estes campos são criados pelo utilizador no Humantrain.

Parâmetros metros por ação com cf_actions=1

• @return Mixed «custom_field_name»  Campos de utilizador referentes às ações. Estes campos são criados pelo utilizador no Humantrain.

Parâmetros metros por ação com discounts=1

• @return Array discounts  Lista de descontos.
  • @return Text discount_code  Código do desconto.
  • @return Text description  Designação do desconto.
  • @return Text group_code  Indica o tipo de desconto: D - desconto, C - campanha.
  • @return float discount  Representa a percentagem de desconto ou o valor total de desconto dependendo do parâmetro is_percent.
  • @return Bool is_percent  Indica se o desconto é em percentagem ou valor,  1 para "Percentagem" e 0 para "Valor".
  • @return Date start_date  Indica o período inicial em vigor do desconto no formato formato YYYY-MM-DD hh:mm:ss. Se este parâmetro não estiver definido, o desconto fica sempre ativo até à data de end_date.
  • @return Date end_date  Indica o período final em vigor do desconto no formato formato YYYY-MM-DD hh:mm:ss. Se este parâmetro não estiver definido, o desconto fica sempre ativo a partir da data de start_date.