Descrição: Buscar status do processo de assinaturas V1.

Objetivo do Método

Este serviço permite aos Clientes, via API, buscar o status de um processo, não excluído logicamente.

Requisição

Detalhamento do Header e Parameters

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/v2/processo/enviar-documento-para-assinar.

Validações gerais

O sistema verifica se a AppKey existe, é válida e o status da conta está ativo.

Retorno validações

Erro: 400 – Bad Request

Este erro é retornado quando não for possível interpretar a requisição e/ou o servidor tenta processar a solicitação, mas algum parâmetro da solicitação não é válido, por exemplo, um recurso formatado incorretamente ou uma tentativa de requisição com dados faltantes. As informações sobre a solicitação são fornecidas no corpo da resposta e incluem um código de erro e uma mensagem de erro.

1. Item obrigatório: Esta mensagem é exibida no singular ou plural quando um ou mais itens obrigatórios não tiver sido enviado na chamada da API.
2. Formato incorreto: Esta mensagem é exibida no singular ou plural quando um ou mais itens estiverem sido enviados com formato incorreto.
3. Ids inexistente: Esta mensagem é exibida no singular ou plural quando um ou mais Id enviado não existir.
4. Documento excluído: Esta mensagem será exibida quando o documento retornar estive excluído logicamente.
5. Algum parâmetro está incorreto ou é inexistente: Esta mensagem é exibida quando a chamada é feita com algum parâmetro escrito errado ou quando é enviado uma informação que não existe no método.

Erro: 401 – Unauthorized

Este erro é retornado quando a chave de autenticação da API ArqSign está incorreta ou não foi informada corretamente.

Erro: 404 – Not Found

Este erro é retornado quando o recurso solicitado ou o endpoint não foi localizado.

Erro: 422 – Unprocessable

Este erro é retornado quando a requisição foi recebida com sucesso, porém contém parâmetros inválidos.

Erro: 500 – Server Error

Este erro é retornado quando:

• Ocorre um erro interno no servidor,
• Ocorre uma falha na plataforma ArqSign,
• Formato do JSON incorreto.

Retorno de sucesso

Status 200 – Success

O sistema deve retornar o status do processo no idioma do usuário remetente (IdResponsável).

nomeProcesso

O sistema retorna o nome do processo.

status

O sistema retorna o status do processo.

idStatus

O sistema retorna o id do status do processo.

expirado

O sistema retorna se o processo está expirado ou não.

1 = true ou 0 = False

Somente processos com status Aguardando ou Em processo pode ter o parâmetro expirado = true. Ou seja, o cálculo para expiração deve ser executado para processos com status Aguardando ou Em processo.

Como calcular a data de expiração do documento:

Se DataReenvio estiver vazia, Data de expiração do documento = (DataEnvio + ExpiracaoDias).

Se DataReenvio não estiver vazia, Data de expiração do documento = (DataReenvio + ExpiracaoDias).

Somente será retornardo expirado = true, caso a data de hoje seja > que a data da expiração.

dataConclusao

O sistema retorna a data de conclusão caso o processo esteja concluído.

dataCancelamento

O sistema retorna a data de cancelamento caso o processo esteja cancelado.

dataExpiracao

O sistema retorna a data de expiração somente de processo com status Aguardando ou Em processo.

Como calcular a data de expiração do documento:

Se DataReenvio estiver vazia, Data de expiração do documento = (DataEnvio + ExpiracaoDias).

Se DataReenvio não estiver vazia, Data de expiração do documento = (DataReenvio + ExpiracaoDias).

Retorno – Exemplo Body

{
    "nomeProcesso": "string",
    "status": "string",
    "idStatus": "tinyint",
    "expirado": "bit",
    "dataConclusao": "date",
    "dataCancelamento": "date",
    "dataExpiracao": "date"
}