Consultar e acompanhar

Um ato

GET /notices/{id}

Devolve o ato completo: destinatário, processo, documento-fonte, campos personalizados, prazo e situação.

O id é o UUID devolvido no registro. Um id que não exista no seu órgão responde 404, inclusive quando ele existe em outro. Do ponto de vista do seu token, ele não existe.

Quem registrou e a janela de confirmação

Dois campos do ato completo são fotos do momento do registro. Uma mudança posterior no cadastro do servidor ou na configuração do órgão não altera atos que já existem.

{
  "issuedBy": { "name": "Nome do servidor", "registrationNumber": "000000" },
  "confirmationWindow": { "days": 3, "counting": "BUSINESS_DAYS" }
}

• issuedBy: o servidor que registrou o ato, com nome e matrícula. registrationNumber vem null quando a matrícula não está cadastrada.
• confirmationWindow: quantos dias o destinatário tem para concluir a confirmação, e como contá-los: BUSINESS_DAYS (dias úteis) ou CALENDAR_DAYS (dias corridos). A contagem começa no envio da primeira mensagem. O órgão define essa regra. O sistema ainda não calcula a data final nem considera feriados.

Os dois vêm null em atos registrados antes de existirem, e nenhum deles aparece na listagem.

Vários atos

GET /notices?name=Maria&caseNumber=0801234&status=SENT&limit=20

Parâmetro	Efeito
name	Trecho do nome do destinatário
caseNumber	Trecho do número do processo
status	Situação exata; um valor fora da lista responde 400
limit	Máximo de itens na página
cursor	A página seguinte

{
  "items": [/* ... */],
  "nextCursor": "MDE5OTI4ZjQtM2MyMS03YTRiLThmMGUtNmMyZDViMWE5Zjc3"
}

A listagem é reduzida de propósito

Os itens da lista não trazem o documento-fonte nem os campos personalizados, e trazem apenas o número e a vara do processo. É para manter as respostas pequenas em listagens longas.

Precisa do resto? Busque o ato pelo id.

Paginação

Repita a chamada passando o nextCursor da página anterior em cursor. Quando nextCursor vier null, acabou.

O cursor é opaco: não o construa, não o decomponha e não o guarde como se fosse identificador. Um cursor malformado responde 400.

Linha do tempo

GET /notices/{id}/events está reservado, mas ainda não implementado: hoje ele responde 501. A linha do tempo de eventos de um ato entra numa fase posterior.

Enquanto isso, o campo status do ato é a fonte de progresso. Ver O rito da comunicação.