Índice

1. Informações Gerais

Especificação
Produto	Microsiga Protheus	Módulo	Jurídico
Segmento Executor	Serviços
Projeto		IRM
Requisito		Subtarefa

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/jur/process

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

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "operation": "ListProcess",
    "userName": "Totvers",
    "length": 11,
    "processes": [
        {
  			"processId": "0000000063",
            "fup": [
                {
                    "tipFup": "1",
                    "id": "1000000021",
                    "status": "001",
                    "responsable": [
                        {
                            "id": "002195",
                            "acronym": "CTS",
                            "email": "2382-6818",
                            "name": "CLOVIS EDUARDO TEIXEIRA",
                            "fone": "[email protected]"
                        }
                    ],
                    "title": "Em aberto",
                    "date": "20171027",
                    "hour": "10:00"
                }
            ],
            "injuctions": [
			           {
                            "id": "0000000001",
							"title": "Liminar Revogada", 
							"date": "20170322",
							"sentence": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."}],			
            "assJurDesc": "Contencioso",
            "status": [
                {
                    "description": "Em andamento",
                    "code": "1"
                }
            ],
            "values_and_contingency": [
                {
                    "values": [
                        {
                            "currency": "R$",
                            "description": "",
                            "value": 1000
                        }
                    ],
                    "description": "CT059-JURA162",
                    "probability_of_winning": ""
                }
            ],
            "party": [
                {
                    "position": "",
                    "id": "0000000066",
                    "relationName": "Reclamante",
                    "relationCode": "01",
                    "name": "LEGALTASK 001",
                    "main": "1",
                    "entity": "JLT00101",
                    "sourceEntity": "SA1",
                    "code": "JLT001-01",
                    "positionCode": ""
                }
            ],
            "oppositeParty": [             
                 {                 
					"position": "",                  
					"id": "0000000072",                  
					"relationName": "Reclamante",
                    "relationCode": "01",                  
					"name": "CLIENTE IR/ISS ANDREA",                 
					"main": "1",                   
					"entity": "00000601",               
					"sourceEntity": "SA1",                 
					"code": "000006-01",
                 	 "positionCode": "",       
			   }          
			],
            "expenses": [
                {
                    "identifier": "Taxi",
                    "description": "CT-007",
                    "date": "20161208",
                    "value": ""
                },
                {
                    "identifier": "TIPO DE DESPESA EXCLUSIVO P/ CT013 (JURA099)",
                    "description": "CT013-JURA099",
                    "date": "20161208",
                    "value": ""
                },
            ],
				    "area": [
                {
                    "description": "Trabalhista",
                    "code": "001"
                }
            ],
            "subarea": [
                {
                    "description": "CONTENCIOSO",
                    "code": "000001"
                }
            ],
            "assJur": "001",
            "assJurDesc": "Contencioso",
            "instance": [
                {
                    "districtCourt": "Tribunal de Justica",
                    "distribution": "",
                    "processNumber": "090807060504030201",
                    "branch": "3a Camara do Tribunal de Justica do Estado de SP",
                    "id": "0000000063",
                    "instaAtual": "1",
                    "city": "",
                    "cityCode": "",
                    "numInstance": "1",
                    "natureCode": "001",
                    "local": "Sao Paulo",
                    "displayName": "1a Instancia",
                    "nature": "Judicial"
                }
            ],
            "decisions" : [
                {
					"id": "0000000001",
                    "title": "Setença Procedente",
                    "date": "20170222",
                    "sentence" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 							                                   
						Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "instance": "1ª"
                }
            ],
            "guarantees" : [
                {
                    "identifier": "G",
                    "description": "Depósito Recursal",
                    "date": "20170222",
                    "value": 10000.00
                }
            ],
            "matter": [
                {
                    "description": "LEGALTASK 001//090807060504030201",
                    "code": "000001"
                }
            ],
            "entryDate": "20170928",
            "staff": [
                {
                    "position": "Responsável",
                    "initials": "WYK",
                    "name": "WILLIAN KAZAHAYA"
                },
                {
                    "position": "Advogado",
                    "initials": "",
                    "name": ""
                },
                {
                    "position": "Estagiário",
                    "initials": "",
                    "name": ""
                }
            ],
            "closure": [
                {
                    "veredict": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
                                consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "finalValue":  1000.00,,
                    "description": "VITÓRIA",
                    "date": "YYYYMMDD",
                    "type": "1"
                }
            ],
            "company": [
                {
                    "name": "LEGALTASK 001",
                    "code": "JLT001-01"
                }
            ],
            "history": [
                {
                    "id": "0000000010",
                    "title": "Acompanhamento Decisória",
                    "date": "20171017"
                },
                {
                    "id": "0000000013",
                    "title": "Acompanhamento Decisória",
                    "date": "20171023"
                }
            ]
        }
    ]
}

Descrição dos Campos:

userName: Nome do usuário logado.
hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
processes: Array de processos.
processes[n].processId: Identificador único do processo.
operation: Qual tipo de operação.
processes[n].oppositeParty: Parte contrária principal do processo.
processes[n].values_and_contingency.total: Valor total do processo (somatória dos valores e contingência)
processes[n].fups: Array de Follow Ups do processo. Trazer somente os últimos 4 (ver parâmetro abaixo).
processes[n].fups[e].tipFup: Tipo do FUP.
processes[n].fups[e].id: Identificador único do FUP.
processes[n].fups[e].status: Status do follow up: 0->Pendente, 1->Concluído, 2->em andamento.
processes[n].fups[e].responsable: Array de Responsável pelo Follow up.
processes[n].fups[e].responsable[x].id: Id do resposavel do Follow up.
processes[n].fups[e].responsable[x].acronym: Acrónimo do resposavel do Follow up.
processes[n].fups[e].responsable[x].email: Email do resposavel do Follow up.
processes[n].fups[e].responsable[x].name: Nome do resposavel do Follow up.
processes[n].fups[e].responsable[x].fone: Fone do resposavel do Follow up.
processes[n].fups[e].title: Título do follow up.
processes[n].fups[e].date: Data do FollowUp no formato YYYYMMDD.
processes[n].fups[e].hour: Hora do follow up no formato HH:mm.
processes[n].injuctions: Array com liminares do processo.
processes[n].injuctions[w].id: Código da liminar,
processes[n].injuctions[w].title: Título da liminar.
processes[n].injuctions[w].date: Data da liminar.
processes[n].injuctions[w].sentence: Texto da liminar.
processes[n].status: Array com Status do processo. ( Em Andamento, Encerrado)
processes[n].status.description: Descrição do Status.
processes[n].status.code: Código do Status.
processes[n].values_and_contingency: Array de Valores e Contigência.
processes[n].values_and_contingency.values: Array de valores.
processes[n].values_and_contingency.values[y].currency: Descrição do valor.
processes[n].values_and_contingency.values[y].description: Símbolo da moeda do valor.
processes[n].values_and_contingency.values[y].value: Valor.
processes[n].values_and_contingency.description: Descrição
processes[n].values_and_contingency.probability_of_winning:
processes[n].party: Array com as partes envolvidas no processo.
processes[n].party[k].position: Cargo do envolvido.
processes[n].party[k].id: ID do envolvido.
processes[n].party[k].relationName: Nome da relação do envolvido.
processes[n].party[k].relationCode: Código da relação do envolvido.
processes[n].party[k].name: Nome do envolvido.
processes[n].party[k].main: Main do envolvido.
processes[n].party[k].entity: Entidade do envolvido.
processes[n].party[k].sourceEntity:Tabela do envolvido.
processes[n].party[k].code: Código do envolvido.
processes[n].party[k].positionCode: Código da posição do envolvido.
processes[n].expenses: Array com as despesas do processo.
processes[n].expenses[g].identifier: Identificador do tipo de despesa (D, etc).
processes[n].expenses[g].description: Descrição da despesa.
processes[n].expenses[g].date: Data da despesa.
processes[n].expenses[g].value: Valor da despesa.
processes[n].subArea: Array com as Subáreas do processo.
processes[n].subArea[i].description: Descrição da Subárea do processo.
processes[n].subArea[i].code: Código da Subárea do processo.
processes[n].assJur: Código Assunto.
processes[n].assJurDesc: Descrição Assunto.
processes[n].instance: Array com as Instâncias.
processes[n].instance[a].districtCourt:Tipo do tribunal da Instância.
processes[n].instance[a].distribution: Distribuição da Instância.
processes[n].instance[a].processNumber: Numero do processo da Instância.
processes[n].instance[a].branch: Ramo da Instância.
processes[n].instance[a].id:Id da Instância.
processes[n].instance[a].instaAtual:Código da Instância atual.
processes[n].instance[a].city: Cidade da Instância.
processes[n].instance[a].cityCode: Código da cidade da Instância.
processes[n].instance[a].numInstance: Numero da Instância.
processes[n].instance[a].natureCode: Código da natureza da Instância.
processes[n].instance[a].local: Local da Instância.
processes[n].instance[a].displayName: Nome da Instância.
processes[n].instance[a].nature: Natureza da Instância.
processes[n].decisions: Array de decisões prévias do processo. Os dados serão apresentados na ordem que forem retornados.
processes[n].decisions[t].id: Código do parecer,
processes[n].decisions[t].title: Título do parecer.
processes[n].decisions[t].date: Data do parecer, no formato protheus YYYYMMDD.
processes[n].decisions[t].sentence: Texto do parecer (SE FOR MUITO GRANDE SEPARAR).
processes[n].decisions[t].instance: Instância.
processes[n].guarantees: Array com as garantias do processo.
processes[n].guarantees[z].identifier: Identificador do tipo de garantia (G, A).
processes[n].guarantees[z].description: Descrição da garantia.
processes[n].guarantees[z].date: Data da garantia.
processes[n].guarantees[z].value: Valor da garantia.
processes[n].matter: Array da Pasta (ou caso) do processo.
processes[n].matter[x]:code: Código do caso.
processes[n].matter[x]:Description: Descrição da pasta (ou caso).
processes[n].entryDate: Data de entrada, no formato Protheus YYYYMMDD.
processes[n].staff: Array com os envolvidos do jurídico no processo.
processes[n].staff[m].position: Cargo do envolvido.
processes[n].staff[m].initials: Iniciais do envolvido.
processes[n].staff[m].name: Nome do envolvido.
processes[n].closure: Array que indica dados do encerramento.
processes[n].closure.veredict: Texto do encerramento do processo.
processes[n].closure.finalValue: Valor final do processo.
processes[n].closure.Description: Indica a descrição do motivo do encerramento, campo tabelado.
processes[n].closure.date: Data do encerramento.
processes[n].closure.Type: Indica o código do motivo do encerramento, campo tabelado.
processes[n].company: Array que indica dados da empresa.
processes[n].company[x].name: Nome da empresa.
processes[n].company[x].code: Código da empresa.
processes[n].area: Array com as Áreas do processo.
processes[n].area[i].description: Descrição da área do processo.
processes[n].area[i].code: Código da área do processo.
processes[n].processId: Identificador único do processo.
processes[n].history: Array de andamentos do processo.
processes[n].history[q].id: Id do andamento.
processes[n].history[q].title: Título do andamento.
processes[n].history[q].date: Data do andamento.

Parâmetros aceitos:

language

- Indica o idioma que os labels deverão ser retornados. Todos os labels que puderem ser traduzidos devem ser traduzidos. Os seguintes idiomas poderão ser selecionados pelo app: "en"=Inglês, "pt"="Português", "es"="Espanhol. Qualquer valor diferente dos citados (ou a omissão do parâmetro) deve considerar como padrão o "pt".

order

Ordem padrão.

page e pageSize

Utilizados para fazer paginação.

A primeira página é a 1

Se não for enviado um page, considerar a página 1.

Se não for passado um pageSize, considerar o tamanho de página como 10.

TODA requisição de lista deve retornar um atributo hasNext indicando se atingiu a última página ou não.

Exemplos (Supondo que existam 32 registros na base):

GET /processes -> Retorna a página padrão (1) com tamanho padrão (10) (registro do 1 ao 10, hasNext = true)

GET /processes?page=1 -> Retorna a página 1 com tamanho padrão (10) (registro de 1 ao 10, hasNext = true)

GET /processes?pageSize=3 -> Retorna a página padrão (1) com tamanho 3 (registro de 1 ao 3, hasNext = true)

GET /processes?page=2&pageSize=4 -> Retorna a página (2) com tamanho (4) (registro do 5 ao 8, hasNext = true)

GET /processes?page=4&pageSize=10 -> Retorna a página (4) com tamanho (10) (registro do 31 ao 40 -> irá retornar só o 31 e o 32, hasNext = false)

etc.

fields

Informa quais campos devem ser retornados na requisição.

Se o fields não for informado, trazer todos os campos disponíveis.

Exemplos:

GET /processess?fields=processId,client,detailing -> Retorna somente os campos ID do processo, Cliente e Detalhamento.

GET /processes -> Retorna todos os campos disponíveis.

Filtros

Deve suportar filtrar os resultados de acordo com alguns parâmetros:

- searchKey: Filtro chave, capaz de filtrar em diversos campos diferentes do processo (máximo de lugares possível. Exemplos: processId, company, companyName, matterDescription, processNumber, staff, party, closed)

- area: Filtra pela área

- subarea: Filtra pela subarea

- status: Filtra pelo status do processoid

- entryDateStart: Filtra pela data de entrada do processo, datas maiores ou iguais às informadas

- entryDateEnd: Filtra pela data de entrada do processo, datas menores ou iguais às informadas

- distributionDateStart: Filtra pela data de distribuição do processo, datas maiores ou iguais às informadas

- distributionDateEnd: Filtra pela data de distribuição do processo, datas menores ou iguais às informadas

- originInstance: Filtra pela instância de origem, será enviado o código da instância de origem

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

3.2. Get/jur/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.

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "operation": "DetailProcess",
    "userName": "Totvers",
    "length": 1,
    "processes": [
        {
            "fup": [
                {
                    "tipFup": "1",
                    "id": "1000000021",
                    "status": "001",
                    "responsable": [
                        {
                            "id": "002195",
                            "acronym": "CTS",
                            "email": "2382-6818",
                            "name": "CLOVIS EDUARDO TEIXEIRA",
                            "fone": "[email protected]"
                        }
                    ],
                    "title": "Em aberto",
                    "date": "20171027",
                    "hour": "10:00"
                }
            ],
            "injuctions": [
			           {
							"title": "Liminar Revogada", 
							"date": "20170322",
							"sentence": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."}],			
            "assJurDesc": "Contencioso",
            "status": [
                {
                    "description": "Em andamento",
                    "code": "1"
                }
            ],
            "values_and_contingency": [
                {
                    "values": [
                        {
                            "currency": "R$",
                            "description": "",
                            "value": 1000
                        }
                    ],
                    "description": "CT059-JURA162",
                    "probability_of_winning": ""
                }
            ],
            "party": [
                {
                    "position": "",
                    "id": "0000000066",
                    "relationName": "Reclamante",
                    "relationCode": "01",
                    "name": "LEGALTASK 001",
                    "main": "1",
                    "entity": "JLT00101",
                    "sourceEntity": "SA1",
                    "code": "JLT001-01",
                    "positionCode": ""
                }
            ],
            "expenses": [
                {
                    "identifier": "Taxi",
                    "description": "CT-007",
                    "date": "20161208",
                    "value": ""
                },
                {
                    "identifier": "TIPO DE DESPESA EXCLUSIVO P/ CT013 (JURA099)",
                    "description": "CT013-JURA099",
                    "date": "20161208",
                    "value": ""
                },
            ],
            "subarea": [
                {
                    "description": "CONTENCIOSO",
                    "code": "000001"
                }
            ],
            "assJur": "001",
            "instance": [
                {
                    "districtCourt": "Tribunal de Justica",
                    "distribution": "",
                    "processNumber": "090807060504030201",
                    "branch": "3a Camara do Tribunal de Justica do Estado de SP",
                    "id": "0000000063",
                    "instaAtual": "1",
                    "city": "",
                    "cityCode": "",
                    "numInstance": "1",
                    "natureCode": "001",
                    "local": "Sao Paulo",
                    "displayName": "1a Instancia",
                    "nature": "Judicial"
                }
            ],
            "decisions" : [
                {
                    "title": "Setença Procedente",
                    "date": "20170222",
                    "sentence" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo 							                                   
						Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "instance": "1ª"
                }
            ],
            "guarantees" : [
                {
                    "identifier": "G",
                    "description": "Depósito Recursal",
                    "date": "20170222",
                    "value": 10000.00
                }
            ],
            "matter": [
                {
                    "description": "LEGALTASK 001//090807060504030201",
                    "code": "000001"
                }
            ],
            "entryDate": "20170928",
            "staff": [
                {
                    "position": "Responsável",
                    "initials": "WYK",
                    "name": "WILLIAN KAZAHAYA"
                },
                {
                    "position": "Advogado",
                    "initials": "",
                    "name": ""
                },
                {
                    "position": "Estagiário",
                    "initials": "",
                    "name": ""
                }
            ],
            "closure": [
                {
                    "veredict": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
                                consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
                    "finalValue":  1000.00,,
                    "description": "VITÓRIA",
                    "date": "YYYYMMDD",
                    "type": "1"
                }
            ],
            "company": [
                {
                    "name": "LEGALTASK 001",
                    "code": "JLT001-01"
                }
            ],
            "area": [
                {
                    "description": "Trabalhista",
                    "code": "001"
                }
            ],
            "processId": "0000000063",
            "history": [
                {
                    "id": "0000000010",
                    "title": "Acompanhamento Decisória",
                    "date": "20171017"
                },
                {
                    "id": "0000000013",
                    "title": "Acompanhamento Decisória",
                    "date": "20171023"
                }
            ]
        }
    ]
}

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

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

Retorna os Follow Ups dos Processos, no seguinte formato:

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
     "hasNext": true,
      "fups" : [
         {
            "id": "000001",
            "date": "20160823",
            "hour": "14:00",
            "status": 0,
            "title": "Reunião de Negócios",
            "responsable": "JPB - João Pereira Bittencourt"
        }
    ]
}

Descrição dos Campos:

hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
fups: Array de fups.
fups[n].id: Identificador do Fup.
fups[n].date: Data do Fup.
fups[n].hour: Hora do Fup.
fups[n].status: Status do Fup.
fups[n].title: Titulo do Fup.
fups[n].responsable: Responsavel do Fup.

Os parâmetros aceitos serão: fields, searchKey, page e pageSize

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

3.4. GET /jur/areas

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

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "hasNext": true,
    "areas" : [
        {
            "id": "000001",
            "description": "TRABALHISTA"
        }
    ]
}

