Acompanhamento

Devem ser encaminhados cada etapa e situação que ocorreram na prestação do serviço e ao final informar que a prestação foi concluída.

Registro de Acompanhamento

O método Realizar o Registro de Acompanhamentos de um Serviços permite que sejam registradas na base as informações de acompanhamento do serviço como as etapas e suas situações. Após a execução da última etapa da prestação, o método Concluir/Reabrir Acompanhamento deve ser utilizado, para sinalizar a conclusão da prestação.

Realizar o Registro de Acompanhamentos de um Serviços

Nota

Esse é um método POST para envio de acompanhamentos dos serviços sendo executados.

Parâmetros de Entrada

{
  "cpfCidadao": "08254631654",
  "dataEtapa": "10/10/2017",
  "dataSituacaoEtapa": "10/10/2017",
  "etapa": "Inicial",
  "orgao": "36802",
  "protocolo": "0001AC.20171212",
  "servico": "47",
  "situacaoEtapa": "Alguma descrição da situação."
}
cpfCidadao
Informe o CPF do cidadão que está executando o serviço. Esse CPF vai ser validado na base 11.
dataEtapa
Data da etapa que o serviço foi executado no formato “dd/mm/aaaa”.
dataSituacaoEtapa
Data da etapa que o situação foi criado/alterado no formato “dd/mm/aaaa”.
etapa
Descrição da etapa que o serviço se encontra na dataEtapa.

Nota

Sugere-se minimamente duas etapas: Etapa Inicial do serviço com o label ‘Inicial’ e Etapa Final quando o serviço for concluído com o label ‘Final’.

orgao
ID do órgão no Portal de Serviços. Caso não saiba qual ID do órgão consulte pela API do Portal de Serviços

Atenção

Esse é o código do Portal de Serviços e não o do SIORG.

Protocolo
Protocolo interno do órgão referente ao serviço sendo executado.
servico
ID do serviço no Portal de Serviços. Caso não saiba qual ID do serviço consulte pela API do Portal de Serviços.
situacaoEtapa
Descrição da etapa do serviço.

Veja um exemplo de acesso utilizando o cURL

$ curl -v -X POST --header 'Content-Type: application/json;charset=UTF-8' -k \
--header 'Authorization: Basic YWxhZGluQGRpc25leS5jb206b3BlbnNlc2FtZQ==' \
--header 'Accept: application/json' -d '{ \
 "cpfCidadao": "08254631654", \
 "dataEtapa": "10/10/2017", \
 "dataSituacaoEtapa": "10/10/2017", \
 "etapa": Final", \
 "orgao": "36802", \
 "protocolo": "0001AC.20171212", \
 "servico": "47", \
 "situacaoEtapa": "Alguma descrição da situação." \
 }' 'https://api-acompanha-avalia-servicos.dev.nuvem.gov.br/api/acompanhamento/'

Parâmetros de Saída

{
  "message": "Operação realizada com sucessos!",
  "status": "OK"
}
messagem
Mensagem que descreve o status da operação.
status
Status final da operação. Pode ser OK ou ERROR

Aviso

Há outras saídas possíveis dependendo se foi feito com sucesso o login ou mesmo se o serviço já existe no Portal de Serviços. Para uma listagem completa da saída por favor verifique a documentação Swagger.

Concluir/reabrir uma prestação de serviço

Após o registro das etapas na base de avaliação e tendo sido encerrado a prestação do serviço, deve-se informar a conclusão utilizando o método Realizar a conclusão ou reabertura de uma prestação de serviço, disponível no endpoint https://api-acompanha-avalia-servicos.dev.nuvem.gov.br/api/acompanhamento/situcacao

Esse método permite registrar a conclusão ou reabertura de uma prestação de serviço de um protocolo já registrado.

Nota

Esse é um método PUT para registrar que um serviço foi concluído ou está sendo reaberto.

Parâmetros de Entrada

 {
"cpfCidadao": "08254631654",
"orgao": "57842",
"protocolo": "0001AC.20171212",
"servico": "12014",
"situacaoServico": "2"
 }
cpfCidadao (string)
CPF do cidadão sem formatação.
orgao (string)
Identificador do Órgão.
protocolo (string)
Protocolo para identificar o serviço.
servico (string)
Identificador do Serviço do Órgão.
situacaoServico (string, optional)
Situação atual do Serviço. 1 - Em Aberto, 2 - Concluído. = [‘1’, ‘2’]

Veja um exemplo de acesso utilizando o cURL

$ curl -v -X PUT --header 'Content-Type: application/json;charset=UTF-8' -k \
--header 'Authorization: Basic YWxhZGluQGRpc25leS5jb206b3BlbnNlc2FtZQ==' \
--header 'Accept: application/json' -d '{ \
"cpfCidadao": "08254631654", \
"orgao": "57842", \
"protocolo": "0001AC.20171212", \
"servico": "12014", \
"situacaoServico": "2" \
}' 'https://acompanhamento.servicos.gov.br/api/acompanhamento/situacao'

Parâmetros de Saída

{
  "message": "Operação realizada com sucessos!",
  "status": "OK"
}
messagem
Mensagem que descreve o status da operação.
status
Status final da operação. Pode ser OK ou ERROR

Aviso

Há outras saídas possíveis dependendo se foi feito com sucesso o login ou mesmo se o serviço já existe no Portal de Serviços. Para uma listagem completa da saída por favor verifique a documentação Swagger.