Search docs/

Prover grades horárias

{...}

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 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/v1/@layers:education:Timetables: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

  • resultsObject[ ]obrigatório

Exemplo

{
  "results": [
    {
      "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"
        }
      ]
    }
  ]
}
CopiarCopiado