Descrição dos Campos:

hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
areas: Array das areas.
areas[n].id: Id da area.
areas[n].description: Descrição da area.

Os parâmetros aceitos serão: searchKey, page e pageSize.

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

3.5. GET /jur/areas/{areaId}/subareas

Retorna as subareas disponíveis da área informada no parâmetro {areaId}, no seguinte formato:

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "hasNext": true,
    "subareas" : [
        {
            "id": "000001",
            "description": "CONTENCIOSO"
        }
    ]
}

Descrição dos Campos:

hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
subareas: Array das subareas.
subareas[n].id: Id da subarea.
subareas[n].description: Descrição da subarea.

Os parâmetros aceitos serão: searchKey, page e pageSize.

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

3.6. GET /jur/originInstances

Retorna as instâncias de origem disponíveis, no seguinte formato:

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "hasNext": true,
    "originInstances" : [
        {
            "id": "000001",
            "displayName": "FORO REGIONAL DE SÃO PAULO",
            "branch": "5ª Vara Cível",
            "local": "SÃO PAULO"
        }
    ]
}

Descrição dos Campos:

hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).
originInstances: Array das instancias de origem.
originInstances[n].id: Id da instancia.
originInstances[n].displayName: Descrição da instancia.
originInstances[n].branch: Ramo da instancia.
originInstances[n].local: Local da instancia.

