✔️GET/api/v1/processo/{idProcesso}/status-do-processo
Last updated
Last updated
O objetivo deste método é permitir que o usuário busque o status de um processo de assinatura, para que evite buscar o processo como um todo pelo método “GET/api/v1/processo/{idprocesso}” antes que este esteja com status “Concluído”.
Neste método o usuário irá nos enviar o ID do Processo, e nós retornaremos um JSON com o nome e status atual do mesmo.
Ref. 01: “AppKey” é a chave de autorização para se autenticar na API. Esta chave deve ser válida e estar vinculada a uma conta ArqSign ativa.
Ref. 02: “idProcesso” - Para se obter o status do processo, deve ser enviado como parâmetro o Id do Processo de assinatura na plataforma ArqSign. Este ID a API devolve como retorno de sucesso, após a chamada do método: POST/api/v1/processo/enviar-documento-para-assinar.
Ref. 01 - Código 201: Como retorno de sucesso, a aplicação retornará o código 201 juntamente com o nome e o status do processo.
Status do processo:
Criado
Aguardando
Em processo
Concluído
Cancelado
O serviço "/api/v1/processo/{idprocesso}" retorna os dados do processo e no objeto "signatarios.dadosAssinatura" há informações da assinatura de cada signatário.
Caso esteja "null" significa que o signatário não assinou ainda.
Então null = Pendente
Se tiver dados da assinatura, significa que o signatário assinou.
Então presença de dados = Assinado
Ref. 02 - Código 400: Mensagem de Item obrigatório: Esta mensagem será exibida no singular ou plural quando um ou mais itens obrigatórios não tiver sido enviado na chamada da API.
Ref. 03 - Código 400: Mensagem de formato incorreto: Esta mensagem será exibida no singular ou plural quando um ou mais itens estiverem sido enviados com formato incorreto.
Ref. 04 - Código 400: Mensagem de Ids inexistente: Esta mensagem será exibida no singular ou plural quando um ou mais Id enviado não existir.
Ref. 05 - Código 400: Mensagem de Documento excluído: Esta mensagem será exibida quando o processo em questão tiver sido excluído logicamente.
Ref. 06 - Código 400: Mensagem de parâmetro incorreto ou inexistente: Quando a chamada é feita com algum parâmetro escrito errado ou parâmetro que não existe no método.
Ref. 07 - Código 401: Mensagem de usuário da API não autorizado: AppKey inválida ou não localizada.
