Search docs/

Prover notas acadêmicas

{...}

O Hub de API's no Layers permite que apps troquem informações por meio de actions: protocolos especificando o formato de requisição e resposta aceitos para uma determinada informação. Apps que provém informações de notas acadêmicas por meio da action @layers:education:GradeBooks:getRelated receberão a requisição no formato abaixo e devem respondê-la com todos os campos obrigatórios.

POST https://api.provedor-registrado.com/v1/@layers:education:GradeBooks:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2020-10-22T14:12:32.316Z",
    "action": "@layers:identificador_da_action",
    "community": "test"
  },
  "secret": "exemplo",
  "data": {
    "user": {
      "id": "exemplo",
      "name": "João Pedro",
      "alias": "0001",
      "timezone": "America/Sao_Paulo",
      "language": "pt/BR",
      "accountId": "exemplo"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • resultObject[ ]obrigatório

Exemplo

{
  "result": [
    {
      "id": "0001",
      "season": "2019",
      "student": "Ivan Seidel Gomes",
      "course": "1º Ano - Ensino Fundamental",
      "status": "current",
      "terms": [
        {
          "label": "Primeiro Bimestre",
          "startsAt": "2020-10-22",
          "endsAt": "2020-10-22",
          "status": "current",
          "subjects": [
            {
              "label": "Português",
              "abbr": "PORT",
              "activities": [
                {
                  "category": "Provas",
                  "label": "Prova 1",
                  "description": "Verbos e substantivos",
                  "date": "2020-10-22",
                  "comment": "O aluno deve estudar mais o infinitivo",
                  "scoreGiven": 6.5,
                  "scoreMaximum": 10,
                  "scoreMood": "good",
                  "scoreDate": "2020-10-22"
                }
              ],
              "overall": [
                {
                  "type": "attendance",
                  "label": "Faltas",
                  "scoreGiven": "90%",
                  "scoreMaximum": "100%",
                  "scoreMood": "good",
                  "featured": true
                }
              ],
              "categories": [
                {
                  "name": "Provas",
                  "description": "Provas discussivas e/ou objetivas com intuito de avaliar o aprendizado",
                  "order": 1
                }
              ]
            }
          ]
        }
      ],
      "attachments": [
        {
          "title": "CalculoDeNotas.pdf",
          "type": "file`",
          "url": "https://calculo.pdf"
        }
      ]
    }
  ]
}
CopiarCopiado