Search docs/

Marcar Registros como vistos

{...}

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 registros acadêmicos por meio da action @layers:education:AcademicRecords:markRecordsAsViewed receberão a requisição no formato abaixo e devem respondê-la com o status HTTP 200 indicando que os registros foram marcados como lidos.

POST https://api.provedor-registrado.com/v1/@layers:education:AcademicRecords:markRecordsAsViewed
CopiarCopiado

Requisição

Especificação

  • userObjectobrigatório

  • groupIdStringobrigatório

    Identificador único do grupo de registros

  • recordsIdsString[ ]

Exemplo

{
  "user": {
    "id": "exemplo",
    "name": "Carlos Pereira",
    "alias": "user2",
    "timezone": "America/Sao_Paulo",
    "language": "pt-BR",
    "accountId": "exemplo"
  },
  "groupId": "grupo_de_registros_1",
  "recordsIds": [
    "id_do_registro_A"
  ]
}
CopiarCopiado