Search docs/

Prover registros acadêmicos

{...}

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 registros acadêmicos por meio da action @layers:education:AcademicRecords: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:AcademicRecords:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2020-09-15T14:14:14.277Z",
    "action": "@layers:identificador_da_action",
    "community": "test"
  },
  "secret": "exemplo",
  "data": {
    "user": {
      "id": "5bb2575199d7179dfe85be02",
      "name": "João Pedro",
      "alias": "0001",
      "timezone": "America/Sao_Paulo",
      "language": "pt/BR",
      "accountId": "5bb2575199d7179dfe85be02"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • resultObject[ ]obrigatório

Exemplo

{
  "result": [
    {
      "id": "RA",
      "season": "2019",
      "student": "Matília Castelli",
      "course": "9º Ano - Ensino Fundamental",
      "records": [
        {
          "id": "ID_DO_REGISTRO",
          "createdAt": "2020-09-15T14:14:14.277Z",
          "category": "Notificado por comparecer sem marterial escolar",
          "caption": "exemplo",
          "description": "Não trouxe o material didático de Geografia",
          "viewedAt": "2020-09-15T14:14:14.277Z",
          "viewedBy": "exemplo",
          "metadata": [
            {
              "label": "Enviado por",
              "value": "Vânia Almeida"
            }
          ]
        }
      ]
    }
  ]
}
CopiarCopiado