🟩Métodos disponíveis na API

O ArqGED conta com uma lista de métodos disponíveis para uso, na tabela abaixo temos o detalhamento de cada um deles.

Classe MétodoVersãoStatus

1.1

Autenticacao

1

Disponível

1.2

Autenticacao

1

Disponível

2.1

Arquivo

1

Disponível

2.2

Arquivo

1

Disponível

2.3

Arquivo

1

Disponível

2.4

Arquivo

1

Disponível

2.5

Arquivo

1

Disponível

3.1

Billing

1

Disponível

3.2

Billing

1

Disponível

4.1

Documento

1

Disponível

4.2

Documento

1

Disponível

4.3

Documento

1

Disponível

4.4

Documento

1

Disponível

5.1

Lista

1

Disponível

5.2

Lista

1

Disponível

5.3

Lista

1

Disponível

5.4

Lista

1

Disponível

5.5

Lista

1

Disponível

5.6

Lista

1

Disponível

6.1

Workflow

1

Disponível

6.2

Workflow

1

Disponível

6.3

Workflow

1

Disponível

6.4

Workflow

1

Disponível

6.5

Workflow

1

Disponível

6.6

Workflow

1

Disponível

6.7

Workflow

1

Disponível

7.1

Nota Fiscal

1

Disponível

8.1

Relatórios

1

Disponível

8.2

Relatórios

1

Disponível

9.1

Usuário

1

Disponível

9.2

Usuário

1

Disponível

9.3

Usuário

1

Disponível


Códigos Retorno de Validações

Code: 200 - OK

Este código é a resposta de status de sucesso que indica que a requisição foi bem-sucedida.

Code: 201 - Created

Este código é retornado quando a requisição foi bem-sucedida e um registro é criado com sucesso.

Code: 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.

a- Item obrigatório

b- Formato incorreto

c- Ids inexistente.

d- Algum parâmetro está incorreto ou é inexistente

Code: 401 – Unauthorized

Este erro é retornado quando ocorre alguma falha na autorização e/ou os parâmetros de autenticação estão incorretos.

Code: 404 Not Found

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

Code: 422 - Unprocessable

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

Code: 500 - Server Error

Este erro é retornado quando:

  • Ocorre um erro interno no servidor.

  • Ocorre uma falha na plataforma ArqGed.

  • Formato do parâmetro incorreto.

  • Formato do JSON incorreto.

Última actualización