Os parâmetros aceitos serão: searchKey, page e pageSize.

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:

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

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

4.2. Tentativa de acesso à um dado restrito

Deve retornar um status http 403 FORBIDDEN.

Os serviços ficam responsáveis por verificar se o usuário logado tem acesso aos recursos solicitados independentemente de qualquer controle realizado no lado do aplicativo.

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "code": "403", 
    "message": "Acesso Negado",
    "detalMessage": "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.

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
    "code": "403", 
    "message": "Acesso Negado",
    "detalMessage": "É preciso estar logado para acessar este recurso"
}

Árvore de páginas

Versões comparadas

Versão antiga 64

Nova versão 65

Chave

1. Informações Gerais

2. Objetivo

3. Definições de Serviços

3.1. GET/jur/process

3.2. Get/jur/processes/{processID}

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

3.4. GET /jur/areas

3.5. GET /jur/areas/{areaId}/subareas

3.6. GET /jur/originInstances

4 Mensagens de Erro

4.1. Corpo padrão da resposta

4.2. Tentativa de acesso à um dado restrito

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

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 64

Nova versão 65

Chave

1. Informações Gerais

2. Objetivo

3. Definições de Serviços

3.1. GET/jur/process

3.2. Get/jur/processes/{processID}

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

3.4. GET /jur/areas

3.5. GET /jur/areas/{areaId}/subareas

3.6. GET /jur/originInstances

4 Mensagens de Erro

4.1. Corpo padrão da resposta

4.2. Tentativa de acesso à um dado restrito

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