HTTP SERVICES

Serviços

• students
• documents
• subjects
• pendencies
• defenses
• solicitations
• users

Acessando componentes de serviços

Há um canal comum para os usos do serviços: this.$services Esse comando cria todos os serviços mencionados. Para selecionar um deles basta digitar this.$services.students, por exemplo. Para buscar um aluno use this.$services.students.fetch(studentId), por exemplo.

Descrição de funções de serviço comuns

Há funções comuns nos serviços providos pela interface. Todas as funções retornam Promises.

Função	Descricão
fetch(objectId :number)	Pesquisa por um objeto de entidade
fetchPage(page :number) ou fetchParams(params :object)	Pesquisa por um conjunto de objetos de entidade, tal que: page é o número de uma página e params é um objeto que pode incluir várias chaves de pesquisa, incluindo a página (padrão: page = 1 e order = 'asc')
fetchAll()	Pesquisa por todos os objetos de uma entidade sem paginação
create(params :object)	Cria um objeto de uma entidade. Neste caso params é o objeto com parâmetros a ser enviado no corpo da requisição
update(objectId :number, params :object)	Atualiza um objeto de entidade. Note que o id do objeto não deve vir em params
destroy(objectId :number)	Deleta um objeto de entidade

Funções disponíveis para cada entidade

pendencies

• fetch(studentId, subjectId)
• fetchAll(studentId)
• update(studentId, studentSubjectPendencies)

solicitations

• create(params)

documents

• fetch(studentId, documentId)
• fetchAll(studentId)
• create(studentId, params)
• destroy(studentId, documentId)

students

• fetch(id)
• fetchPage(params)
• fetchEmailChanges(mailingList)
• update(studentId, params)
• updateAcademicHighlight(studentId)
• updateEmailChanges(studentsIdList, mailingList, isAdditionOperation)
• importFromCsv(studentCsv)

users

• fetch(userId)
• fetchPage(page)
• login(username, password)
• create(params)

subjects

• fetch(subjectId)
• fetchPage(page)
• fetchAll()
• create(params)
• update(subjectId, params)
• destroy(subjectId)

defenses

• fetchPage(params)
• fetchAll()
• create(params)
• update(defenseId, params)
• destroy(subjectId)