Search docs/

Prover Frequência

{...}

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 calendário por meio da action @layers:education:Attendance: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:Attendance:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2024-04-05T18:25:02.732Z",
    "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[ ]

Exemplo

{
  "result": [
    {
      "id": "0001",
      "student": "Marília Castelli",
      "course": "9º Ano - Ensino Fundamental",
      "overall": {
        "workload": 1600,
        "workloadUnit": "h",
        "presencePercentage": 0.95,
        "absenceTotal": 10,
        "mood": "bad"
      },
      "subjects": [
        {
          "name": "Língua Portuguesa",
          "overall": {
            "workload": 40,
            "workloadUnit": "h",
            "presencePercentage": 0.95,
            "absenceTotal": 10,
            "mood": "bad"
          },
          "categories": [
            {
              "name": "1º bimestre",
              "workload": 1600,
              "workloadUnit": "h",
              "presencePercentage": 0.95,
              "absenceTotal": 10,
              "mood": "bad"
            }
          ]
        }
      ],
      "records": [
        {
          "type": "present",
          "date": "2024-04-05",
          "subject": "Língua Portuguesa",
          "caption": "09h30 - 10h30",
          "category": "1º bimestre"
        }
      ]
    }
  ]
}
CopiarCopiado