{"openapi":"3.0.0","info":{"title":"API EAD Plataforma","version":"1.5.0","description":"Referência da API pública da EAD Plataforma. As rotas são iguais para todos os clientes; somente o domínio da plataforma muda."},"servers":[{"url":"https://{subdominio}.eadplataforma.app","description":"Ambiente da sua plataforma EAD","variables":{"subdominio":{"default":"seu-subdominio","description":"Subdomínio da sua plataforma"}}}],"paths":{"/api/1/cart":{"get":{"tags":["Carrinho"],"summary":"Listagem do carrinho do EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial adicionado no carrinho (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final adicionado no carrinho (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"carrinho_id":{"description":"Id do carrinho.","type":"integer","example":12},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":88},"aluno_nome":{"description":"Nome do aluno cadastrado no EAD.","type":"string","example":"Nome do Aluno"},"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":10},"curso_titulo":{"description":"Título do curso cadastrado no EAD.","type":"string","example":"Curso EAD"},"valor":{"description":"Valor do curso adicionado no carrinho.","type":"string","example":"199.90"},"cupom":{"description":"Cupom utilizado.","type":"string","example":"CUPOM10"},"data":{"description":"Data que o curso foi adicionado ao carrinho.","type":"string","example":"2020-01-01"},"utms_url":{"description":"UTM's URL","type":"application/json","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/category":{"get":{"tags":["Categorias"],"summary":"Listagem de categorias de cursos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Categoria Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"categoria_id":{"description":"Id da categoria cadastrada no EAD.","type":"integer","example":1},"ordem":{"description":"Ordem com que a categoria aparecerá.","type":"integer","example":10},"categoria":{"description":"Nome da categoria cadastrada no EAD.","type":"string","example":"Programação"},"slug":{"description":"Url da categoria","type":"string","example":"programacao"},"descricao":{"description":"Descrição da categoria","type":"string","example":"Descrição da categoria"},"imagem":{"description":"Imagem da categoria","type":"string","example":"caminho.imagem.com"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Categorias"],"summary":"Inserir uma nova categoria de cursos no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["categoria"],"properties":{"categoria":{"description":"Nome da Categoria","type":"string(75)"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"ordem":{"type":"integer","example":4},"categoria":{"type":"string","example":"Programação"},"slug":{"type":"string","example":"programacao"},"descricao":{"type":"string","example":"Descrição"},"imagem":{"type":"string","example":"caminho.imagem.com"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/category/{id}":{"put":{"tags":["Categorias"],"summary":"Atualizar uma categoria de cursos do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Categoria Id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"categoria":{"description":"Nome da categoria","type":"string(75)"},"ordem":{"description":"Ordem de exibição da categoria no EAD","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"ordem":{"type":"integer","example":4},"categoria":{"type":"string","example":"Programação"},"slug":{"type":"string","example":"programacao"},"descricao":{"type":"string","example":"Descrição"},"imagem":{"type":"string","example":"caminho.imagem.com"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Categorias"],"summary":"Excluir uma categoria de cursos do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Categoria Id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/course":{"get":{"tags":["Cursos"],"summary":"Listagem dos cursos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"categoria","in":"query","description":"Categoria Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os cursos do EAD.","content":{"application/json":{"schema":{"properties":{"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":1},"categoria_id":{"description":"Id da categoria do curso.","type":"integer","example":10},"categoria_titulo":{"description":"Título da categoria.","type":"string","example":"Categoria Exemplo"},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Curso Exemplo"},"data_lancamento":{"description":"Data de lançamento do Curso.","type":"datetime","example":"2020-01-01 00:00:01"},"carga_horaria":{"description":"Carga horária do Curso.","type":"string","example":"500"},"periodo_acesso":{"description":"Período de Acesso em número de dias.","type":"integer","example":360},"suporte":{"description":"Período de Suporte em número de dias.","type":"integer","example":10},"emitir_certificado":{"description":"Emitir ou não certificados. (0-Não / 1-Sim)","type":"integer","example":1},"ordem_curso":{"description":"Ordem que o curso aparecerá na categoria.","type":"integer","example":3},"nome_professor":{"description":"Nome do professor(a) cadastrado no EAD.","type":"string","example":"Professor(a) Exemplo"},"foto_professor":{"description":"Imagem do professor(a) cadastrado no EAD.","type":"string","example":"foto.jpg"},"professor_id":{"description":"Id do professor(a) cadastrado no EAD.","type":"integer","example":12},"email_professor":{"description":"E-mail do professor(a) cadastrado no EAD.","type":"string","example":"professor(a)@email.com"},"status":{"description":"Status do curso. (0-Rascunho / 1-Publicado / 2-Grátis)","type":"integer","example":1},"liberado":{"description":"Curso liberado gratuitamente aos alunos do EAD. (0-Não / 1-Sim)","type":"integer","example":1},"foto":{"description":"Imagem do curso.","type":"string","example":"foto.jpg"},"cover":{"description":"Imagem de background da página curso.","type":"string","example":"cover.jpg"},"media_emitir":{"description":"Porcentagem da média a se atingir para gerar o certificado.","type":"integer","example":6},"certificado_template_id":{"description":"Id do template de certificado que será usado neste curso.","type":"integer","example":1},"total_aulas":{"description":"Número total de aulas cadastradas no curso.","type":"integer","example":60},"total_modulos":{"description":"Número total de módulos cadastradas no curso.","type":"integer","example":4}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Cursos"],"summary":"Inserir um novo curso no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["categoria_id","titulo","professor_id","periodo_acesso","periodo_suporte","carga_horaria"],"properties":{"categoria_id":{"description":"Categoria Id","type":"integer"},"titulo":{"description":"Título do curso","type":"string(125)"},"professor_id":{"description":"Professor(a) Id","type":"integer"},"periodo_acesso":{"description":"Período de Acesso em número de dias","type":"integer"},"periodo_suporte":{"description":"Período de Suporte em número de dias","type":"integer"},"carga_horaria":{"description":"Carga Horaria (000:00)","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"ordem_curso":{"type":"integer","example":4},"curso_titulo":{"type":"string","example":"Programação"},"emitir_certificado":{"type":"integer","example":1},"media_emitir":{"type":"integer","example":7},"data_lancamento":{"type":"string","example":"2021-12-01 00:00:00"},"foto":{"type":"string","example":"caminho.imagem.com"},"cover":{"type":"string","example":"caminho.imagem.com"},"suporte":{"type":"integer","example":365},"carga_horaria":{"type":"string","example":"400:00"},"status":{"type":"integer","example":1},"liberado":{"type":"integer","example":1},"periodo_acesso":{"type":"integer","example":365},"certificado_template_id":{"type":"integer","example":1},"categoria_id":{"type":"integer","example":1},"professor_id":{"type":"integer","example":10},"nome_professor":{"type":"string","example":"Nome Professor(a)"},"foto_professor":{"type":"string","example":"caminho.imagem.com"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/course/{id}":{"put":{"tags":["Cursos"],"summary":"Atualizar um curso do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Curso Id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"categoria_id":{"description":"Categoria Id","type":"integer"},"titulo":{"description":"Título do curso","type":"string(125)"},"professor_id":{"description":"Professor(a) Id","type":"integer"},"periodo_acesso":{"description":"Período de Acesso em número de dias","type":"integer"},"periodo_suporte":{"description":"Período de Suporte em número de dias","type":"integer"},"carga_horaria":{"description":"Carga Horaria (000:00)","type":"string"},"status":{"description":"0-Rascunho / 1-Publicado","type":"integer"},"liberado":{"description":"Curso liberado gratuitamente aos alunos do EAD. (0-Não / 1-Sim)","type":"integer"},"emitir_certificado":{"description":"0-Não / 1-Sim","type":"integer"},"ordem_curso":{"description":"Ordem de exibição do curso","type":"integer"},"media_emitir":{"description":"Porcentagem da média a se atingir para gerar o certificado.","type":"integer","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100]},"certificado_template_id":{"description":"Id do template de certificado que será usado neste curso","type":"integer"},"lancamento":{"description":"Data de lançamento","type":"datetime"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"ordem_curso":{"type":"integer","example":4},"curso_titulo":{"type":"string","example":"Programação"},"emitir_certificado":{"type":"integer","example":1},"media_emitir":{"type":"integer","example":7},"data_lancamento":{"type":"string","example":"2021-12-01 00:00:00"},"foto":{"type":"string","example":"caminho.imagem.com"},"cover":{"type":"string","example":"caminho.imagem.com"},"suporte":{"type":"integer","example":365},"carga_horaria":{"type":"string","example":"400:00"},"status":{"type":"integer","example":1},"liberado":{"type":"integer","example":1},"periodo_acesso":{"type":"integer","example":365},"certificado_template_id":{"type":"integer","example":1},"categoria_id":{"type":"integer","example":1},"professor_id":{"type":"integer","example":10},"nome_professor":{"type":"string","example":"Nome Professor(a)"},"foto_professor":{"type":"string","example":"caminho.imagem.com"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Cursos"],"summary":"Excluir um curso do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Curso Id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/certificate":{"get":{"tags":["Certificados"],"summary":"Listagem com os certificados emitidos no EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Certificado Id","schema":{"type":"string"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"documento","in":"query","description":"Documento (CPF/CNPJ) do usuário, com ou sem máscara","schema":{"type":"string"}},{"name":"data_inicio","in":"query","description":"Data de início do período de busca por data de conclusão do curso (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data de fim do período de busca por data de conclusão do curso (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os certificados emitidos no EAD.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do certificado gerado no EAD.","type":"integer","example":1454},"hash":{"description":"Código do certificado gerado no EAD.","type":"integer","example":1454},"curso_id":{"description":"Id do curso no EAD.","type":"integer","example":10},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Curso Exemplo"},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":12},"aluno_nome":{"description":"Nome do aluno.","type":"string","example":"Nome Aluno"},"media_final":{"description":"Média final obtida pelo aluno.","type":"float","example":9},"iniciado":{"description":"Data de início do curso.","type":"date","example":""},"concluido":{"description":"Data de conclusão do curso.","type":"date","example":""},"carga_horaria":{"description":"Carga horária do curso.","type":"time","example":""},"certificado_link":{"description":"Link do certificado.","type":"string","example":""},"certificado_pdf":{"description":"Link do certificado em PDF.","type":"string","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/certificate/{id}":{"delete":{"tags":["Certificados"],"summary":"Excluir um certificado.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Certificado Id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/templatecertificate":{"get":{"tags":["Certificados"],"summary":"Listagem dos templates de certificados do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Template Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os templates de certificados cadastrados no EAD.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do template do certificado cadastrado no EAD.","type":"integer","example":1},"nome":{"description":"Título do template do certificado cadastrado no EAD.","type":"string","example":"Título"},"status":{"description":"\tEstado do template cadastrado no EAD(0 - Rascunho, 1 - Publicado).","type":"integer","example":13}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/templatecertificate/{id}":{"put":{"tags":["Certificados"],"summary":"Editar um template de certificado do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Certificado template id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"nome":{"description":"Título do template","type":"string"},"status":{"description":"Status do template (0-Rascunho / 1-Publicado)","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"status":{"type":"integer","example":1},"nome":{"type":"string","example":"Certificado Template"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Certificados"],"summary":"Excluir um template de certificado do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Certificado template id","required":true,"schema":{"type":"integer","pattern":"\\d+"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/course/team":{"get":{"tags":["Cursos"],"summary":"Listagem dos colaboradores dos cursos do EAD.","operationId":null,"parameters":[{"name":"curso_id","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"colaborador_id","in":"query","description":"Colaborador Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os colaboradores dos cursos do EAD.","content":{"application/json":{"schema":{"properties":{"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":1},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Curso Exemplo"},"colaborador_id":{"description":"Id do colaborador(a) cadastrado no EAD.","type":"integer","example":12},"nome_colaborador":{"description":"Nome do colaborador(a) cadastrado no EAD.","type":"string","example":"Colaborador(a) Exemplo"},"foto_colaborador":{"description":"Imagem do colaborador(a) cadastrado no EAD.","type":"string","example":"foto.jpg"},"email_colaborador":{"description":"E-mail do colaborador(a) cadastrado no EAD.","type":"string","example":"colaborador(a)@email.com"},"type":{"description":"Tipo de colaborador. (1-Professor(a) / 2-Tutor(a))","type":"integer","example":1},"aulas_associadas":{"description":"Número de aulas associadas ao colaborador(a).","type":"integer","example":60},"modulos_associadas":{"description":"Número de módulos associados ao colaborador(a).","type":"integer","example":4}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Cursos"],"summary":"Inserir um novo colaborador no curso do EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["curso_id","colaborador_id","tipo"],"properties":{"curso_id":{"description":"Curso Id","type":"integer"},"colaborador_id":{"description":"Colaborador(a) Id","type":"integer"},"tipo":{"description":"Tipo de colaborador. (1-Professor(a) / 2-Tutor(a))","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"curso_id":{"type":"integer","example":1},"curso_titulo":{"type":"string","example":"Programação"},"colaborador_id":{"type":"integer","example":10},"nome_colaborador":{"type":"string","example":"Nome Colaborador(a)"},"foto_colaborador":{"type":"string","example":"caminho.imagem.com"},"email_colaborador":{"type":"string","example":"colaborador(a)@email.com"},"type":{"type":"integer","example":1}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/course/team/{curso_id}/{colaborador_id}":{"put":{"tags":["Cursos"],"summary":"Atualizar o tipo do colaborador do curso no EAD.","operationId":null,"parameters":[{"name":"curso_id","in":"path","description":"Curso Id","required":true,"schema":{"type":"integer"}},{"name":"colaborador_id","in":"path","description":"Colaborador(a) Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["tipo"],"properties":{"tipo":{"description":"Tipo de colaborador. (1-Professor(a) / 2-Tutor(a))","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"curso_id":{"type":"integer","example":1},"curso_titulo":{"type":"string","example":"Programação"},"colaborador_id":{"type":"integer","example":10},"nome_colaborador":{"type":"string","example":"Nome Colaborador(a)"},"foto_colaborador":{"type":"string","example":"caminho.imagem.com"},"email_colaborador":{"type":"string","example":"colaborador(a)@email.com"},"type":{"type":"integer","example":1}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Cursos"],"summary":"Excluir um colaborador do curso no EAD.","operationId":null,"parameters":[{"name":"curso_id","in":"path","description":"Curso Id","required":true,"schema":{"type":"integer"}},{"name":"colaborador_id","in":"path","description":"Colaborador(a) Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/brief":{"get":{"tags":["Depoimentos"],"summary":"Listagem de depoimentos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Depoimento Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"professor","in":"query","description":"Professor(a) Id","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status do depoimento (0-Aguardando / 1-Aprovado / 2-Reprovado / 3-Arquivado)","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data período inicial do depoimento (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data período final do depoimento (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os cursos do EAD.","content":{"application/json":{"schema":{"properties":{"depoimento_id":{"description":"Id do depoimento cadastrado no EAD.","type":"integer","example":1},"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":10},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":"12"},"nome":{"description":"Nome do usuário.","type":"string","example":"Nome Exemplo"},"email":{"description":"Email do usuário.","type":"string","example":"email@email.com"},"username":{"description":"Apelido do usuário.","type":"string","example":"UserName"},"foto":{"description":"Foto de perfil do usuário.","type":"string","example":""},"titulo_curso":{"description":"Nome do curso cadastrado no EAD.","type":"string","example":"Título Curso"},"depoimento":{"description":"Opinião do aluno sobre o curso.","type":"string","example":""},"status":{"description":"Status do depoimento (0-Aguardando autorização / 1-Publicado).","type":"integer","example":1},"avaliacao":{"description":"Número de estrelas que o curso recebeu(De 1 a 5 estrelas).","type":"string","example":"5"},"data":{"description":"Data do envio do depoimento.","type":"date","example":"2020-01-05"},"professor_id":{"description":"Id do professor(a) cadastrado no EAD.","type":"integer","example":1}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/brief/{id}":{"put":{"tags":["Depoimentos"],"summary":"Aprovar um depoimento no EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Depoimento Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"status":{"description":"Status do depoimento (0-Aguardando / 1-Aprovado / 2-Reprovado)","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"status":{"type":"integer","example":1},"depoimento":{"type":"string","example":"Depoimento"},"curso_id":{"type":"integer","example":2},"aluno_id":{"type":"integer","example":45}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Depoimentos"],"summary":"Reprovar e apagar um depoimento no EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Depoimento Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/enrollment":{"get":{"tags":["Matrículas"],"summary":"Listagem de matrículas do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Matricula Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"grupo","in":"query","description":"Grupo Id","schema":{"type":"integer"}},{"name":"assinatura_id","in":"query","description":"Assinatura Id","schema":{"type":"integer"}},{"name":"cupom","in":"query","description":"Cupom","schema":{"type":"string"}},{"name":"data_inicio","in":"query","description":"Data inicial do período de início do acesso (yyyy-mm-dd). Filtra matrículas a partir desta data.","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de início do acesso (yyyy-mm-dd). Filtra matrículas até esta data.","schema":{"type":"string"}},{"name":"data_cadastro","in":"query","description":"Data do período de cadastro (yyyy-mm-dd). Filtra matrículas a partir desta data.","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as matrículas do EAD.","content":{"application/json":{"schema":{"properties":{"matricula_id":{"description":"Id da matrícula no EAD.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno no EAD.","type":"integer","example":10},"aluno_nome":{"type":"string","example":"Nome do aluno."},"aluno_email":{"type":"string","example":"E-mail do aluno."},"curso_id":{"description":"Id do curso no EAD.","type":"integer","example":10},"titulo_curso":{"description":"Título do curso.","type":"string","example":"Nome do curso"},"emitir_certificado":{"description":"Determina se o curso irá emitir certificado. (0-Não / 1-Sim)","type":"integer","example":360},"cadastro":{"description":"Data e hora em que a matrícula foi criada.","type":"date time","example":"2020-01-01 00:00:01"},"inicio":{"description":"Data e hora de início do período de acesso ao curso.","type":"date time","example":"2020-01-01 00:00:01"},"suporte":{"description":"Data e hora de término do período de suporte ao aluno.","type":"date time","example":"2020-01-01 00:00:01"},"expira":{"description":"Data e hora de término do período de acesso ao curso.","type":"date time","example":"2020-01-01 00:00:01"},"status":{"description":"Status da matrícula. (1-Ativa / 2-Suspensa / 3-Cancelada / 4-Expirada)","type":"integer","example":"1"},"assinatura_id":{"description":"Id da assinatura que originou a matrícula.","type":"integer","example":10},"cupom":{"description":"Cupom utilizado na matrícula.","type":"string","example":"CHAVE"},"origem":{"description":"Origem do cadastrado no EAD. (1-Grátis / 2-Venda / 3-Assinatura / 4-Grupo / 5-Cupom / 6-API / 7-Cobrança)","type":"integer","example":"4"},"grupo_id":{"description":"Id de um grupo do EAD.","type":"integer","example":"123"},"grupo_nome":{"description":"Nome do grupo a que pertence o aluno.","type":"string","example":"Nome grupo"},"situacao":{"description":"Situação da matrícula. (Não iniciado / Em progresso / Aprovado / Reprovado)","type":"string","example":"Em progresso"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Matrículas"],"summary":"Inserir uma matrícula no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["curso_id","usuario_id"],"properties":{"curso_id":{"description":"Curso Id","type":"integer"},"usuario_id":{"description":"Usuário Id","type":"integer"},"expira":{"description":"Período de acesso do aluno (Y-m-d H:i:s)","type":"string"},"suporte":{"description":"Período de suporte do aluno (Y-m-d H:i:s)","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"inicio":{"type":"string","example":"2021-10-11 00:00:00"},"expira":{"type":"string","example":"2022-10-11 00:00:00"},"suporte":{"type":"string","example":"2022-10-11 00:00:00"},"curso_id":{"type":"integer","example":5},"aluno_id":{"type":"integer","example":55},"status":{"type":"integer","example":1},"emitir_certificado":{"type":"integer","example":1},"origem":{"type":"integer","example":1},"cupom":{"type":"string","example":"CUPOMKEY"},"assinatura_id":{"type":"integer","example":222},"grupo_id":{"type":"integer","example":2}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Conflict","type":"integer","example":409},"message":{"type":"string","example":"Usuário já matriculado neste curso."},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/progress":{"get":{"tags":["Log de acesso e Progresso do aluno"],"summary":"Progresso dos alunos em um curso.","operationId":null,"parameters":[{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"grupo_id","in":"query","description":"Grupo Id","schema":{"type":"integer"}},{"name":"plano_id","in":"query","description":"Plano Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial do período de último acesso (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de último acesso (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna o progresso dos alunos em um curso","content":{"application/json":{"schema":{"properties":{"curso_id":{"description":"Id do curso no EAD.","type":"integer","example":10},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Nome Curso"},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":12},"aluno_nome":{"description":"Nome do aluno.","type":"string","example":"Nome Aluno"},"total_aulas":{"description":"Número de aulas de um curso.","type":"integer","example":134},"aulas_acessadas":{"description":"Número de aulas visualizadas.","type":"integer","example":55},"progresso":{"description":"Porcentagem concluída do curso.","type":"float","example":30},"visualizacoes":{"description":"Número de visualizações do aluno no curso.","type":"integer","example":60},"suporte":{"description":"Número de suportes solicitados pelo aluno.","type":"integer","example":2},"ultimo_acesso":{"description":"Data e hora do último acesso do aluno no curso.","type":"datetime","example":""},"carga_horaria":{"description":"Carga horária realizada.","type":"string","example":"00:00:00"},"situacao":{"description":"Situação da matrícula. (Não iniciado / Em progresso / Aprovado / Reprovado)","type":"string","example":"Em progresso"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/enrollment/{id}":{"put":{"tags":["Matrículas"],"summary":"Atualizar uma matrícula do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Matrícula Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"expira":{"description":"Período de acesso do aluno (Y-m-d H:i:s)","type":"string"},"suporte":{"description":"Período de suporte do aluno (Y-m-d H:i:s)","type":"string"},"emitir_certificado":{"description":"Emitir Certificado. (0-Não / 1-Sim)","type":"integer"},"periodo_suporte":{"description":"Período de Suporte em número de dias","type":"integer"},"status":{"description":"Status da Matrícula. (1-Ativa / 2-Suspensa / 3-Cancelada / 4-Vencida)","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"inicio":{"type":"string","example":"2021-10-11 00:00:00"},"expira":{"type":"string","example":"2022-10-11 00:00:00"},"suporte":{"type":"string","example":"2022-10-11 00:00:00"},"curso_id":{"type":"integer","example":5},"aluno_id":{"type":"integer","example":55},"status":{"type":"integer","example":1},"emitir_certificado":{"type":"integer","example":1},"origem":{"type":"integer","example":1},"cupom":{"type":"string","example":"CUPOMKEY"},"assinatura_id":{"type":"integer","example":222},"grupo_id":{"type":"integer","example":2}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/enrollment/{id}/{removeExams}":{"delete":{"tags":["Matrículas"],"summary":"Excluir uma matrícula do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Matrícula Id","required":true,"schema":{"type":"integer"}},{"name":"removeExams","in":"path","description":"Remover exames? (0-Não / 1-Sim)","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/enrollment/content":{"get":{"tags":["Matrículas Conteúdo Único"],"summary":"Listagem de matrículas conteúdo único do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Matricula Conteúdo Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"conteudo","in":"query","description":"Conteúdo Id","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status (1-Ativa / 2-Suspensa / 3-Cancelada / 4-Vencida)","schema":{"type":"integer"}},{"name":"cupom","in":"query","description":"Cupom","schema":{"type":"string"}},{"name":"data_inicio","in":"query","description":"Data inicial do periodo de última visualização (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de última visualização (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_cadastro","in":"query","description":"Data do período de cadastro (yyyy-mm-dd). Filtra matrículas a partir desta data.","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna matrículas conteúdo único do EAD.","content":{"application/json":{"schema":{"properties":{"matricula_conteudo_id":{"description":"Id da matrícula conteúdo único no EAD.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno no EAD.","type":"integer","example":10},"aluno_nome":{"type":"string","example":"Nome do aluno."},"aluno_email":{"type":"string","example":"E-mail do aluno."},"conteudo_id":{"description":"Id do conteúdo no EAD.","type":"integer","example":10},"titulo_conteudo":{"description":"Título do conteúdo no EAD.","type":"string","example":"Nome do curso"},"cadastro":{"description":"Data em que o aluno foi matriculado.","type":"date time","example":"2025-01-01 00:00:01"},"inicio":{"description":"Data início do conteúdo.","type":"date time","example":"2025-01-01 00:00:01"},"expira":{"description":"Data que encerra o acesso ao conteúdo.","type":"date time","example":"2025-01-01 00:00:01"},"ultimo_acesso":{"description":"Data do último acesso ao conteúdo.","type":"date time","example":"2025-01-01 00:00:01"},"visualizacoes":{"description":"Número de visualizações do conteúdo no EAD.","type":"integer","example":10},"tempo_assistido":{"description":"Tempo assistido do conteúdo.","type":"time","example":"00:20:01"},"status":{"description":"Status da matrícula. (1-Ativa / 2-Suspensa / 3-Cancelada / 4-Expirada)","type":"integer","example":"1"},"cupom":{"description":"Cupom utilizado na matrícula.","type":"string","example":"CHAVE"},"origem":{"description":"Origem do cadastrado no EAD. (1-Grátis / 2-Venda / 5-Cupom / 6-API / 7-Cobrança)","type":"integer","example":"2"},"situacao":{"description":"Situação da matrícula. (Não iniciado / Em progresso / Aprovado / Reprovado)","type":"string","example":"Em progresso"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Matrículas Conteúdo Único"],"summary":"Inserir uma matrícula de conteúdo único no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["conteudo_id","usuario_id"],"properties":{"conteudo_id":{"description":"Conteúdo Id","type":"integer"},"usuario_id":{"description":"Usuário Id","type":"integer"},"expira":{"description":"Período de acesso do aluno (Y-m-d H:i:s)","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"inicio":{"type":"string","example":"2025-10-11 00:00:00"},"expira":{"type":"string","example":"2024-10-11 00:00:00"},"conteudo_id":{"type":"integer","example":5},"aluno_id":{"type":"integer","example":55},"status":{"type":"integer","example":1},"origem":{"type":"integer","example":1},"cupom":{"type":"string","example":"CUPOMKEY"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Conflict","type":"integer","example":409},"message":{"type":"string","example":"Usuário já matriculado neste conteúdo."},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/enrollment/content/{id}":{"put":{"tags":["Matrículas Conteúdo Único"],"summary":"Atualizar uma matrícula de conteúdo único do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Matrícula Conteúdo Único Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"expira":{"description":"Período de acesso do aluno (Y-m-d H:i:s)","type":"string"},"status":{"description":"Status da Matrícula Conteúdo Único. (1-Ativa / 2-Suspensa / 3-Cancelada / 4-Vencido)","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"inicio":{"type":"string","example":"2025-10-11 00:00:00"},"expira":{"type":"string","example":"2024-10-11 00:00:00"},"conteudo_id":{"type":"integer","example":5},"aluno_id":{"type":"integer","example":55},"status":{"type":"integer","example":1},"origem":{"type":"integer","example":1},"cupom":{"type":"string","example":"CUPOMKEY"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Matrículas Conteúdo Único"],"summary":"Excluir uma matrícula de conteúdo único do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Matrícula Conteúdo Único Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/season":{"get":{"tags":["Gamificação"],"summary":"Listagem das temporadas de gamificação do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Temporada Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id da temporada","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status da temporada(0-Inativa / 1-Ativa / 2-Expirada)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"temporada_id":{"description":"Id da temporada cadastrada no EAD.","type":"integer","example":1},"temporada":{"description":"Nome da temporada.","type":"string","example":"Temporada 2024"},"status":{"description":"Status da temporada(0-Inativa / 1-Ativa / 2-Expirada).","type":"integer","example":1},"status_descricao":{"description":"Descrição do status da temporada.","type":"string","example":"active"},"periodo_limitado":{"description":"Indica se a temporada possui período limitado(0-Não / 1-Sim).","type":"integer","example":1},"periodo":{"description":"Ciclo da temporada(1-Semanal / 2-Quinzenal / 3-Mensal / 4-Semestral / 5-Anual).","type":"integer","example":3},"periodo_descricao":{"description":"Descrição do ciclo da temporada.","type":"string","example":"monthly"},"data_inicio":{"description":"Data de início da temporada.","type":"string","example":"2024-01-01 00:00:00"},"data_fim":{"nullable":true,"description":"Data de término da temporada, nulo quando o período é ilimitado.","type":"string","example":"2024-02-01 00:00:00"},"permite_resgate_apos_termino":{"description":"Permite resgate de recompensas após o término da temporada(0-Não / 1-Sim).","type":"integer","example":1},"curso_id":{"nullable":true,"description":"Id do curso da temporada, nulo quando a temporada é global.","type":"integer","example":10},"curso":{"nullable":true,"description":"Título do curso da temporada.","type":"string","example":"Curso de Programação"},"proxima_temporada_id":{"nullable":true,"description":"Id da próxima temporada.","type":"integer","example":2},"proxima_temporada":{"nullable":true,"description":"Nome da próxima temporada.","type":"string","example":"Temporada 2025"},"data_cadastro":{"description":"Data de cadastro da temporada.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/trigger":{"get":{"tags":["Gamificação"],"summary":"Listagem dos gatilhos de pontuação da gamificação do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Gatilho Id","schema":{"type":"integer"}},{"name":"temporada","in":"query","description":"Temporada Id vinculada ao gatilho","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status do gatilho(0-Inativo / 1-Ativo)","schema":{"type":"integer"}},{"name":"tipo","in":"query","description":"Tipo do gatilho(1-Produto / 2-Curso / 3-Módulo / 4-Aula / 5-Avaliação / 6-Fórum)","schema":{"type":"integer"}},{"name":"acao","in":"query","description":"Ação do gatilho(1-Acessar / 2-Concluir / 3-Comentar / 4-Compartilhar / 5-Matricular / 6-Avaliar / 7-Atingir média / 8-Publicar / 9-Comprar / 10-Curtir)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"gatilho_id":{"description":"Id do gatilho cadastrado no EAD.","type":"integer","example":1},"gatilho":{"description":"Nome do gatilho.","type":"string","example":"Concluir aula"},"status":{"description":"Status do gatilho(0-Inativo / 1-Ativo).","type":"integer","example":1},"tipo":{"description":"Tipo do gatilho(1-Produto / 2-Curso / 3-Módulo / 4-Aula / 5-Avaliação / 6-Fórum).","type":"integer","example":4},"tipo_descricao":{"description":"Descrição do tipo do gatilho.","type":"string","example":"lesson"},"acao":{"description":"Ação do gatilho(1-Acessar / 2-Concluir / 3-Comentar / 4-Compartilhar / 5-Matricular / 6-Avaliar / 7-Atingir média / 8-Publicar / 9-Comprar / 10-Curtir).","type":"integer","example":2},"acao_descricao":{"description":"Descrição da ação do gatilho.","type":"string","example":"complete"},"acao_limitada":{"description":"Indica se a ação possui limite de repetições(0-Não / 1-Sim).","type":"integer","example":0},"acao_limite_valor":{"nullable":true,"description":"Quantidade limite de repetições da ação.","type":"integer","example":5},"pontos":{"description":"Pontos concedidos pelo gatilho.","type":"integer","example":10},"desafio":{"description":"Indica se o gatilho é um desafio(0-Não / 1-Sim).","type":"integer","example":0},"desafio_quantidade":{"nullable":true,"description":"Quantidade necessária para concluir o desafio.","type":"integer","example":3},"registros_unicos":{"description":"Indica se o gatilho exige registros únicos(0-Não / 1-Sim).","type":"integer","example":0},"data_cadastro":{"description":"Data de cadastro do gatilho.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/level":{"get":{"tags":["Gamificação"],"summary":"Listagem dos níveis de gamificação do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Nível Id","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status do nível(0-Inativo / 1-Ativo)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"nivel_id":{"description":"Id do nível cadastrado no EAD.","type":"integer","example":1},"nivel":{"description":"Nome do nível.","type":"string","example":"Iniciante"},"status":{"description":"Status do nível(0-Inativo / 1-Ativo).","type":"integer","example":1},"status_descricao":{"description":"Descrição do status do nível.","type":"string","example":"active"},"pontos_minimos":{"description":"Pontuação mínima para atingir o nível.","type":"integer","example":100},"insignia_id":{"nullable":true,"description":"Id da insígnia vinculada ao nível.","type":"integer","example":3},"insignia":{"nullable":true,"description":"Nome da insígnia vinculada ao nível.","type":"string","example":"Insígnia Ouro"},"recompensa_id":{"nullable":true,"description":"Id da recompensa vinculada ao nível.","type":"integer","example":7},"recompensa":{"nullable":true,"description":"Título da recompensa vinculada ao nível.","type":"string","example":"Cupom de desconto"},"data_cadastro":{"description":"Data de cadastro do nível.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/badge":{"get":{"tags":["Gamificação"],"summary":"Listagem das insígnias de gamificação do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Insígnia Id","schema":{"type":"integer"}},{"name":"tipo","in":"query","description":"Tipo da insígnia(1-Primeiro lugar / 2-Segundo lugar / 3-Terceiro lugar / 4-Recompensa)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"insignia_id":{"description":"Id da insígnia cadastrada no EAD.","type":"integer","example":1},"insignia":{"description":"Nome da insígnia.","type":"string","example":"Insígnia Ouro"},"icone":{"nullable":true,"description":"Caminho do ícone da insígnia.","type":"string","example":"caminho.imagem.com"},"tipo":{"description":"Tipo da insígnia(1-Primeiro lugar / 2-Segundo lugar / 3-Terceiro lugar / 4-Recompensa).","type":"integer","example":1},"tipo_descricao":{"description":"Descrição do tipo da insígnia.","type":"string","example":"first_place"},"data_cadastro":{"description":"Data de cadastro da insígnia.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/reward":{"get":{"tags":["Gamificação"],"summary":"Listagem das recompensas de gamificação do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Recompensa Id","schema":{"type":"integer"}},{"name":"temporada","in":"query","description":"Temporada Id vinculada à recompensa","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status da recompensa(0-Rascunho / 1-Publicada)","schema":{"type":"integer"}},{"name":"tipo","in":"query","description":"Tipo da recompensa(1-Link externo / 2-Produto / 3-Cupom / 4-Insígnia / 5-Curso / 6-Conteúdo / 7-Aleatória)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"recompensa_id":{"description":"Id da recompensa cadastrada no EAD.","type":"integer","example":1},"recompensa":{"description":"Título da recompensa.","type":"string","example":"Cupom de desconto"},"status":{"description":"Status da recompensa(0-Rascunho / 1-Publicada).","type":"integer","example":1},"status_descricao":{"description":"Descrição do status da recompensa.","type":"string","example":"published"},"tipo":{"description":"Tipo da recompensa(1-Link externo / 2-Produto / 3-Cupom / 4-Insígnia / 5-Curso / 6-Conteúdo / 7-Aleatória).","type":"integer","example":3},"tipo_descricao":{"description":"Descrição do tipo da recompensa.","type":"string","example":"coupon"},"pontos":{"description":"Pontos necessários para liberar a recompensa.","type":"integer","example":500},"link_externo":{"nullable":true,"description":"Link externo da recompensa.","type":"string","example":"https://exemplo.com"},"produto_id":{"nullable":true,"description":"Id do produto da recompensa.","type":"integer","example":4},"produto":{"nullable":true,"description":"Título do produto da recompensa.","type":"string","example":"Produto Exemplo"},"cupom_id":{"nullable":true,"description":"Id do cupom da recompensa.","type":"integer","example":8},"cupom":{"nullable":true,"description":"Chave do cupom da recompensa.","type":"string","example":"CUPOM10"},"curso_id":{"nullable":true,"description":"Id do curso da recompensa.","type":"integer","example":10},"curso":{"nullable":true,"description":"Título do curso da recompensa.","type":"string","example":"Curso de Programação"},"conteudo_id":{"nullable":true,"description":"Id do conteúdo(biblioteca) da recompensa.","type":"integer","example":12},"conteudo":{"nullable":true,"description":"Título do conteúdo(biblioteca) da recompensa.","type":"string","example":"Ebook Exemplo"},"insignia_id":{"nullable":true,"description":"Id da insígnia da recompensa.","type":"integer","example":3},"insignia":{"nullable":true,"description":"Nome da insígnia da recompensa.","type":"string","example":"Insígnia Ouro"},"data_cadastro":{"description":"Data de cadastro da recompensa.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/ranking":{"get":{"tags":["Gamificação"],"summary":"Ranking dos alunos em uma temporada de gamificação do EAD.","operationId":null,"parameters":[{"name":"temporada","in":"query","description":"Temporada Id. Caso não informado, será utilizada a temporada ativa","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id, utilizado para localizar a temporada ativa do curso","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Aluno Id, retorna somente a posição do aluno informado","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"posicao":{"description":"Posição do aluno no ranking da temporada.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":25},"aluno":{"description":"Nome do aluno.","type":"string","example":"Exemplo"},"aluno_email":{"description":"E-mail do aluno.","type":"string","example":"email@email.com"},"pontos":{"description":"Total de pontos do aluno na temporada.","type":"integer","example":450},"temporada_id":{"description":"Id da temporada do ranking.","type":"integer","example":1}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/user":{"get":{"tags":["Gamificação"],"summary":"Dados de gamificação de um aluno do EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Aluno Id. Obrigatório quando o parâmetro aluno não for informado","schema":{"type":"integer"}},{"name":"aluno","in":"query","description":"E-mail do aluno. Obrigatório quando o parâmetro usuario_id não for informado","schema":{"type":"string"}},{"name":"temporada","in":"query","description":"Temporada Id. Caso não informado, será utilizada a temporada ativa","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id, utilizado para localizar a temporada ativa do curso","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":25},"aluno":{"description":"Nome do aluno.","type":"string","example":"Exemplo"},"aluno_email":{"description":"E-mail do aluno.","type":"string","example":"email@email.com"},"temporada_id":{"description":"Id da temporada considerada.","type":"integer","example":1},"temporada":{"description":"Nome da temporada considerada.","type":"string","example":"Temporada 2024"},"pontos":{"description":"Total de pontos do aluno na temporada.","type":"integer","example":450},"posicao":{"description":"Posição do aluno no ranking da temporada.","type":"integer","example":3},"total_insignias":{"description":"Total de insígnias conquistadas pelo aluno.","type":"integer","example":2},"total_recompensas_liberadas":{"description":"Total de recompensas liberadas para o aluno na temporada.","type":"integer","example":4},"total_recompensas_resgatadas":{"description":"Total de recompensas resgatadas pelo aluno na temporada.","type":"integer","example":1},"pontos_para_proximo_nivel":{"nullable":true,"description":"Pontos restantes para o aluno atingir o próximo nível.","type":"integer","example":50},"nivel_atual":{"nullable":true,"properties":{"nivel_id":{"type":"integer","example":2},"nivel":{"type":"string","example":"Intermediário"},"pontos_minimos":{"type":"integer","example":400}},"type":"object"},"proximo_nivel":{"nullable":true,"properties":{"nivel_id":{"type":"integer","example":3},"nivel":{"type":"string","example":"Avançado"},"pontos_minimos":{"type":"integer","example":500}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"usuario_id"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/user/badge":{"get":{"tags":["Gamificação"],"summary":"Listagem das insígnias conquistadas pelos alunos do EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Aluno Id","schema":{"type":"integer"}},{"name":"insignia","in":"query","description":"Insígnia Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do registro da insígnia conquistada.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":25},"aluno":{"description":"Nome do aluno.","type":"string","example":"Exemplo"},"aluno_email":{"description":"E-mail do aluno.","type":"string","example":"email@email.com"},"insignia_id":{"nullable":true,"description":"Id da insígnia conquistada.","type":"integer","example":3},"insignia":{"description":"Nome da insígnia conquistada.","type":"string","example":"Insígnia Ouro"},"icone":{"nullable":true,"description":"Caminho do ícone da insígnia.","type":"string","example":"caminho.imagem.com"},"data_conquista":{"description":"Data em que a insígnia foi conquistada.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/user/reward":{"get":{"tags":["Gamificação"],"summary":"Listagem das recompensas conquistadas pelos alunos do EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Aluno Id","schema":{"type":"integer"}},{"name":"temporada","in":"query","description":"Temporada Id","schema":{"type":"integer"}},{"name":"recompensa","in":"query","description":"Recompensa Id","schema":{"type":"integer"}},{"name":"resgatada","in":"query","description":"Filtra pelo resgate da recompensa(0-Não / 1-Sim)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do registro da recompensa conquistada.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":25},"aluno":{"description":"Nome do aluno.","type":"string","example":"Exemplo"},"aluno_email":{"description":"E-mail do aluno.","type":"string","example":"email@email.com"},"recompensa_id":{"nullable":true,"description":"Id da recompensa conquistada.","type":"integer","example":7},"recompensa":{"nullable":true,"description":"Título da recompensa conquistada.","type":"string","example":"Cupom de desconto"},"tipo":{"nullable":true,"description":"Tipo da recompensa(1-Link externo / 2-Produto / 3-Cupom / 4-Insígnia / 5-Curso / 6-Conteúdo / 7-Aleatória).","type":"integer","example":3},"tipo_descricao":{"nullable":true,"description":"Descrição do tipo da recompensa.","type":"string","example":"coupon"},"temporada_id":{"nullable":true,"description":"Id da temporada da recompensa.","type":"integer","example":1},"nivel_id":{"nullable":true,"description":"Id do nível que liberou a recompensa.","type":"integer","example":2},"link_externo":{"nullable":true,"description":"Link externo da recompensa.","type":"string","example":"https://exemplo.com"},"resgatada":{"description":"Indica se a recompensa foi resgatada(0-Não / 1-Sim).","type":"integer","example":1},"data_resgate":{"nullable":true,"description":"Data do resgate da recompensa.","type":"string","example":"2024-01-05 00:00:00"},"data_conquista":{"description":"Data em que a recompensa foi liberada.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/gamification/log":{"get":{"tags":["Gamificação"],"summary":"Histórico de pontuação da gamificação do EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Aluno Id","schema":{"type":"integer"}},{"name":"temporada","in":"query","description":"Temporada Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"gatilho","in":"query","description":"Gatilho Id","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial da pontuação no formato Y-m-d H:i:s","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final da pontuação no formato Y-m-d H:i:s","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do registro de pontuação.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":25},"aluno":{"description":"Nome do aluno.","type":"string","example":"Exemplo"},"aluno_email":{"description":"E-mail do aluno.","type":"string","example":"email@email.com"},"pontos":{"description":"Pontos registrados.","type":"integer","example":10},"gatilho_id":{"nullable":true,"description":"Id do gatilho que gerou a pontuação.","type":"integer","example":4},"gatilho":{"nullable":true,"description":"Nome do gatilho que gerou a pontuação.","type":"string","example":"Concluir aula"},"tipo":{"description":"Tipo do gatilho(1-Produto / 2-Curso / 3-Módulo / 4-Aula / 5-Avaliação / 6-Fórum).","type":"integer","example":4},"tipo_descricao":{"nullable":true,"description":"Descrição do tipo do gatilho.","type":"string","example":"lesson"},"acao":{"description":"Ação do gatilho(1-Acessar / 2-Concluir / 3-Comentar / 4-Compartilhar / 5-Matricular / 6-Avaliar / 7-Atingir média / 8-Publicar / 9-Comprar / 10-Curtir).","type":"integer","example":2},"acao_descricao":{"nullable":true,"description":"Descrição da ação do gatilho.","type":"string","example":"complete"},"desafio":{"description":"Indica se a pontuação é de um desafio(0-Não / 1-Sim).","type":"integer","example":0},"desafio_concluido":{"nullable":true,"description":"Indica se o desafio foi concluído(0-Não / 1-Sim).","type":"integer","example":1},"curso_id":{"nullable":true,"description":"Id do curso da pontuação.","type":"integer","example":10},"curso":{"nullable":true,"description":"Título do curso da pontuação.","type":"string","example":"Curso de Programação"},"temporada_id":{"nullable":true,"description":"Id da temporada da pontuação.","type":"integer","example":1},"temporada":{"nullable":true,"description":"Nome da temporada da pontuação.","type":"string","example":"Temporada 2024"},"origem":{"description":"Origem do registro de pontuação(1-Automática / 2-Manual).","type":"integer","example":1},"data_cadastro":{"description":"Data do registro de pontuação.","type":"string","example":"2024-01-01 00:00:00"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Módulo de gamificação não habilitado no plano","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Invalid action","type":"integer","example":406},"message":{"type":"string","example":"Invalid action"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/group":{"get":{"tags":["Grupos"],"summary":"Listagem de grupos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Grupo Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Listagem de grupos do EAD.","content":{"application/json":{"schema":{"properties":{"grupo_id":{"description":"Id do grupo cadastrado no EAD.","type":"integer","example":1},"grupo_nome":{"description":"Nome do grupo cadastrado no EAD.","type":"string","example":"Grupo Nome"},"status":{"description":"Estado do grupo cadastrado no EAD(0-Liberado / 1-Bloqueado).","type":"integer","example":0}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Grupos"],"summary":"Inserir um novo grupo no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["nome","userManager"],"properties":{"nome":{"description":"Nome do Grupo","type":"string(250)"},"userManager":{"description":"Id do usuário administrador do grupo","type":"int"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"grupo_nome":{"type":"string","example":"Nome do grupo"},"status":{"type":"integer","example":1},"aluno":{"type":"array","items":{"type":"string"},"collectionFormat":"multi","example":"[]"},"curso":{"type":"array","items":{"type":"string"},"collectionFormat":"multi","example":"[]"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/groupstudent/{id}":{"get":{"tags":["Grupos"],"summary":"Listagem de alunos por grupos do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Grupo Id","required":true,"schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os alunos de um grupo do EAD.","content":{"application/json":{"schema":{"properties":{"grupo_id":{"description":"Id do grupo cadastrado no EAD.","type":"integer","example":1},"grupo_nome":{"description":"Nome do grupo cadastrado no EAD.","type":"string","example":"Grupo Nome"},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":44},"nome":{"description":"Nome do usuário cadastrado no EAD.","type":"string","example":"Nome Exemplo"},"email":{"description":"E-mail do usuário cadastrado no EAD.","type":"string","example":"email@email.com"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/groupcourse/{id}":{"get":{"tags":["Grupos"],"summary":"Listagem de cursos por grupos do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Grupo Id","required":true,"schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os cursos de um grupo do EAD."},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/groupstudent":{"post":{"tags":["Grupos"],"summary":"Inserir um aluno em um grupo do EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["id","usuario_id"],"properties":{"id":{"description":"Grupo id","type":"integer"},"usuario_id":{"description":"Usuário id","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/groupcourse":{"post":{"tags":["Grupos"],"summary":"Inserir um curso em um grupo do EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["id","curso"],"properties":{"id":{"description":"Grupo id","type":"integer"},"curso":{"description":"Curso id","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/group/{id}":{"put":{"tags":["Grupos"],"summary":"Atualizar um grupo do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Grupo Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"nome":{"description":"Nome do Grupo","type":"string(250)"},"userManager":{"description":"Id do usuário administrador do grupo","type":"int"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"grupo_nome":{"type":"string","example":"Nome do grupo"},"status":{"type":"integer","example":1},"aluno":{"type":"array","items":{"properties":{"id":{"type":"integer","example":100},"nome":{"type":"string","example":"Nome do aluno"}},"type":"object"},"collectionFormat":"multi"},"curso":{"type":"array","items":{"properties":{"id":{"type":"integer","example":2},"titulo":{"type":"string","example":"Título do curso"}},"type":"object"},"collectionFormat":"multi"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/group/{id}/{excluir_matriculas}":{"delete":{"tags":["Grupos"],"summary":"Excluir um grupo do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Grupo Id","required":true,"schema":{"type":"integer"}},{"name":"excluir_matriculas","in":"path","description":"0-Não / 1-Sim","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/groupstudent/{id}/{usuario_id}/{excluir_matriculas}":{"delete":{"tags":["Grupos"],"summary":"Excluir um aluno de um grupo do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Grupo Id","required":true,"schema":{"type":"integer"}},{"name":"usuario_id","in":"path","description":"Usuário Id","required":true,"schema":{"type":"integer"}},{"name":"excluir_matriculas","in":"path","description":"0-Não / 1-Sim","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/groupcourse/{id}/{curso}/{excluir_matriculas}":{"delete":{"tags":["Grupos"],"summary":"Excluir um curso de um grupo do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Grupo Id","required":true,"schema":{"type":"integer"}},{"name":"curso","in":"path","description":"Curso Id","required":true,"schema":{"type":"integer"}},{"name":"excluir_matriculas","in":"path","description":"0-Não / 1-Sim","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/lesson":{"get":{"tags":["Cursos"],"summary":"Listagem de aulas do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Aula Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"modulo_id","in":"query","description":"Módulo Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as aulas de um curso.","content":{"application/json":{"schema":{"properties":{"aula_id":{"description":"Id da aula do curso.","type":"integer","example":10},"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":1},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Curso Exemplo"},"modulo_id":{"description":"Id do módulo do curso.","type":"integer","example":1},"modulo_titulo":{"description":"Título do módulo do curso.","type":"string","example":"Módulo Exemplo"},"ordem":{"description":"Ordem da aula do curso.","type":"integer","example":3},"aula_titulo":{"description":"Título da aula do curso.","type":"string","example":"Aula Exemplo"},"conteudo_id":{"description":"Id do conteúdo cadastrado na aula.","type":"integer","example":183},"descricao":{"description":"Descrição da aula do curso.","type":"string","example":"Descrição da aula"},"aula_demo":{"description":"Define se a aula esta como demonstração na página do curso. (0-Não / 1-Sim)","type":"integer","example":0},"status":{"description":"Status da aula do curso. (0-Rascunho / 1-Publicado)","type":"integer","example":1},"duracao":{"description":"Duracao de videos e audio da aula.","type":"string","example":"10:00"},"link_aula":{"description":"Link da aula para usuários matriculados e logados.","type":"string","example":"//seuead.com/lesson/detail/1/132"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/log":{"get":{"tags":["Log de acesso e Progresso do aluno"],"summary":"Listagem de log visualização de aula.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Aula Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial do período de busca (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de busca (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os logs de acessos de um aluno em uma aula.","content":{"application/json":{"schema":{"properties":{"log_id":{"description":"Id do log gerado no EAD.","type":"integer","example":1},"curso_id":{"description":"Id do curso no EAD.","type":"integer","example":10},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Título do curso"},"modulo_id":{"description":"Id do módulo cadastrado no EAD.","type":"integer","example":345},"modulo_titulo":{"description":"Título do módulo","type":"string","example":"Título do módulo"},"aula_id":{"description":"Id da aula cadastrada no EAD.","type":"integer","example":"4"},"aula_titulo":{"description":"Título da aula.","type":"string","example":""},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":"45"},"aluno_nome":{"description":"Nome do aluno.","type":"string","example":"Nome do aluno"},"ultima_visualizacao":{"description":"Data e hora da última visualização da aula.","type":"datetime","example":""},"tempo_aula":{"description":"Tempo total de permanência em uma aula.","type":"time","example":"03:00:00"},"data_conclusao":{"description":"Data e hora da conclusão da aula.","type":"datetime","example":"2020-03-25 19:10:40"},"aula_concluido":{"description":"Status de conclusão da aula(0-Não / 1-Sim).","type":"int","example":"1"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Log de acesso e Progresso do aluno"],"summary":"Excluir log e progresso de um aluno em um curso, módulo ou aula.","operationId":null,"parameters":[{"name":"curso","in":"query","description":"Curso Id.","required":true,"schema":{"type":"integer"}},{"name":"aluno_id","in":"query","description":"Aluno Id.","required":true,"schema":{"type":"integer"}},{"name":"modulo_id","in":"query","description":"Modulo Id.","required":false,"schema":{"type":"integer"}},{"name":"aula_id","in":"query","description":"Aula Id.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/module":{"get":{"tags":["Cursos"],"summary":"Listagem dos módulos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Módulo Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os módulos de aulas do EAD.","content":{"application/json":{"schema":{"properties":{"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":1},"curso_titulo":{"description":"Título do curso.","type":"string","example":"Curso Exemplo"},"carga_horaria":{"description":"Carga horária do módulo do curso.","type":"string","example":"500"},"modulo_id":{"description":"Id do módulo do curso.","type":"integer","example":1},"ordem":{"description":"Ordem do módulo do curso.","type":"integer","example":3},"modulo_titulo":{"description":"Título do módulo do curso.","type":"string","example":"Módulo Exemplo"},"descricao":{"description":"Descrição da aula do curso.","type":"string","example":"Descrição do módulo"},"status":{"description":"Status do módulo do curso. (0-Rascunho / 1-Publicado)","type":"integer","example":1}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Cursos"],"summary":"Cadastro de um módulo do EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["curso_id","user_id","title","status"],"properties":{"curso_id":{"description":"Id do curso cadastrado no EAD","type":"integer","example":"12"},"user_id":{"description":"Id do usuário cadastrado no EAD","type":"integer","example":"3"},"title":{"description":"Título do módulo.","type":"string","example":"Titulo do meu módulo"},"status":{"description":"Status do módulo. (0-Rascunho / 1-Publicado)","type":"integer"},"description":{"description":"Descrição do módulo.","type":"string","example":"Descrição do meu módulo"}},"type":"object"}}}},"responses":{"200":{"description":"Cadastra um módulo de aulas do EAD.","content":{"application/json":{"schema":{"properties":{"curso_id":{"description":"Id do curso vinculado ao módulo cadastrado no EAD.","type":"integer","example":12},"curso_titulo":{"description":"Título do curso vinculado ao módulo cadastrado no EAD.","type":"string","example":"Meu curso"},"carga_horaria":{"description":"Carga horária do curso vinculado ao módulo cadastrado no EAD.","type":"string","example":"104:10"},"modulo_id":{"description":"Id do módulo cadastrado no EAD.","type":"integer","example":4},"modulo_titulo":{"description":"Título do módulo cadastrado no EAD.","type":"string","example":"Titulo do meu módulo"},"descricao":{"description":"Descrição do módulo cadastrado no EAD.","type":"string","example":"Descrição do meu módulo"},"status":{"description":"Status do módulo do curso. (0-Rascunho / 1-Publicado","type":"integer","example":"0"}},"type":"object"}}}},"204":{"description":"No content"},"406":{"description":"Not found"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/module/{id}":{"put":{"tags":["Cursos"],"summary":"Editar um módulo do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Module Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"user_id":{"description":"Id do usuário cadastrado no EAD","type":"integer","example":"3"},"title":{"description":"Título do módulo.","type":"string","example":"Titulo do meu módulo"},"status":{"description":"Status do módulo. (0-Rascunho / 1-Publicado)","type":"integer"},"description":{"description":"Descrição do módulo.","type":"string","example":"Descrição do meu módulo"},"order":{"description":"Ordem de exibição do módulo.","type":"integer","example":"3"}},"type":"object"}}}},"responses":{"200":{"description":"Edita um módulo de aulas do EAD.","content":{"application/json":{"schema":{"properties":{"curso_titulo":{"description":"Título do curso vinculado ao módulo cadastrado no EAD.","type":"string","example":"Meu curso"},"carga_horaria":{"description":"Carga horária do curso vinculado ao módulo cadastrado no EAD.","type":"string","example":"104:10"},"modulo_id":{"description":"Id do módulo cadastrado no EAD.","type":"integer","example":4},"modulo_titulo":{"description":"Título do módulo cadastrado no EAD.","type":"string","example":"Titulo do meu módulo"},"descricao":{"description":"Descrição do módulo cadastrado no EAD.","type":"string","example":"Descrição do meu módulo"},"status":{"description":"Status do módulo do curso. (0-Rascunho / 1-Publicado","type":"integer","example":"0"}},"type":"object"}}}},"204":{"description":"No content"},"406":{"description":"Not found"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Cursos"],"summary":"Remover um módulo do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Module Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Remove um módulo de aulas do EAD.","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"204":{"description":"No content"},"406":{"description":"Not found"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/library":{"get":{"tags":["Biblioteca"],"summary":"Listagem dos arquivos enviados na plataforma.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Biblioteca Id","schema":{"type":"integer"}},{"name":"product_mode","in":"query","description":"Filtrar por arquivo com permissão para usar em produto de conteúdo único (0-Não / 1-Sim)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os arquivos enviados na plataforma.","content":{"application/json":{"schema":{"properties":{"biblioteca_id":{"description":"Id do arquivo cadastrado no EAD.","type":"integer","example":1},"usuario_id":{"description":"Id do usuário que cadastrou o arquivo.","type":"integer","example":10},"nome":{"description":"Data e hora do cadastro do arquivo.","type":"datetime","example":"2019-01-01 00:14:00"},"status":{"description":"Status do arquivo(0-Rascunho / 1-Publicado).","type":"integer","example":0},"tipo_conteudo":{"description":"Tipo do arquivo enviado(Tipo Storage - Videos enviados para EAD Plataforma / MP3 / Vídeo / Slide / URL / Texto / Arquivos em PDF.).","type":"string","example":"2020-01-01 00:00:01"},"url":{"description":"Caminho do arquivo cadastrado no EAD.\t","type":"string","example":""},"arquivo":{"description":"Nome do arquivo cadastrado no EAD.","type":"string","example":"Arquivo.pdf"},"extensao":{"description":"Extensão do arquivo enviado.","type":"string","example":"pdf"},"texto":{"description":"Conteúdo html cadastrado no EAD.","type":"string","example":""},"paginas":{"description":"Número de páginas de arquivo tipo texto.","type":"integer","example":3},"duracao":{"description":"\tDuração de um arquivo de áudio ou vídeo.","type":"time","example":"02:00"},"filesize":{"description":"Tamanho do arquivo enviado.","type":"string","example":""},"periodo_acesso":{"description":"Período de Acesso em número de dias.","type":"integer","example":360},"foto":{"description":"Imagem do conteúdo.","type":"string","example":"foto.jpg"},"permitir_matricula_conteudo":{"description":"Permitir que use esse arquivo para produto de conteúdo único(0-Não / 1-Sim).","type":"integer","example":0}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/library/{id}":{"put":{"tags":["Biblioteca"],"summary":"Atualizar um arquivo da biblioteca.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Id do arquivo cadastrado no EAD","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"usuario_id":{"description":"Id do usuário que cadastrou o arquivo","type":"integer"},"paginas":{"description":"Número de páginas do arquivos","type":"integer"},"duracao":{"description":"Duracao de arquivos áudio ou vídeo","type":"string"},"nome":{"description":"Nome do arquivo","type":"string"},"status":{"description":"0-Rascunho / 1-Publicado","type":"integer"},"periodo_acesso":{"description":"Período em dias","type":"integer"},"acesso_vitalicio":{"description":"0-Não / 1-Sim","type":"integer"},"permitir_matricula_conteudo":{"description":"0-Não / 1-Sim","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"arquivo":{"type":"string","example":"Nome do arquivo"},"extensao":{"type":"string","example":"pdf"},"url":{"type":"string","example":"caminho.arquivo.com"},"texto":{"type":"string","example":""},"paginas":{"type":"integer","example":20},"duracao":{"type":"string","example":"00:15"},"status":{"type":"integer","example":1},"periodo_acesso":{"type":"integer","example":365},"acesso_vitalicio":{"type":"integer","example":1},"permitir_matricula_conteudo":{"type":"integer","example":1}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Biblioteca"],"summary":"Excluir um arquivo da biblioteca.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Id do arquivo enviado","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/login":{"post":{"tags":["Usuários"],"summary":"Logar um usuário no EAD através de um link.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["email","password"],"properties":{"email":{"description":"E-mail do usuário cadastrado no EAD.","type":"string"},"password":{"description":"Senha do usuário cadastrado no EAD.","type":"string"},"url":{"description":"Url de redirecionamento após login.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"link":{"description":"","type":"string","example":"eadlive.com/login/api/token"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Conflict","type":"integer","example":409},"message":{"type":"string","example":"User Blocked."},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/login/sso":{"post":{"tags":["Usuários"],"summary":"Logar um usuário no EAD através de um link.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["email"],"properties":{"email":{"description":"E-mail do usuário cadastrado no EAD.","type":"string"},"url":{"description":"Url de redirecionamento após login.","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"link":{"description":"","type":"string","example":"eadlive.com/login/api/token"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Conflict","type":"integer","example":409},"message":{"type":"string","example":"User Blocked."},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/product":{"get":{"tags":["Produtos"],"summary":"Listagem dos produtos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Produto Id","schema":{"type":"integer"}},{"name":"tipo","in":"query","description":"Tipo do Produto(1-Curso / 2-Assinatura / 4-Combo / 5-Certificado / 6-Período / 7-Suporte / 9-Ebook / 10-Mentoria).","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"conteudo","in":"query","description":"Conteúdo Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os produtos cadastrados do EAD.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do plano cadastrado no EAD.","type":"integer","example":1},"titulo":{"description":"Nome do plano cadastrado no EAD.","type":"string","example":""},"status":{"description":"Status do produto(0-Rascunho / 1-Publicado / 2-Não Listado).","type":"integer","example":"Categoria Exemplo"},"tipo":{"description":"Tipo do Produto(1-Curso / 2-Assinatura / 4-Combo / 5-Certificado / 6-Período / 7-Suporte / 9-Ebook / 10-Mentoria).","type":"integer","example":1},"contrato":{"description":"Ciclo de cobrança.","type":"string","example":""},"responsavel_id":{"description":"Responsável pelo plano.","type":"integer","example":10},"destaque":{"description":"Dar destaque ao plano na listagem de planos(0-Não / 1-Sim).","type":"integer","example":1},"ordem":{"description":"Ordem que será listado o plano.","type":"integer","example":2},"img_background":{"description":"Imagem de fundo página do plano.","type":"string","example":""},"img_destaque":{"description":"Imagem do plano.","type":"string","example":""},"video_destaque":{"description":"Video do plano.","type":"string","example":""},"descricao":{"description":"Descrição curta do plano(Limitado a 160 caracteres.).","type":"string","example":""},"url_produto":{"description":"Url do produto.","type":"string","example":""},"sobre":{"description":"Descrição longa sobre o produto.","type":"string","example":""},"resumo":{"description":"Resumo do produto, usado para SEO.","type":"string","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/plan":{"get":{"tags":["Planos"],"summary":"Listagem de planos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Plano Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os planos cadastrados do EAD.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do plano cadastrado no EAD.","type":"integer","example":1},"titulo":{"description":"Nome do plano cadastrado no EAD.","type":"string","example":""},"status":{"description":"Status do produto(0-Rascunho / 1-Publicado / 2-Não Listado).","type":"integer","example":"1"},"contrato":{"description":"Ciclo de cobrança.","type":"string","example":""},"responsavel_id":{"description":"Responsável pelo plano.","type":"integer","example":10},"destaque":{"description":"Dar destaque ao plano na listagem de planos(0-Não / 1-Sim).","type":"integer","example":1},"ordem":{"description":"Ordem que será listado o plano.","type":"integer","example":2},"img_background":{"description":"Imagem de fundo página do plano.","type":"string","example":""},"img_destaque":{"description":"Imagem do plano.","type":"string","example":""},"video_destaque":{"description":"Video do plano.","type":"string","example":""},"descricao":{"description":"Descrição curta do plano(Limitado a 160 caracteres.).","type":"string","example":""},"url_plano":{"description":"Url do plano.","type":"string","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/plancourses":{"get":{"tags":["Planos"],"summary":"Listagem dos cursos de um plano do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Plano Id","required":true,"schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of data returned per page, default value 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indicates the start of reading, if not informed default value will be 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os cursos em um plano cadastrado do EAD.","content":{"application/json":{"schema":{"properties":{"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":1},"titulo":{"description":"Nome do curso cadastrado no EAD.","type":"string","example":""},"emitir_certificado":{"description":"Determina se o curso emitirá certificado(0-Não / 1-Sim).","type":"integer","example":1},"foto":{"description":"Imagem do curso.","type":"string","example":""},"carga_horaria":{"description":"Carga horária do Curso.","type":"string","example":""},"url_curso":{"description":"Url do curso cadastrado no EAD.","type":"string","example":""},"total_aulas":{"description":"Total de aulas do curso.","type":"integer","example":155},"total_modulos":{"description":"Total de módulos do curso.","type":"integer","example":17}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Planos"],"summary":"Inserir um curso em um plano do EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["product","curso"],"properties":{"product":{"description":"Produto Id","type":"integer"},"curso":{"description":"Curso Id","type":"integer"},"allow_enroll":{"description":"Ignora o ciclo de pagamentos para matricular os alunos com status de assinatura concluído! Enviar 0 para desativar | 1 para ativar.","type":"integer","example":"0"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/plancontents":{"get":{"tags":["Planos"],"summary":"Listagem dos conteúdos de um plano do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Plano Id","required":true,"schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Maximum number of data returned per page, default value 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indicates the start of reading, if not informed default value will be 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os conteúdos em um plano cadastrado do EAD.","content":{"application/json":{"schema":{"properties":{"conteudo_id":{"description":"Id do conteúdo cadastrado no EAD.","type":"integer","example":1},"titulo":{"description":"Titulo do conteúdo cadastrado no EAD.","type":"string","example":""},"foto":{"description":"Imagem do conteúdo.","type":"string","example":""},"url_conteudo":{"description":"Url do conteúdo cadastrado no EAD.","type":"string","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Planos"],"summary":"Inserir um conteúdo em um plano do EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["product","library"],"properties":{"product":{"description":"Produto Id","type":"integer"},"library":{"description":"Conteúdo Id","type":"integer"},"allow_enroll":{"description":"Ignora o ciclo de pagamentos para matricular os alunos com status de assinatura concluído! Enviar 0 para desativar | 1 para ativar.","type":"integer","example":"0"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/plan/{id}":{"delete":{"tags":["Planos"],"summary":"Excluir um plano do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Produto Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Conflict","type":"integer","example":409},"message":{"type":"string","example":"Existem assinaturas associadas a este plano!"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/plancourses/{id}/{curso}":{"delete":{"tags":["Planos"],"summary":"Excluir um curso de um plano do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Produto Id","required":true,"schema":{"type":"integer"}},{"name":"curso","in":"path","description":"Course Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/plancontents/{id}/{conteudo}":{"delete":{"tags":["Planos"],"summary":"Excluir um conteúdo de um plano do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Produto Id","required":true,"schema":{"type":"integer"}},{"name":"conteudo","in":"path","description":"Conteúdo Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/charge":{"get":{"tags":["Cobranças"],"summary":"Listagem das cobranças cadastradas no EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Cobrança Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"email","in":"query","description":"E-mail do aluno","schema":{"type":"string"}},{"name":"data_inicio","in":"query","description":"Data de início do período de busca por data de vencimento (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data de fim do período de busca por data de vencimento (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as cobranças cadastradas do EAD.","content":{"application/json":{"schema":{"properties":{"cobranca_id":{"description":"Id da cobrança cadastrada no EAD.","type":"integer","example":1},"status":{"description":"Status da cobrança(0-Aguardando / 1-Aguardando Pagamento / 2-Sucesso / 3-Cancelado).","type":"integer","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":44},"tipo_pagamento":{"description":"Tipo do pagamento(1-Cartão e Boleto / 2-Cartão / 3-Boleto).","type":"integer","example":1},"data_vencimento":{"description":"Data de vencimento da cobrança.","type":"datetime","example":"2020-01-01 00:00:01"},"parcelas_sem_juros":{"description":"Quantidade de parcelas sem juros.","type":"integer","example":12},"parcelas_max":{"description":"Quantidade de parcelas permitidas.","type":"integer","example":12},"valor":{"description":"Valor da cobrança.","type":"float","example":""},"publicada":{"description":"\tCobrança publicada ou rascunho(0-Rascunho / 1-Publicada).","type":"integer","example":1},"url_cobranca_curso":{"description":"Endereço público da cobrança.","type":"string","example":""},"responsavel_id":{"description":"Responsável pela cobrança.","type":"integer","example":""},"boleto_url":{"description":"Endereço do boleto gerado.","type":"string","example":""},"boleto_codigo":{"description":"Código do boleto gerado.","type":"string","example":""},"pix_code":{"description":"Código do pix gerado.","type":"string","example":""},"nome":{"description":"Nome do aluno.","type":"string","example":""},"email":{"description":"E-mail do aluno ou responsável","type":"string","example":"professor(a)@email.com"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/publishcharge/{id}":{"put":{"tags":["Cobranças"],"summary":"Publicar uma cobrança criada no EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Cobrança Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"cobranca_id":{"type":"integer","example":1},"status":{"type":"integer","example":1},"email":{"type":"string","example":"email@email.com"},"valor":{"type":"string","example":"90.00"},"tipo_pagamento":{"type":"integer","example":1},"data_vencimento":{"type":"string","example":"2021-12-04"},"parcelas_max":{"type":"integer","example":10},"parcelas_sem_juros":{"type":"integer","example":10},"publicada":{"type":"integer","example":1},"boleto_url":{"type":"string","example":"meuboleto.com.br"},"pix_code":{"type":"string","example":"PIX_CODE"},"usuario_id":{"type":"integer","example":334},"responsavel_id":{"type":"integer","example":3}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/charge/{id}":{"delete":{"tags":["Cobranças"],"summary":"Excluir uma cobrança do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Cobrança Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/coupon":{"get":{"tags":["Cupons"],"summary":"Listagem de cupons do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Cupom Id, se enviar cupom id não é necessário envio da chave do cupom","schema":{"type":"integer"}},{"name":"chave","in":"query","description":"Chave do Cupom, se enviar chave do cupom não é necessário envio do cupom id","schema":{"type":"string"}},{"name":"data_inicio","in":"query","description":"Data período inicial do cupom (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data período final do cupom (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os cupons cadastrados do EAD.","content":{"application/json":{"schema":{"properties":{"cupom_id":{"description":"Id do cupom cadastrado no EAD.","type":"integer","example":1},"chave":{"description":"Chave do cupom.","type":"string","example":""},"desconto":{"description":"Valor do desconto.","type":"string","example":""},"quantidade":{"description":"Quantidade do cupom criado.","type":"integer","example":""},"contador":{"description":"Número de vezes que foi usado.","type":"integer","example":""},"produto_id":{"description":"Id do curso ou plano cadastrado no EAD.","type":"integer","example":1},"professor_id":{"description":"Id do professor(a) responsável pelo cupom.","type":"integer","example":1},"cupom_formato":{"description":"\tFormato do desconto, valor em dinheiro ou porcentagem(1-Moeda / 2-Porcentagem).","type":"integer","example":1},"inicio":{"description":"Data e hora de início do cupom.","type":"datetime","example":""},"expira":{"description":"Data e hora de vencimento do cupom.","type":"datetime","example":""},"status":{"description":"Status do cupom, publicado ou rascunho(0-Rascunho / 1-Publicado).","type":"integer","example":""},"tipo":{"description":"Para cursos ou assinatura(1-Todos / 2-Carrinho / 3-Produto / 4-Assinatura).","type":"integer","example":""},"todos":{"description":"Cupom é aplicável a todos produtos do tipo escolhido (0-Não / 1-Sim)","type":"integer","example":""},"cobrancas":{"description":"Número de cobranças que o desconto do cupom será aplicado, apenas assinatura.","type":"integer","example":""},"vitalicio":{"description":"Se o desconto do cupom será válido até o final da assinatura(0-Não / 1-Sim).","type":"integer","example":""},"url_cupom":{"description":"Link para o checkou com desconto aplicado.","type":"strubg","example":""}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Cupons"],"summary":"Inserir um novo cupom no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["chave","usuario_id","cupom_formato","desconto","quantidade","status","tipo","todos","publico","vitalicio","cobrancas","inicio","expira","recorrente"],"properties":{"produto_id":{"description":"Produto Id","type":"integer"},"chave":{"description":"Chave do Cupom","type":"string(30)"},"usuario_id":{"description":"Usuário Id","type":"integer"},"cupom_formato":{"description":"Formato do desconto(1-Moeda / 2-Porcentagem)","type":"integer"},"desconto":{"description":"Valor do Desconto","type":"float"},"quantidade":{"description":"Quantidade de cupons","type":"integer"},"status":{"description":"0-Rascunho / 1-Publicado","type":"integer"},"tipo":{"description":"1-Curso / 2-Assinatura / 3-Combo","type":"integer"},"recorrente":{"description":"0-Não / 1-Sim","type":"integer"},"todos":{"description":"0-Não / 1-Sim","type":"integer"},"oferta_id":{"description":"Enviar ofertas separadas por vírgulas Ex: 12,34,50","type":"array","items":{"type":"integer"},"collectionFormat":"multi"},"publico":{"description":"0-Não / 1-Sim","type":"integer"},"vitalicio":{"description":"Apenas para assinatura(0-Limitado / 1-Ilimitado)","type":"integer"},"cobrancas":{"description":"Número de cobranças com desconto, somente duração limitado, apenas para assinatura","type":"integer"},"inicio":{"description":"Data e hora do início da promoção","type":"datetime"},"expira":{"description":"Data e hora do término do cupom","type":"datetime"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"key":{"type":"string","example":"KEYCODE"},"status":{"type":"integer","example":1},"publico":{"type":"integer","example":0},"tipo":{"type":"integer","example":1},"todos":{"type":"integer","example":0},"cupom_formato":{"type":"integer","example":1},"desconto":{"type":"string","example":"10"},"quantidade":{"type":"integer","example":10},"inicio":{"type":"string","example":"2021-12-01 00:00:00"},"expira":{"type":"string","example":"2021-12-31 00:00:00"},"recorrente":{"type":"integer","example":1},"vitalicio":{"type":"integer","example":0},"cobrancas":{"type":"integer","example":10},"produto_id":{"type":"integer","example":3},"oferta_id":{"type":"array","items":{"type":"integer","example":2},"collectionFormat":"multi"},"usuario_id":{"type":"integer","example":5}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/coupon/{id}":{"put":{"tags":["Cupons"],"summary":"Atualizar um cupom do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Cupom Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"produto_id":{"description":"Id do curso ou Id do plano","type":"integer"},"cupom_formato":{"description":"Formato do desconto(1-Moeda / 2-Porcentagem)","type":"integer"},"desconto":{"description":"Valor do Desconto","type":"float"},"quantidade":{"description":"Quantidade de cupons","type":"integer"},"status":{"description":"0-Rascunho / 1-Publicado","type":"integer"},"todos":{"description":"0-Não / 1-Sim","type":"integer"},"recorrente":{"description":"0-Não / 1-Sim","type":"integer"},"oferta_id":{"description":"Enviar ofertas separadas por vírgulas Ex: 12,34,50","type":"array","items":{"type":"integer"},"collectionFormat":"multi"},"publico":{"description":"0-Não / 1-Sim","type":"integer"},"vitalicio":{"description":"Apenas para assinatura(0-Limitado / 1-Ilimitado)","type":"integer"},"cobrancas":{"description":"Número de cobranças com desconto, somente duração limitado, apenas para assinatura","type":"integer"},"inicio":{"description":"Início da promoção","type":"datetime"},"expira":{"description":"Validade do cupom","type":"datetime"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"key":{"type":"string","example":"KEYCODE"},"status":{"type":"integer","example":1},"publico":{"type":"integer","example":0},"tipo":{"type":"integer","example":1},"todos":{"type":"integer","example":0},"cupom_formato":{"type":"integer","example":1},"desconto":{"type":"string","example":"10"},"quantidade":{"type":"integer","example":10},"inicio":{"type":"string","example":"2021-12-01 00:00:00"},"expira":{"type":"string","example":"2021-12-31 00:00:00"},"recorrente":{"type":"integer","example":1},"vitalicio":{"type":"integer","example":0},"cobrancas":{"type":"integer","example":10},"produto_id":{"type":"integer","example":3},"oferta_id":{"type":"array","items":{"type":"integer","example":2},"collectionFormat":"multi"},"usuario_id":{"type":"integer","example":5}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Cupons"],"summary":"Excluir um cupom do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Cupom Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/product/offer":{"get":{"tags":["Produtos"],"summary":"Listagem das ofertas dos produtos no EAD.","operationId":null,"parameters":[{"name":"oferta_id","in":"query","description":"Oferta Id","schema":{"type":"integer"}},{"name":"produto","in":"query","description":"Produto Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"opcao_venda","in":"query","description":"Opção Venda (1-EAD / 2-Hotmart / 3-Edduzz / 4-Grátis / 6-Braip / 7-Monetizze / 8-Kiwify / 10-AppMax / 11-Doppus / 12-Ticto / 13-Abmex / 14-PerfectPay / 17-Yampi / 18-CartPanda / 19-Kirvano / 20-Recorrência / 21-ApenasVisualização / 22-EduzzV2). A opção 3-Edduzz retorna as ofertas das duas versões da Eduzz(3 e 22).","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as ofertas dos produtos cadastrados no EAD.","content":{"application/json":{"schema":{"properties":{"oferta_id":{"description":"Id da oferta cadastrada no EAD.","type":"integer","example":1},"oferta_status":{"description":"Status da oferta(0-Rascunho / 1-Publicado).","type":"integer","example":"Categoria Exemplo"},"oferta_titulo":{"description":"Título da oferta.","type":"string","example":""},"oferta_link":{"description":"Link da oferta.","type":"string","example":""},"preco_sem_desconto":{"description":"Preço sem desconto.","type":"float","example":""},"preco":{"description":"Preço do produto.","type":"float","example":""},"opcao_venda":{"description":"Define o modelo de venda do Produto(1-EAD / 2-Hotmart / 3-Edduzz / 4-Grátis / 6-Braip / 7-Monetizze / 8-Kiwify / 10-AppMax / 11-Doppus / 12-Ticto / 13-Abmex / 14-PerfectPay / 17-Yampi / 18-CartPanda / 19-Kirvano / 20-Recorrência / 21-ApenasVisualização / 22-EduzzV2).","type":"integer","example":""},"tipo_checkout":{"description":"Determina a forma de funcionamento do Checkout(1-Padrão / 2-Personalizado, válido apenas para vendas com EAD Checkout).","type":"integer","example":""},"opcao_pagamento":{"description":"Define as opções de pagamento que o curso aceitará(1-Boleto e cartão de crédito / 2-Cartão de crédito / 3-Boleto, válido apenas para EAD Checkout).","type":"integer","example":""},"tipo_boleto_vencimento":{"description":"Período ou data fixa(1-Período / 2-Data Fixa).","type":"integer","example":""},"periodo_boleto_venc":{"description":"Período em dias de vencimento do boleto","type":"integer","example":""},"data_venc_boleto":{"description":"Determina um data específica para o vencimento dos boletos","type":"integer","example":""},"tipo_pix_vencimento":{"description":"Período ou data fixa(1-Período / 2-Data Fixa).","type":"integer","example":""},"periodo_pix_venc":{"description":"Período em dias de vencimento do pix","type":"integer","example":""},"data_venc_pix":{"description":"Determina um data específica para o vencimento dos pix","type":"integer","example":""},"parcelamento_maximo":{"description":"Número máximo de parcelas para vendas com cartão de crédito.","type":"integer","example":""},"parcelamento_sem_juros":{"description":"Número máximo de parcelas sem juros para vendas com cartão de crédito.","type":"integer","example":""},"external_checkout_code":{"description":"Código do produto externo.","type":"string","example":""},"external_checkout_link":{"description":"Link Externo.","type":"string","example":""},"produto_id":{"description":"Id do plano cadastrado no EAD.","type":"integer","example":1},"titulo":{"description":"Nome do plano cadastrado no EAD.","type":"string","example":""},"status_produto":{"description":"Status do produto(0-Rascunho / 1-Publicado / 2-Não Listado).","type":"integer","example":"Categoria Exemplo"},"tipo":{"description":"Tipo do Produto(1-Curso / 2-Assinatura / 4-Combo / 5-Certificado / 6-Período / 7-Suporte / 9-Ebook / 10-Mentoria).","type":"integer","example":1},"ciclo":{"description":"Ciclo de cobrança(1-Mensal / 2-Trimestral / 3-Semestral / 4-Anual).","type":"integer","example":""},"contrato":{"description":"Ciclo de cobrança.","type":"string","example":""},"vitalicio":{"description":"Até o aluno cancelar(0-Não / 1-Sim).","type":"integer","example":1},"renovacao":{"description":"Renovação automática do plano(0-Não / 1-Sim).","type":"integer","example":1},"responsavel_id":{"description":"Responsável pelo plano.","type":"integer","example":10},"destaque":{"description":"Dar destaque ao plano na listagem de planos(0-Não / 1-Sim).","type":"integer","example":1},"ordem":{"description":"Ordem que será listado o plano.","type":"integer","example":2},"img_background":{"description":"Imagem de fundo página do plano.","type":"string","example":""},"img_destaque":{"description":"Imagem do plano.","type":"string","example":""},"video_destaque":{"description":"Video do plano.","type":"string","example":""},"descricao":{"description":"Descrição curta do plano(Limitado a 160 caracteres.).","type":"string","example":""},"sobre":{"description":"Descrição longa sobre o produto.","type":"string","example":""},"resumo":{"description":"Resumo do produto, usado para SEO.","type":"string","example":""},"acesso_conteudo":{"description":"Tipo de acesso(1-Manter período / 2-Novo período / 3-Vitalício).","type":"integer","example":""},"acesso_periodo_conteudo":{"description":"Período em dias.","type":"integer","example":""},"suporte_conteudo":{"description":"Tipo de suporte(1-Manter período / 2-Novo período / 3-Vitalício).","type":"integer","example":""},"suporte_periodo_conteudo":{"description":"Período em dias.","type":"integer","example":""},"limite_inscricao":{"description":"Limite de inscrição ativado(0-Não / 1-Sim).","type":"integer","example":""},"numero_maximo_inscricao":{"description":"Quantidade máxima de inscrição.","type":"integer","example":""},"oferta_alternativa_id":{"description":"Id da oferta alternativa cadastrada no EAD.","type":"integer","example":1},"programar_inscricao":{"description":"Programar Inscrição(0-Não / 1-Sim).","type":"integer","example":""},"inicio_vendas":{"description":"Data da abertura do carrinho.","type":"datetime","example":""},"fim_vendas":{"description":"Data do fechamento do carrinho.","type":"datetime","example":""},"selo_pre_venda":{"description":"Selo pré-venda(0-Não / 1-Sim).","type":"integer","example":""},"cursos":{"description":"Coleção de IDs e cursos relacionados","type":"array","items":{"type":"integer","example":1}}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/product/opportunity":{"get":{"tags":["Produtos"],"summary":"Listagem das oportunidades do EAD.","operationId":null,"parameters":[{"name":"aluno","in":"query","description":"E-mail do aluno","schema":{"type":"string"}},{"name":"produto","in":"query","description":"Produto Id","schema":{"type":"integer"}},{"name":"tipo","in":"query","description":"Tipo de oportunidade(1-Visitou página do curso / 2-Adicionou ao carrinho / 3-Adicionou na lista de espera / 4-Adicionou na lista de desejos / 5-Página visitada)","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as oportunidades cadastradas do EAD.","content":{"application/json":{"schema":{"properties":{"nome":{"description":"Nome do aluno cadastrado no EAD.","type":"string","example":"Exemplo"},"email":{"description":"E-mail do aluno cadastrado no EAD.","type":"string","example":"email@email.com"},"cpf":{"description":"CPF do aluno.","type":"string","example":"000.000.000-00"},"telefone":{"type":"string"},"endereco":{"type":"string"},"numero":{"type":"string"},"complemento":{"type":"string"},"bairro":{"type":"string"},"cep":{"type":"string"},"tipo":{"description":"Tipo de oportunidade(1-Visitou página do curso / 2-Adicionou ao carrinho / 3-Adicionou na lista de espera / 4-Adicionou na lista de desejos / 5-Página visitada).","type":"integer","example":"Tipo Exemplo"},"produtos":{"type":"string","example":"[]"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/questions":{"get":{"tags":["Banco de Questões"],"summary":"Listagem das questões cadastradas por curso.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Pergunta Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as questões cadastradas em um curso do EAD.","content":{"application/json":{"schema":{"properties":{"pergunta_id":{"description":"Id da pergunta cadastrada no EAD.","type":"integer","example":1},"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":10},"curso_titulo":{"description":"Título do curso cadastrado no EAD.","type":"string","example":"Curso Exemplo"},"ordem":{"description":"Ordem de cadastro da pergunta.","type":"integer","example":11},"pergunta_tipo":{"description":"Tipo da pergunta cadastrada (1-Alternativa / 2-Dissertativa / 3-Múltipla Escolha).","type":"integer","example":2},"pergunta":{"description":"Pergunta cadastrada no EAD.","type":"string","example":""},"resposta1 a resposta8":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string","example":""},"observacao":{"description":"Observação para a pergunta.","type":"string","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Banco de Questões"],"summary":"Inserir uma questão para um curso.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["curso_id","pergunta_tipo","pergunta"],"properties":{"curso_id":{"description":"Curso Id","type":"integer"},"pergunta_tipo":{"description":"1-Alternativa / 2-Dissertativa / 3-Múltipla Escolha","type":"integer"},"pergunta":{"description":"Pergunta a ser cadastrada","type":"string"},"resposta1":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta2":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta3":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta4":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta5":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta6":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta7":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"resposta8":{"description":"Alternativas para questões do tipo Alternativa e Múltipla Escolha.","type":"string"},"alternativa_correta":{"description":"Se multipla escolha, passar separado por vírgulas. Ex: 1,3,5","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"pergunta_id":{"type":"integer","example":1},"ordem":{"type":"integer","example":1},"pergunta_tipo":{"type":"integer","example":1},"pergunta":{"type":"string","example":"Pergunta"},"biblioteca_id":{"type":"integer","example":2},"opcoes":{"type":"array","items":{"properties":{"id":{"type":"integer","example":100},"opcao":{"type":"string","example":"Resposta 1"},"correta":{"type":"integer","example":1}},"type":"object"},"collectionFormat":"multi"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/questions/{pergunta_id}":{"put":{"tags":["Banco de Questões"],"summary":"Atualizar uma questão de um curso.","operationId":null,"parameters":[{"name":"pergunta_id","in":"path","description":"Pergunta Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"ordem":{"description":"Ordem da questão","type":"integer"},"pergunta_tipo":{"description":"1-Alternativa / 2-Dissertativa / 3-Múltipla Escolha","type":"integer"},"pergunta":{"description":"Pergunta a ser cadastrada","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"pergunta_id":{"type":"integer","example":1},"ordem":{"type":"integer","example":1},"pergunta_tipo":{"type":"integer","example":1},"pergunta":{"type":"string","example":"Pergunta"},"biblioteca_id":{"type":"integer","example":2},"opcoes":{"type":"array","items":{"properties":{"id":{"type":"integer","example":100},"opcao":{"type":"string","example":"Resposta 1"},"correta":{"type":"integer","example":1}},"type":"object"},"collectionFormat":"multi"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/questions/{id}":{"delete":{"tags":["Banco de Questões"],"summary":"Excluir uma questão de um curso.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Pergunta Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/access":{"get":{"tags":["Usuários"],"summary":"Listagem do histórico de acesso de um usuário.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial do período de último acesso (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de último acesso (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the rewards of an user","content":{"application/json":{"schema":{"properties":{"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":12},"acesso_hora":{"description":"Data e hora do último acesso.","type":"string","example":"2021-10-25 17:25:29"},"ip":{"description":"Endereço IP utilizado.","type":"string","example":"192.168.0.212"},"pais":{"description":"País do último acesso a plataforma.","type":"string","example":"Brasil"},"regiao":{"description":"Estado do último acesso a plataforma.","type":"string","example":"São Paulo"},"cidade":{"description":"Cidade do último acesso a plataforma.","type":"string","example":"Bauru"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/payment":{"get":{"tags":["Assinaturas"],"summary":"Listagem dos pagamentos das assinaturas do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Assinatura Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"plano_id","in":"query","description":"Plano Id","schema":{"type":"integer"}},{"name":"status","in":"query","description":"Status da transação. (1-Aguardando/2-Aprovado/3-Cancelado/4-Disputa/5-Reembolso em progresso/6-Reembolso/7-Chargeback)","schema":{"type":"integer"}},{"name":"tipo_pagamento","in":"query","description":"Método de pagamento. (1-Cartão / 2-Boleto / 3-PIX)","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Período inicial de registro (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Período final de registro (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os pagamentos dos planos cadastrados no EAD.","content":{"application/json":{"schema":{"properties":{"assinatura_id":{"description":"Id da assinatura cadastrada no EAD.","type":"integer","example":1},"transacao_id":{"description":"Id da transação cadastrada no EAD.","type":"string","example":""},"status_transacao":{"description":"Status da transação. (1-Aguardando/2-Aprovado/3-Cancelado/4-Disputa/5-Reembolso em progresso/6-Reembolso/7-Chargeback)","type":"string","example":""},"tipo_pagamento":{"description":"Método de pagamento. (1-Cartão / 2-Boleto / 3-PIX)","type":"string","example":""},"data_compra":{"description":"Data e hora do pedido.","type":"datetime","example":""},"data_conclusao":{"description":"Data e hora da conclusão do processamento do pedido.","type":"datetime","example":""},"plano_id":{"description":"Id do plano cadastrado no EAD.","type":"integer","example":1},"valor_pago":{"description":"Valor pago pelo aluno.","type":"float","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":1},"nome":{"description":"Nome do aluno cadastrado no EAD.","type":"string","example":""},"email":{"description":"E-mail do aluno cadastrado no EAD.","type":"integer","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/sales":{"get":{"tags":["Transações"],"summary":"Listagem de vendas dos cursos do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Venda Id, se enviar venda id não é necessário envio do código da transação","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Produto Id","schema":{"type":"integer"}},{"name":"oferta","in":"query","description":"Oferta Id","schema":{"type":"integer"}},{"name":"transacao","in":"query","description":"Código da Transação, se enviar código da transação não é necessário envio da venda id","schema":{"type":"string"}},{"name":"aluno_id","in":"query","description":"Aluno Id","schema":{"type":"integer"}},{"name":"vendedor_id","in":"query","description":"Vendedor Id","schema":{"type":"integer"}},{"name":"cupom","in":"query","description":"Cupom aplicado","schema":{"type":"string"}},{"name":"status","in":"query","description":"1 - Aguardando Pagamento, 2 - Aprovado, 3 - Cancelado, 4 - Disputa, 5 - Reembolso em andamento, 6 - Reembolsado, 7 - Chargeback","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial do período de início da transação (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de início da transação (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página. Valor padrão: 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura. Valor padrão: 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as vendas do EAD.","content":{"application/json":{"schema":{"properties":{"vendas_id":{"description":"Id da venda cadastrada no EAD.","type":"integer","example":1},"transacao_id":{"description":"Id da transação cadastrada no EAD.","type":"string","example":""},"produto_id":{"description":"Id do curso ou plano no EAD.","type":"integer","example":""},"oferta_id":{"description":"Id da oferta no EAD.","type":"integer","example":""},"valor":{"description":"Valor da transação.","type":"float","example":""},"valor_liquido":{"description":"Valor da transação sem as taxas.","type":"float","example":""},"taxas":{"description":"Taxas cobradas da transação.","type":"float","example":""},"cupom":{"description":"Cupom utilizado na transação.","type":"string","example":""},"lucro_ead":{"description":"Lucro do EAD na transação.","type":"float","example":""},"nome_afiliado":{"description":"Nome do afiliado que indicou a venda.","type":"string","example":"Somente Hotmart, Eduzz, Provi, Braip, Monetizze, Kiwify, DigitalManagerGuru, AppMax, Doppus, Ticto, Abmex, PerfectPay, Evermart, HeroSpark, Yampi, CartPanda, Kirvano e EduzzNew."},"lucro_afiliado":{"description":"Lucro do afiliado na transação.","type":"float","example":"Somente Hotmart, Eduzz, Provi, Braip, Monetizze, Kiwify, DigitalManagerGuru, AppMax, Doppus, Ticto, Abmex, PerfectPay, Evermart, HeroSpark, Yampi, CartPanda, Kirvano e EduzzNew."},"data_transacao":{"description":"Data da trasanção.","type":"datetime","example":""},"data_conclusao":{"description":"Data que pagamento foi recebido.","type":"datetime","example":""},"tipo_pagamento":{"description":"Forma utilizada de pagamento(1-Cartão de crédito / 2-Boleto).","type":"integer","example":""},"status_transacao":{"description":"1-Aguardando Pagamento / 2-Aprovado / 3-Cancelado / 4-Em disputa / 5-Reembolso em andamento / 6-Reembolso / 7-Chargeback / 8-Completo","type":"integer","example":""},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":""},"nome_aluno":{"description":"Nome do aluno.","type":"string","example":""},"email":{"description":"E-mail do aluno.","type":"string","example":""},"faturamento_nome":{"description":"Nome utilizado na compra.","type":"string","example":""},"faturamento_email":{"description":"E-mail utilizado na compra.","type":"string","example":""},"faturamento_documento":{"description":"Documento utilizado na compra.","type":"string","example":""},"faturamento_telefone":{"description":"Telefone utilizado na compra.","type":"string","example":""},"faturamento_endereco":{"description":"Endereço utilizado na compra.","type":"string","example":""},"faturamento_numero":{"description":"Número utilizado na compra.","type":"string","example":""},"faturamento_complemento":{"description":"Complemento utilizado na compra.","type":"string","example":""},"faturamento_bairro":{"description":"Bairro utilizado na compra.","type":"string","example":""},"faturamento_cep":{"description":"CEP utilizado na compra.","type":"string","example":""},"faturamento_cidade":{"description":"Cidade utilizado na compra.","type":"string","example":""},"faturamento_uf":{"description":"UF utilizado na compra.","type":"string","example":""},"vendedor_id":{"description":"Id do vendedor cadastrado no EAD.","type":"integer","example":""},"nome_vendedor":{"description":"Nome do professor(a) do curso.","type":"string","example":""},"tipo_venda":{"description":"Tipo da venda(1-Vendas / 2-Assinaturas).","type":"integer","example":""},"gateway":{"description":"1-Manual / 2-PagSeguro / 3-Paypal / 4-Hotmart / 5-Eduzz / 6-EAD Checkout / 7-Provi / 8-Braip / 9-Monetizze / 9-Kiwify / 10-DigitalManagerGuru / 11-AppMax / 12-Doppus / 13-Ticto / 14-MercadoPago / 15-Abmex / 16-PerfectPay / 17-Evermart / 18-HeroSpark / 19-Yampi / 20-CartPanda / 21-Kirvano / 22-EduzzNew","type":"string","example":""},"origem":{"description":"1-Carrinho Padrão / 2-Carrinho customizado / 3-Página de chekcout / 4-Recorrência / 5-Manual / 6-Cobrança / 7-Compra com um clique / 8-Externo","type":"integer","example":""},"utms_url":{"description":"UTM's URL","type":"application/json","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/sales/{id}":{"delete":{"tags":["Transações"],"summary":"Excluir uma transação do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Transação Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/student":{"get":{"tags":["Usuários"],"summary":"Listagem dos usuários do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"email","in":"query","description":"E-mail","schema":{"type":"string"}},{"name":"cpf","in":"query","description":"CPF do aluno, com ou sem máscara (ex: 222.222.222-22 ou 22222222222)","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status (0-Aguardando confirmação / 1-Confirmado / 2-Bloqueado)","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Data inicial do período de cadastro (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Data final do período de cadastro (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna os cursos do EAD.","content":{"application/json":{"schema":{"properties":{"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":12},"nome":{"description":"Nome do aluno cadastrado no EAD.","type":"string","example":"Exemplo"},"email":{"description":"E-mail do aluno cadastrado no EAD.","type":"string","example":"email@email.com"},"username":{"description":"Apelido do aluno no EAD.","type":"string","example":"UserName"},"tipo":{"description":"Tipo do usuário (1-Aluno / 2-Tutor / 3-Professor(a) / 4-Administrador).","type":"integer","example":1},"data_cadastro":{"description":"Data e hora de cadastro do usuário.","type":"date time","example":"2019-01-01 09:00:00"},"status":{"description":"Status atual da conta (0-Aguardando confirmação / 1-Confirmado / 2-Bloqueado).","type":"integer","example":1},"cpf":{"description":"CPF do aluno.","type":"string","example":"222.222.222-22"},"profissao":{"type":"string","example":"SP"},"biografia":{"type":"string"},"curriculum":{"type":"string"},"personalizado":{"description":"Informações adicionais.","type":"string"},"anotacoes":{"description":"Informações adicionais.","type":"string"},"nascimento":{"description":"Data de nascimento.","type":"string","example":"500"},"cidade":{"type":"string"},"uf":{"description":"Estado.","type":"string"},"telefone":{"type":"string"},"cep":{"type":"string"},"endereco":{"type":"string"},"numero":{"type":"string"},"complemento":{"type":"string"},"bairro":{"type":"string"},"site":{"description":"Endereço do site de um usuário.","type":"string"},"twitter":{"type":"string"},"facebook":{"type":"string"},"linkedin":{"type":"string"},"youtube":{"type":"string"},"instagram":{"type":"string"},"tiktok":{"type":"string"},"ultimo_acesso":{"description":"Data e hora do último acesso do usuário.","type":"date time","example":"2019-01-01 09:00:00"},"foto":{"description":"Imagem do perfil.","type":"string","example":"seudominio/upload/profiles/foto.png"},"campos_personalizados":{"description":"Campos adicionais criados na plataforma pelo admin.","type":"string"}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Usuários"],"summary":"Inserir um novo usuário no EAD.","operationId":null,"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["tipo","nome","email","status"],"properties":{"email":{"description":"E-mail do Usuário","type":"string(75)"},"nome":{"description":"Nome do Usuário","type":"string(75)"},"tipo":{"description":"Tipo do usuário (1-Aluno / 2-Tutor / 3-Professor(a) / 4-Administrador)","type":"integer"},"permissao_id":{"description":"Id do template de permissão","type":"integer"},"status":{"description":"Status atual da conta (0-Aguardando confirmação / 1-Confirmado / 2-Bloqueado)","type":"integer"},"senha":{"description":"Senha Provisória","type":"string(40)"},"telefone":{"description":"Telefone do usuário","type":"string(40)"},"data_cadastro":{"description":"Data de Cadastro","type":"datetime"},"personalizado":{"description":"Qualquer informação adicional, visível apenas para admin","type":"string"},"anotacoes":{"description":"Observação sobre o usuário, visível apenas para admin","type":"string"},"notificar":{"description":"Notificar por e-mail 0-Não / 1-Sim","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"aluno_id":{"type":"integer","example":12},"nome":{"type":"string","example":"Nome do aluno"},"email":{"type":"string","example":"email@email.com"},"senha":{"type":"string","example":"password"},"username":{"type":"string","example":"username"},"tipo":{"type":"integer","example":1},"permissao_id":{"type":"integer","example":2},"status":{"type":"integer","example":1},"cpf":{"type":"string","example":"222.222.222-22"},"foto":{"type":"string","example":"caminhodaimagem.com"},"ocupacao":{"type":"string","example":"Desenvolvedor"},"personalizado":{"type":"string","example":"Personalizado"},"anotacoes":{"type":"string","example":"Anotacoes"},"nascimento":{"type":"string","example":"1974-10-03"},"telefone":{"type":"string","example":"(88)88888-8888"},"cep":{"type":"string","example":"11111111"},"endereco":{"type":"string","example":"Endereco"},"numero":{"type":"string","example":"222"},"complemento":{"type":"string","example":"Complemento"},"bairro":{"type":"string","example":"Bairro"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/student/{aluno_id}":{"put":{"tags":["Usuários"],"summary":"Atualizar um usuário do EAD.","operationId":null,"parameters":[{"name":"aluno_id","in":"path","description":"Aluno Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"tipo":{"description":"Tipo do usuário (1-Aluno / 2-Tutor / 3-Professor(a) / 4-Administrador)","type":"integer"},"status":{"description":"Status atual da conta (0-Aguardando confirmação / 1-Confirmado / 2-Bloqueado)","type":"integer"},"nome":{"description":"Nome do Usuário","type":"string(75)"},"email":{"description":"E-mail do Usuário","type":"string(75)"},"telefone":{"description":"Telefone do usuário","type":"string(40)"},"senha":{"description":"Senha","type":"string"},"username":{"description":"Username","type":"string(75)"},"cpf":{"description":"CPF somente números","type":"string(40)"},"nascimento":{"description":"Data de nascimento (YYYY-MM-DD)","type":"date"},"endereco":{"description":"Endereço","type":"string(115)"},"numero":{"description":"Número","type":"string(10)"},"complemento":{"description":"Complemento","type":"string(115)"},"bairro":{"description":"Bairro","type":"string(60)"},"cep":{"description":"CEP","type":"string(40)"},"profissao":{"description":"Profissão","type":"string(45)"},"personalizado":{"description":"Qualquer informação adicional, visível apenas para admin","type":"string"},"anotacoes":{"description":"Observação sobre o usuário, visível apenas para admin","type":"string"},"notificar":{"description":"Notificar por e-mail 0-Não / 1-Sim","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"aluno_id":{"type":"integer","example":12},"nome":{"type":"string","example":"Nome do aluno"},"email":{"type":"string","example":"email@email.com"},"senha":{"type":"string","example":"password"},"username":{"type":"string","example":"username"},"tipo":{"type":"integer","example":1},"permissao_id":{"type":"integer","example":2},"status":{"type":"integer","example":1},"cpf":{"type":"string","example":"222.222.222-22"},"foto":{"type":"string","example":"caminhodaimagem.com"},"ocupacao":{"type":"string","example":"Desenvolvedor"},"personalizado":{"type":"string","example":"Personalizado"},"anotacoes":{"type":"string","example":"Anotacoes"},"nascimento":{"type":"string","example":"1974-10-03"},"telefone":{"type":"string","example":"(88)88888-8888"},"cep":{"type":"string","example":"11111111"},"endereco":{"type":"string","example":"Endereco"},"numero":{"type":"string","example":"222"},"complemento":{"type":"string","example":"Complemento"},"bairro":{"type":"string","example":"Bairro"}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/student/{aluno_id}/notify":{"put":{"tags":["Usuários"],"summary":"Atualizar notificações de um usuário do EAD.","operationId":null,"parameters":[{"name":"aluno_id","in":"path","description":"Aluno Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"notificar_aula":{"description":"Notificação de aula (1-Ativo / 0-Inativo)","type":"integer"},"notificar_prova":{"description":"Notificação de prova (1-Ativo / 0-Inativo)","type":"integer"},"notificar_suporte":{"description":"Notificação de suporte (1-Ativo / 0-Inativo)","type":"integer"},"notificar_suporte_resposta":{"description":"Notificação de resposta de suporte (1-Ativo / 0-Inativo)","type":"integer"},"notificar_mensagem":{"description":"Notificação de nova mensagem (1-Ativo / 0-Inativo)","type":"integer"},"notificar_grupo":{"description":"Notificação de mensagem de grupo (1-Ativo / 0-Inativo)","type":"integer"},"notificar_carrinho":{"description":"Notificação de carrinho abandonado (1-Ativo / 0-Inativo)","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"notificar_aula":{"type":"integer","example":1},"notificar_prova":{"type":"integer","example":1},"notificar_suporte":{"type":"integer","example":1},"notificar_suporte_resposta":{"type":"integer","example":1},"notificar_mensagem":{"type":"integer","example":1},"notificar_grupo":{"type":"integer","example":1},"notificar_carrinho":{"type":"integer","example":1}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/student/{id}":{"delete":{"tags":["Usuários"],"summary":"Excluir um usuário do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Usuário Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/test":{"get":{"tags":["Provas"],"summary":"Listagem das provas realizadas pelo aluno dentro de um curso.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Usuário Id","required":true,"schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as provas realizadas de um aluno em um curso.","content":{"application/json":{"schema":{"properties":{"prova_id":{"description":"Id da prova realizada no EAD.","type":"integer","example":1},"titulo":{"description":"Título da prova.","type":"string","example":""},"tipo":{"description":"Tipo da prova.","type":"integer","example":10},"modulo_id":{"description":"Módulo ID","type":"integer","example":1},"modulo":{"description":"Título do módulo.","type":"string","example":"Módulo"},"aula_id":{"description":"Aula ID","type":"integer","example":1},"aula":{"description":"Título da aula.","type":"string","example":"Aula"},"pontos":{"description":"Peso da prova.","type":"integer","example":4},"parcial":{"description":"Nota parcial do aluno.","type":"float","example":8},"nota_final":{"description":"Média final sobre todas as provas com peso igual ou superior a 1.","type":"float","example":7}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/tests":{"get":{"tags":["Provas"],"summary":"Retorna as provas realizadas no EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"curso","in":"query","description":"Curso Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as provas realizadas no EAD.","content":{"application/json":{"schema":{"properties":{"prova_id":{"description":"Id da prova realizada no EAD.","type":"integer","example":1},"curso_id":{"description":"Id do curso cadastrado no EAD.","type":"integer","example":1},"curso":{"description":"Título do curso.","type":"string","example":10},"aluno_id":{"description":"Id do aluno.","type":"integer","example":3},"nome_aluno":{"description":"Nome do aluno.","type":"string","example":"Nome Exemplo"},"prova":{"description":"Título da prova.","type":"string","example":"Prova"},"tipo":{"description":"Tipo da prova.","type":"string","example":""},"modulo_id":{"description":"Módulo ID","type":"integer","example":1},"modulo":{"description":"Título do módulo.","type":"string","example":"Módulo"},"aula_id":{"description":"Aula ID","type":"integer","example":1},"aula":{"description":"Título da aula.","type":"string","example":"Aula"},"nota_prova":{"description":"Nota da prova.","type":"float","example":1},"pontos":{"description":"Peso da prova.","type":"integer","example":3},"status_prova":{"description":"Tipo da prova.","type":"string","example":""},"data_inicio":{"description":"Data e hora de início","type":"date","example":""},"data_fim":{"description":"Data e hora de conclusão","type":"date","example":""},"controle_tempo":{"description":"Controle de Tempo","type":"integer","example":0},"parcial":{"description":"Nota parcial do aluno.","type":"float","example":8},"prova_inativa":{"description":"Verificar se prova está ativa ou não(0-Ativa / 1-Inativa).","type":"integer","example":0}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/test/{id}/{curso_id}/{aluno_id}":{"delete":{"tags":["Provas"],"summary":"Excluir uma prova de um aluno.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Prova Id","required":true,"schema":{"type":"integer"}},{"name":"curso_id","in":"path","description":"Curso Id","required":true,"schema":{"type":"integer"}},{"name":"aluno_id","in":"path","description":"Aluno Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/permission":{"get":{"tags":["Permissões"],"summary":"Listagem dos templates de permissões cadastrados no EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Id do template de permissão cadastrado no EAD.","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Listagem dos templates de permissões cadastrados no EAD.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id do template de permissões.","type":"integer","example":1},"nome":{"description":"Nome do template cadastrado no EAD.","type":"string","example":"Admin"},"permissoes":{"description":"Listagem de permissões(0-Sem acesso / 1-Somente os meus / 2-Acesso total).","type":"json","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/userpermission":{"get":{"tags":["Permissões"],"summary":"Listagem dos templates de permissões e usuários cadastrados no EAD.","operationId":null,"parameters":[{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Listagem dos templates de permissões cadastrados no EAD.","content":{"application/json":{"schema":{"properties":{"aluno_id":{"description":"Id do usuário cadastrado no EAD.","type":"integer","example":1},"nome":{"description":"Nome do usuário cadastrado no EAD.","type":"integer","example":"Nome Exemplo"},"email":{"description":"E-mail do usuário cadastrado no EAD.","type":"string","example":"email@email.com"},"permissao_id":{"description":"Id do template de permissão cadastrado no EAD.","type":"integer","example":1},"permissoes":{"description":"Listagem de permissões(0-Sem acesso / 1-Somente os meus / 2-Acesso total).","type":"json","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/permission/{id}/{usuario_id}":{"put":{"tags":["Permissões"],"summary":"Alterar template de permissões de um usuário.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Permissão id","required":true,"schema":{"type":"integer"}},{"name":"usuario_id","in":"path","description":"Usuário id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"406":{"description":"Empty Fields","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Empty Field","type":"integer","example":406},"message":{"type":"string","example":"Error"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/permission/{id}":{"delete":{"tags":["Permissões"],"summary":"Excluir um template de permissão cadastrado no EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Permissão id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"nullable":true,"type":"application/json","example":"null"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/signature":{"get":{"tags":["Assinaturas"],"summary":"Listagem de assinaturas do EAD.","operationId":null,"parameters":[{"name":"id","in":"query","description":"Assinatura Id","schema":{"type":"integer"}},{"name":"usuario_id","in":"query","description":"Usuário Id","schema":{"type":"integer"}},{"name":"plano_id","in":"query","description":"Plano Id","schema":{"type":"integer"}},{"name":"data_inicio","in":"query","description":"Período inicial (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"data_fim","in":"query","description":"Período final (yyyy-mm-dd)","schema":{"type":"string"}},{"name":"paginate","in":"query","description":"Informaçoes para paginação","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Número máximo de dados retornados por página, valor padrão 1000","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Indica o início da leitura, caso não informado valor padrão será 0","schema":{"type":"integer"}}],"responses":{"200":{"description":"Retorna as assinaturas cadastradas do EAD.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Id da assinatura cadastrada no EAD.","type":"integer","example":1},"aluno_id":{"description":"Id do aluno cadastrado no EAD.","type":"integer","example":""},"plano_id":{"description":"Id do plano cadastrado no EAD.","type":"integer","example":""},"data_inicio":{"description":"Início da assinatura.","type":"datetime","example":""},"data_ultimo_pagamento":{"description":"Data do último pagamento.","type":"datetime","example":""},"data_renovacao":{"description":"Data da renovação da assinatura.","type":"datetime","example":1},"data_cancelamento":{"description":"Data da renovação da assinatura.","type":"datetime","example":1},"data_reativacao":{"description":"Data da renovação da assinatura.","type":"datetime","example":10},"cupom":{"description":"Cupom utilizado.","type":"string","example":""},"status":{"description":"Status da assinatura(0-Cancelada / 1-Ativa).","type":"integer","example":""},"tipo":{"description":"Tipo da assinatura(1-Padrão / 2-Inteligente).","type":"integer","example":""},"renovacao_automatica":{"description":"Renovação automática da assinatura.(0-Não / 1-Sim).","type":"integer","example":""},"data_proximo_pagamento":{"description":"Data do próximo pagamento da assinatura.","type":"datetime","example":""},"cobrancas":{"description":"Número de cobranças que o desconto do cupom será aplicado, apenas assinatura.","type":"integer","example":""},"vitalicio":{"description":"Se o desconto do cupom será válido até o final da assinatura(0-Não / 1-Sim).","type":"integer","example":""},"ciclo":{"description":"Ciclo de pagamento(1-Mensal / 2-Trimestral / 3-Semestral / 4-Anual)","type":"integer","example":""},"taxa_adesao":{"description":"Valor pago adesão da assinatura.","type":"float","example":""},"plano_nome":{"description":"Nome do plano cadastrado no EAD.","type":"string","example":""},"quantidade_cobrancas":{"description":"Número de cobranças pagas.","type":"integer","example":""},"valor":{"description":"Valor da assinatura.","type":"float","example":""},"nome_aluno":{"description":"Nome do aluno cadastrado no EAD.","type":"string","example":""},"email_aluno":{"description":"E-mail do aluno cadastrado no EAD.","type":"string","example":""}},"type":"object"}}}},"204":{"description":"No content"},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}},"/api/1/signature/{id}":{"put":{"tags":["Assinaturas"],"summary":"Atualizar uma assinatura do EAD.","operationId":null,"parameters":[{"name":"id","in":"path","description":"Assinatura Id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"properties":{"ciclo":{"description":"Ciclo de cobrança(1-Mensal / 2-Trimestre / 3-Semestre / 4-Anual / 5-Semanal / 6-Quinzenal / 7-Bienal / 8-Trienal)","type":"integer"},"cobrancas":{"description":"Número de cobranças da assinatura","type":"integer"},"data_renovacao":{"description":"Data da renovação","type":"string"},"valor":{"description":"Valor do Plano","type":"string"},"taxa_adesao":{"description":"Taxa de adesão do Plano","type":"string"},"status":{"description":"Status da assinatura(0-Cancelada / 1-Ativa)","type":"integer"},"renovacao_automatica":{"description":"Permite renovação automática da assinatura(0-Não / 1-Sim)","type":"integer"},"vitalicio":{"description":"Até o aluno cancelar a assinatura(0-Não / 1-Sim)","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Success","type":"integer","example":200},"message":{"type":"string","example":"Success"},"data":{"properties":{"id":{"type":"integer","example":1},"status":{"type":"integer","example":1},"renovacao_automatica":{"type":"integer","example":1},"vitalicio":{"type":"integer","example":1},"paymentMethod":{"type":"integer","example":2},"valor":{"type":"string","example":"20.00"},"taxa_adesao":{"type":"string","example":"5.00"},"ciclo":{"type":"integer","example":1},"data_renovacao":{"type":"string","example":"2021-12-12"},"cobrancas":{"type":"integer","example":10}},"type":"object"}},"type":"object"}}}},"401":{"description":"Token not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Token not found","type":"integer","example":401},"message":{"type":"string","example":"Token not found"}},"type":"object"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Not found","type":"integer","example":404},"message":{"type":"string","example":"Not found"},"data":{"type":"array","items":{"type":"string","example":"field"},"collectionFormat":"multi"}},"type":"object"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Too many requests","type":"integer","example":429},"message":{"type":"string","example":"Too many requests"}},"type":"object"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"http_status":{"description":"Internal Server Error","type":"integer","example":500},"message":{"type":"string","example":"Internal Server Error"}},"type":"object"}}}}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"HttpOkResponse":{"description":"Standard successful response with data","properties":{"data":{"description":"Response data","oneOf":[{"type":"object"},{"type":"array","items":[]}]}},"type":"object"},"HttpCreatedResponse":{"description":"Response when a new resource has been successfully created","properties":{"id":{"description":"ID of the created resource","type":"integer","example":123}},"type":"object"},"HttpNoContentResponse":{"description":"Response when action was successful but no content is returned (HTTP 204)","type":"object"},"FieldExceptionResponse":{"description":"Validation error response","properties":{"title":{"type":"string","example":"FieldException"},"description":{"type":"string","example":"One or more fields failed validation"},"invalid-params":{"type":"array","items":{"properties":{"property":{"type":"string","example":"email"},"value":{"type":"string","example":"invalid-email"},"message":{"type":"string","example":"This value is not a valid email address"}},"type":"object"}}},"type":"object"},"PermissionExceptionResponse":{"description":"Permission denied response","properties":{"title":{"type":"string","example":"PermissionException"},"description":{"type":"string","example":"Unauthorized"}},"type":"object"},"NotFoundExceptionResponse":{"description":"Resource not found response","properties":{"title":{"type":"string","example":"NotFoundException"},"description":{"type":"string","example":"Resource not found"}},"type":"object"},"EmptyBodyExceptionResponse":{"description":"Empty request body response","properties":{"title":{"type":"string","example":"EmptyBodyException"},"description":{"type":"string","example":"Request body is required"}},"type":"object"},"ActionInvalidExceptionResponse":{"description":"Invalid action response","properties":{"title":{"type":"string","example":"ActionInvalidException"},"description":{"type":"string","example":"Action cannot be performed"}},"type":"object"},"AuthInvalidExceptionResponse":{"description":"Authentication failed response","properties":{"title":{"type":"string","example":"AuthInvalidException"},"description":{"type":"string","example":"Invalid authentication credentials"}},"type":"object"},"UnsupportedContentTypeExceptionResponse":{"description":"Unsupported content type response","properties":{"title":{"type":"string","example":"UnsupportedContentTypeException"},"description":{"type":"string","example":"Content-Type not supported"}},"type":"object"},"InternalExceptionResponse":{"description":"Internal server error response","properties":{"title":{"type":"string","example":"InternalException"},"description":{"type":"string","example":"An internal error occurred"}},"type":"object"}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Authorization Token","name":"x-auth-token","in":"header","bearerFormat":"JWT","scheme":"bearer"}}},"security":[{"Bearer":[]}]}