Documentação técnica para LMS - Criação de categoria

Neste tópico, descreve-se o método de criação de categoria na plataforma EAD, com parâmetros recebidos e saída de cada um deles.

1. Método

  • core_course_create_categories

2. Parâmetros

Parâmetro Descrição
categories[0][name] Nome da categoria
categories[0][parent] Código da categoria pai
Quando não tem uma categoria pai, deve enviar “0”.
A categoria pai serve para fazer divisão dentro da plataforma EAD.
Exemplo: Unidade / Período letivo / Curso
categories[0][idnumber] Chave da categoria.
O sistema monta uma chave com todos os agrupamentos da categoria, separados por “pipe”



Atenção:
No mentor é possível definir a categoria por níveis. Para cada nível, é chamado este método para realizar a criação, e informado o identificador do nível pai no “parent”.
Na chave, é separado por “ | ” cada nível.

Exemplo: Primeira chamada:

  • Criação do grupo de subnível (nível 1): Nome: Colégio, Parent: “0”, Chave da categoria: 8|||||| /* Aqui retornou o identificador do EAD da categoria criada: 66550*/
  • Criação do período letivo (nível 2): Nome: 2021, Parent: “66550”, Chave da categoria: 8||157||||

Observe que na segunda chamada o parent recebeu o identificador da nova categoria criada. Já na chave, além do subnível, recebeu o identificar do período letivo.

3. Exemplo de chamada via URL 

http://moodle.edusoft.net/webservice/rest/server.php?wstoken=b79adc6effd3eb52cc362ed1fa7eccc0&wsfunction=core_course_create_categories&moodlewsrestformat=json&categories[0][name]=Col%C3%A9gio&categories[0][parent]=0&categories[0][idnumber]=8%7C%7C%7C%7C%7C%7C


4. Exemplo de retorno de sucesso 

[ 
  { 
    "id": 66550,   /* Identificador da categoria criada no EAD */
    "name": "Colégio"  /* Nome da categoria criada */
  } 
]


5. Exemplo de retorno de erro 

{ 
    "exception": "moodle_exception", 
    "errorcode": "categoryidnumbertaken", 
    "message": "Número de identificação já é usado para outra categoria" 
}


6. Exemplo de chamada no PostMan 

03. Criação de categoria - core_course_create_categories

Ainda há dúvidas? Se você preferir retire suas dúvidas com o nosso suporte, clique aqui e abra um chamado para atendimento. :-)

Voltar

  • (edição externa)