Índice

1. Informações Gerais

2. Objetivo

Os serviços especificados neste serão consumidos pelo aplicativo Legal Process e tem por objetivo permitir ao usuário consultar os processos cadastrados na base Protheus de um smartphone ou tablet.

3. Definições de Serviços

3.1. GET/JURLEGALPROCESS/process

Retorna a lista de processos disponíveis para consulta, no formato indicado abaixo:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.2. Get/JURLEGALPROCESS/processes/{processID}

Este serviço deve retornar somente um processo, com os detalhes do mesmo. Os atributos retornados seguem o mesmo padrão do serviço que retorna a lista de processos, porém, este serviço somente aceita o parâmetro fields.

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.3. GET /JURLEGALPROCESS/processes/{processID}/fups

Retorna os Follow Ups dos Processos, no seguinte formato:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.4. GET /JURLEGALPROCESS/areas

Retorna as áreas disponíveis, no seguinte formato:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.5. GET /JURLEGALPROCESS/tlprocess/grupoAprv

Retorna os grupos de aprovação, no seguinte formato:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.6. GET /JURLEGALPROCESS/tlprocess/tabGen/{codTabela}

Retorna dados da tabela genérica (SX5), filtrando pelo código da tabela informado, no seguinte formato:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.7. GET /JURLEGALPROCESS/tlprocess/sysParam/{codParam}

Retorna o valor do parâmetro informado, no seguinte formato:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.8. GET /JURLEGALPROCESS/fields

Retorna a lista de campos disponíveis para pesquisa, no seguinte formato:

...

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

3.9. GET /JURLEGALPROCESS/f3list/{campof3}

Retorna a lista de ítens do campo tabelado requisitado, no seguinte formato:

{
    "f3Options": [
        [
            "0001",
            "Horas extras"
        ]
    ]
}

Descrição dos Campos:

• f3Options: Array trazendo as opções para o campo F3

O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.

4. Mensagens de Erro

As mensagens de erro deveram obedecer um padrão único, independente do serviço solicitado, de acordo com a ocorrência.

4.1. Corpo padrão da resposta

Todas as mensagens de erro devem possuir a mesma estrutura de campos na resposta:

{
    "code": "Código do Erro", 
    "message": "Título da mensagem de erro",
    "detailMessage": "Mensagem de erro detalhada"
}

4.2. Tentativa de acesso à um dado restrito

Deve retornar um status http 403 FORBIDDEN.

...

{
    "code": "403", 
    "message": "Acesso Negado",
    "detailMessage": "O usuário informado não tem acesso à informação solicitada"
}

4.3. Não conseguiu identificar o usuário logado

Deve retornar um status http 400 UNAUTHORIZED.

...