Professores

Um professor é um usuário que, além do acesso aos conteúdos e funcionalidades de um leitor convencional, possui acesso a funcionalidades administrativas da conta, tais como acesso a relatórios de uso, bem como ferramentas para visualizar e gerenciar sua estrutura organizacional.

O professor pode ser alocado em qualquer tipo de estrutura, porém normalmente está associado em uma rede ou escola. A estrutura organizacional em que esse tipo de usuário está alocado define o escopo de informações que ele poderá visualizar. Assim, caso um professor esteja alocado em uma rede com duas escolas, poderá visualizar todas as estruturas e usuários do mesmo nível organizacional e abaixo.

Exemplo

Tomando como exemplo a estrutura abaixo:

Network (1 professor)
├── School A (1 professor)
│   ├── Class 1A (3 alunos)
│   └── Class 2A (7 alunos)
└── School B (1 professor)
    └── Class 1B (10 alunos)

Nessa estrutura, temos 3 professores alocados em diferentes entidades na estrutura escolar. Cada professor consegue visualizar o seguinte escopo administrativo:

Professor alocado na rede (Network): visualiza dados e relatórios da rede, bem como das duas escolas abaixo (School A e School B) e suas respectivas turmas.
Professor alocado na primeira escola (School A): visualiza dados e relatórios da escola A e das turmas 1A e 2A.
Professor alocado na segunda escola (School B): visualiza dados e relatórios da escola B e da turma 1B.

Criação de um professor

POST /api/v2/partners/teachers

Atributos

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome do professor. Ex: `John Doe`
`email`	string	não	E-mail do professor. Ex: `john.doe@teacher.com`
`phone`	string	não	Telefone do professor. Ex: `(00) 00000-0000`
`reference_id`	string	sim	ID de referência do parceiro
`entity_reference_id`	string	sim	ID de referência da entidade associada ao professor

Request

POST /api/v2/partners/teachers
Authorization: APIAuth access_key_id:signature
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john.doe@teacher.com",
    "phone": "(00) 00000-0000",
    "reference_id": "rll1jz-1vhdkzld4o0hpjjuuz-2dka1izfmo",
    "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6"
}

Response

201 Created

{
    "data": {
        "access_token": "GHI1234",
        "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6",
        "name": "John Doe",
        "email": "john.doe@teacher.com",
        "phone": "(00) 00000-0000",
        "reference_id": "rll1jz-1vhdkzld4o0hpjjuuz-2dka1izfmo",
        "active": true
    },
    "errors": null,
    "pagination": null
}

Exibição de um professor

GET /api/v2/partners/teachers/{reference_id}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`reference_id`	string	sim	ID de referência do professor. Ex: `o5td6hae8xz-mmimqh-7x45dbwj5oc3-kokr`

Request

GET /api/v2/partners/teachers/{reference_id}
Authorization: APIAuth access_key_id:signature

Response

200 OK

{
    "data": {
      "access_token": "JKL4567",
      "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6",
      "name": "Richard Smith",
      "email": "richard.smith@teacher.com",
      "phone": "(00) 00000-0000",
      "reference_id": "o5td6hae8xz-mmimqh-7x45dbwj5oc3-kokr",
      "active": true
    },
    "errors": null,
    "pagination": null
}

Edição de um professor

PUT /api/v2/partners/teachers/{reference_id}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`reference_id`	string	sim	ID de referência do professor. Ex: `o5td6hae8xz-mmimqh-7x45dbwj5oc3-kokr`

Atributos

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome do professor. Ex: `John Doe`
`email`	string	sim	E-mail do professor. Ex: `john.doe@teacher.com`
`phone`	string	sim	Telefone do professor. Ex: `(00) 00000-0000`
`reference_id`	string	sim	ID de referência do parceiro
`entity_reference_id`	string	sim	ID de referência da entidade associada ao professor

Request

PUT /api/v2/partners/teachers/{reference_id}
Authorization: APIAuth access_key_id:signature
Content-Type: application/json

Response

200 OK

{
    "data": {
      "access_token": "JKL4567",
      "entity_reference_id": "cuy42r6je6lkv9u-y6g9rjoe-92zm2pdt-f6",
      "name": "Richard Miles",
      "email": "richard.miles@teacher.com",
      "phone": "(00) 12345-6789",
      "reference_id": "o5td6hae8xz-mmimqh-7x45dbwj5oc3-kokr",
      "active": true
    },
    "errors": null,
    "pagination": null
}

Exclusão de um professor

DELETE /api/v2/partners/teachers/{reference_id}

Parâmetros

Campo	Tipo	Obrigatório	Descrição
`reference_id`	string	sim	ID de referência do professor. Ex: `o5td6hae8xz-mmimqh-7x45dbwj5oc3-kokr`

Request

DELETE /api/v2/partners/teachers/{reference_id}
Authorization: APIAuth access_key_id:signature

Response

204 No Content — professor removido com sucesso.