Skip to content

User

  • Objeto da entidade User
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    {
        "id": "a7a82c46a25d4fa8979e273f5197cab4", //id do hub (leitura apenas)
        "usr": "login", //[opcional] login utilizado pelo usuário (nos casos onde é necessário manter os logins da plataforma)
        "pwd": "password", //[opcional] senha utilizada pelo usuário (nos casos onde é necessário manter as senhas da plataforma)
        "name": "Nome do user", //Campo obrigatório. Nome do usuário deve ser composto de pelo menos um nome e um sobre nome.
        "sis_id": "123123", //identificador do sistema acadêmico
        "code": "125054", //Campo obrigatório para identificar o usuário. Deve identificar usuário dentro da escola ( Ex: matrícula e cpf ). Valores aceitos: String sem espaços em branco com tamanho maior ou igual a 3       
        "cpf": "12312312399", //cpf do usuário (campo necessário, deve virar obrigatório com o tempo)
        "dob": "2018-11-05T15:25:16.584Z", //Campo Obrigatório que descreve a data de nascimento de um usuário
        "gender": "M", //Campo opcional. Representa o genêro do usuário. Valores aceitos: M, F e O
        "email": "", //Campo opcional para aluno e obrigatório para os demais papeis.
        "cellphone": "(41) 55555-5555", // celular com DDD (XX) XXXXX-XXXX
        "roles":[ //Campo obrigatório que identifica a função do usuário na escola (pode ter 1 ou mais, deve ter ao menos 1 papel)
            { "code": "administrador", "id": 9 },
            { "code": "professor", "id": 2 },
            ...
        ],
        "createdAt": "2018-11-05T15:25:16.584Z", //data da criação do registro (somente leitura)
        "updatedAt": "2018-11-05T16:14:58.856Z" //data da última modificação do registro (somente leitura)
    }
    

Observação

  • Roles (papéis)
    • pode enviar tanto o código quando o ID, não é necessário enviar os 2.
  • Login e Senhas
    • Os login e senhas podem ser enviados pela plataforma. Essa opção não é aconselhável e será desabilitada com o tempo.
    • Deve ser utilizada para facilitar a compatibilidade e a transição.

Dicionário de papéis

ID Código Papel
1 aluno Aluno
2 responsavel Responsável
3 professor Professor
7 diretor diretor
8 coordenador coordenador
9 administrador administrador

Relacionamentos

Responsável Aluno

  • Objeto da entidade StudentParent
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    {
        "id": "8c67b1b0397011eaa1372e728ce88125", //id do hub (leitura apenas)
        "sis_id": "123123", //identificador do sistema acadêmico (caso tenha)
        "student": {
            "id": "8c67cde4397011eaa1372e728ce88125", //id do hub (leitura apenas)
            "code": "125054", //código do aluno (código que identifica na escola)
            "sis_id": "134124" //identificador do sistema acadêmico
        },
        "parent":{
            "id": "5aca31fd24dc41ae8b72385a5825c8a3", //id do hub (leitura apenas)
            "code": "21235", //código do responsável (código que identifica na escola)
            "sis_id": "134124" //identificador do sistema acadêmico
        },
        "createdAt": "2018-11-05T15:25:16.584Z", //data da criação do registro (leitura apenas)
        "updatedAt": "2018-11-05T16:14:58.856Z", //data da última modificação do registro (leitura apenas)
    }