Search docs/

Prover grades horárias

{...}

O Hub de APIs na 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 grade horária por meio da action @layers:education:Timetables: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/@layers:education:Timetables:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2024-10-15T14:44:53.190Z",
    "action": "@layers:identificador_da_action",
    "community": "idcomunidadeteste"
  },
  "secret": "exemplo1-e000-11xe-2m33-4444444plo",
  "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": "9º Ano",
      "startWeekday": "monday",
      "schedules": [
        {
          "title": "Língua Portuguesa e os estudos",
          "abbr": "PORT",
          "label": "Extracurricular",
          "weekday": "monday",
          "startTime": "15:30:00",
          "endTime": "16:30:00",
          "location": "Campus SP, sala 12, bloco B",
          "caption": "Prof(a): Ana Maria"
        }
      ],
      "attachments": [
        {
          "title": "Horarios.pdf",
          "type": "file`",
          "url": "https://Horarios.pdf"
        }
      ]
    }
  ]
}
CopiarCopiado