Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user ANDREW SHIN YAO CHIANG_

Gravado em

comparado com

Nova versão 2

changes.mady.by.user CAIQUE MELO TORETTA

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 

  •  1 Objetivo
  •  2 GET/JURFWREST/fup
    • 2.1  Parâmetros aceitos 
    • 2.2  Retorno
  •  3 GET/JURFWREST/fup/{codFup}
    • 3.1 Parâmetros aceitos
    • 3.2 Retorno
  • 4 GET/JURFWREST/docs/{codDoc}
    • 4.1 Parâmetros aceitos
    • 4.2 Retorno
  • 5 GET/JURFWREST/categories
    • 5.1 Parâmetros aceitos
    • 5.2 Retorno
  • 6 GET/JURFWREST/status
    • 6.1 Parâmetros aceitos
    • 6.2 Retorno
  • 7 POST/JURFWREST/fup/{codFup}/docs
    • 7.1 Parâmetros aceitos 
    • 7.2 Retorno
  • 8 PUT/JURFWREST/fup/{codFup}
    • 8.1 Parâmetros aceitos
    • 8.2 Retorno
  • 9 Mensagens de erro
    • 9.1 Corpo padrão da resposta
    • 9.2 Erro de validação
    • 9.3 Tentativa de acesso á um dado restrito
    • 9.4 Não conseguiu identificar o usuário logado

 

Objetivo

Os serviços especificados neste serão consumidos pelo aplicativo Legal Task e tem por objetivo permitir ao usuário realizar e consultas dos Follow-up através de seu smartphone.

GET / JURFWREST /fup - {ListFup}

Retorna a lista de follow-ups do usuário logado.

Parâmetros aceitos

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".

ParâmetroTipoDescriçãoValor Defaut
PagenumberPágina inicial que será retornada1
PageSizenumberTamanho da página que será retornada10
FieldsstringLista de campos (separados por vírgula) que devem ser retornados.-

 

Retorno 

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
operationstringNome da operação 
hasNextstringIndica se existe mais uma página de registros 
dataArrayUm array de objetos 
data[n], descstringDescrição do Follow-up 
data[n]. pedidos.tipostringTipo de pedido do processo 
data[n]. pedidos.valornumberValor do pedido do processo 
data[n]. pedidos.progstringProg do pedido do processo 
data[n]. autorstringAutor do processo 
data[n]. datafustringData do Follow-up 
data[n]. acaostringTipo de ação do processo 
data[n]. forostringForo do processo 
data[n]. siglastringSigla do responsável 
data[n]. numprostringNumero do processo 
data[n]. detailstringDetalhe do processo 
data[n]. resp.nomestringNome do responsável do processo 
data[n]. resp.siglastringSigla do responsável do processo 
data[n]. resp.emailstringE-mail do responsável do processo 

data[n]. resp.fone

stringTelefone do responsável do processo 
data[n]. provnumberValor de provisão 
data[n]. outrosEnvolvidos.NomestringNome dos outros envolvidos 
data[n]. outrosEnvolvidos.TelefonestringTelefone dos outros envolvidos 
data[n]. outrosEnvolvidos.TipoEnvstringTipo de envolvimento 
data[n]. outrosEnvolvidos.EmailstringE-mail dos outros envolvidos 
data[n]. tipofu.descristringDescrição do tipo do follow-up 
data[n]. tipofu.codigostringCódigo do tipo do follow-up 
data[n]. preposto.nomestringNome do preposto 
data[n]. preposto.telefonestringTelefone do preposto 
data[n]. preposto.emailstringE-mail do preposto 
data[n]. reustringReu do processo 
data[n]. duraçãostringDuração do Follow-up 
data[n]. endForostringEndereço do processo 
data[n]. partcontstringParte contraria 
data[n]. documentos.idDocstringId do documento do Follow-up 
data[n]. documentos.NomeDocstringNome do documento do Follow-up 
data[n]. horastringHora do Follow-up 
data[n]. idFustringCódigo do Follow-up 
data[n]. varastringVara do processo 
data[n]. resultstringCódigo do resultado 
data[n]. pedvaltotnumberValor total do pedido 
lengthnumberQuantidade de documentos exibidos 

Exemplo de retorno da requisição

Bloco de código
languagejs
themeRDark
titleresponse.json
{
    "operation": "ListFup",
    "hasNext": "false",
    "data": [
        {
            "desc": "",
            "pedidos": [
                {
                    "tipo": "Férias",
                    "valor": 1000,
                    "prog": "Provável"
                },
                {
                    "tipo": "Férias",
                    "valor": 50,
                    "prog": "Provável"
                }
            ],
            "autor": "CLIENTE 01",
            "datafu": "2017-08-15",
            "acao": "Abertura, Registro e Cumprimento de Testamento",
            "foro": "Foro Regional I - Santana",
            "sigla": "MAD  ",
            "numpro": "11066208820158260100",
            "detail": ".",
            "resp": [
                {
                    "nome": "MARCELO ARAUJO DENTE",
                    "sigla": "MAD",
                    "email": "",
                    "fone": ""
                },
                {
                    "nome": "WILLIAN",
                    "sigla": "WYK",
		    "email": "",
                    "fone": ""
                }
            ],
            "prov": 0,
            "outrosEnvolvidos": [],
            "tipofu": [
                {
                    "descri": "Acompanhamento",
                    "codigo": "00001"
                }
            ],
            "preposto": [
                {
                    "nome": "",
                    "telefone": "",
                    "email": ""
                }
            ],
            "pedvaltot": 1050,
            "reu": "",
            "duracao": "",
            "endForo": "",
            "partcont": "",
            "documentos": [
                {
                    "idDoc": "0000000010",
                    "NomeDoc": "vc_red.msi"
                },
                {
                    "idDoc": "0000000011",
                    "NomeDoc": "3.txt"
                },
                {
                    "idDoc": "0000000012",
                    "NomeDoc": "3.txt"
                },
                {
                    "idDoc": "0000000013",
                    "NomeDoc": "1.txt"
                },
                {
                    "idDoc": "0000000014",
                    "NomeDoc": "6.txt"
                }
            ],
            "hora": "08:42",
            "idFu": "0000000002",
            "vara": "1ª Vara do Juizado Especial Cível",
            "result": "001"
        }
    ],
    "length": 1
}

GET / JURFWRESTT /fup{codFup} - (DetailFup)

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

Parâmetros aceitos

ParâmetroTipoDescriçãoValor Default
fieldsstringLista de campos (separados por vírgula) que devem ser retornados.-

 

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
operationstringNome da operação 
hasNextstringIndica se existe mais uma página de registros 
dataArrayUm array de objetos 
data[n], descstringDescrição do Follow-up 
data[n]. pedidos.tipostringTipo de pedido do processo 
data[n]. pedidos.valornumberValor do pedido do processo 
data[n]. pedidos.progstringProg do pedido do processo 
data[n]. autorstringAutor do processo 
data[n]. datafustringData do Follow-up 
data[n]. acaostringTipo de ação do processo 
data[n]. forostringForo do processo 
data[n]. siglastringSigla do responsável 
data[n]. numprostringNumero do processo 
data[n]. detailstringDetalhe do processo 
data[n]. resp.nomestringNome do responsável do processo 
data[n]. resp.siglastringSigla do responsável do processo 
data[n]. resp.emailstringE-mail do responsável do processo 

data[n]. resp.fone

stringTelefone do responsável do processo 
data[n]. provnumberValor de provisão 
data[n]. outrosEnvolvidos.NomestringNome dos outros envolvidos 
data[n]. outrosEnvolvidos.TelefonestringTelefone dos outros envolvidos 
data[n]. outrosEnvolvidos.TipoEnvstringTipo de envolvimento 
data[n]. outrosEnvolvidos.EmailstringE-mail dos outros envolvidos 
data[n]. tipofu.descristringDescrição do tipo do follow-up 
data[n]. tipofu.codigostringCódigo do tipo do follow-up 
data[n]. preposto.nomestringNome do preposto 
data[n]. preposto.telefonestringTelefone do preposto 
data[n]. preposto.emailstringE-mail do preposto 
data[n]. reustringReu do processo 
data[n]. duraçãostringDuração do Follow-up 
data[n]. endForostringEndereço do processo 
data[n]. partcontstringParte contraria 
data[n]. documentos.idDocstringId do documento do Follow-up 
data[n]. documentos.NomeDocstringNome do documento do Follow-up 
data[n]. horastringHora do Follow-up 
data[n]. idFustringCódigo do Follow-up 
data[n]. varastringVara do processo 
data[n]. resultstringCódigo do resultado 
data[n]. pedvaltotnumberValor total do pedido 
lengthnumberQuantidade de documentos exibidos 

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

Exemplo de retorno da requisição:

Bloco de código
languagejs
themeRDark
titleresponse.json
{
    "operation": "DetailFup",
    "hasNext": "false",
    "data": [
        {
            "desc": "",
            "pedidos": [
                {
                    "tipo": "Férias",
                    "valor": 1000,
                    "prog": "Provável"
                },
                {
                    "tipo": "Férias",
                    "valor": 50,
                    "prog": "Provável"
                }
            ],
            "autor": "CLIENTE 01",
            "datafu": "2017-08-15",
            "acao": "Abertura, Registro e Cumprimento de Testamento",
            "foro": "Foro Regional I - Santana",
            "sigla": "MAD  ",
            "numpro": "11066208820158260100",
            "detail": ".",
            "resp": [
                {
                    "nome": "MARCELO ARAUJO DENTE",
                    "sigla": "MAD",
                    "email": "",
                    "fone": ""
                },
                {
                    "nome": "WILLIAN",
                    "sigla": "WYK",
                    "email": "",
                    "fone": ""
                }
            ],
            "prov": 0,
            "outrosEnvolvidos": [],
            "tipofu": [
                {
                    "descri": "Acompanhamento",
                    "codigo": "00001"
                }
            ],
            "preposto": [
                {
                    "nome": "",
                    "telefone": "",
                    "email": ""
                }
            ],
            "pedvaltot": 1050,
            "reu": "",
            "duracao": "",
            "endForo": "",
            "partcont": "",
            "documentos": [
                {
                    "idDoc": "0000000010",
                    "NomeDoc": "vc_red.msi"
                },
                {
                    "idDoc": "0000000011",
                    "NomeDoc": "3.txt"
                },
                {
                    "idDoc": "0000000012",
                    "NomeDoc": "3.txt"
                },
                {
                    "idDoc": "0000000013",
                    "NomeDoc": "1.txt"
                },
                {
                    "idDoc": "0000000014",
                    "NomeDoc": "6.txt"
                }
            ],
            "hora": "08:42",
            "idFu": "0000000002",
            "vara": "1ª Vara do Juizado Especial Cível",
            "result": "001"
        }
    ],
    "length": 1
}

 

GET / JURFWREST /docs/{codDoc} - (ReturnDocsFup)

Este serviço deve retornar as informações dos Documentos dp Follow-up, com os detalhes da mesma. Este serviço somente aceita o parâmetro codDoc.

Parâmetros aceitos

ParâmetroTipoDescriçãoValor Default
codDocstringRetorno o codigo do documento-

Retorno

O serviço de retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDecriçãoAdicional
operationstringNome da operação 
dataArrayUm array de objetos 
data[n]. numeroDocstringNumero do documento 
data[n]. nomeDocstringNome do documento 
data[n]. origemDocstringOrigem do documento 
data[n]. filialDocstring  
data[n]. codigoDocstringCodigo do documento 
data[n]. extDocstring  
data[n] descrDocstringDescrição do documento 
data[n]. idCodstringid do documento 

Exemplo de retorno da requisição:

Bloco de código
languagejs
themeRDark
titleresponse.json
{
"operation": "ReturnDocsFup",
    "data": [
        {
            "numeroDoc": "",
            "nomeDoc": "1319;1000",
            "origemDoc": "NTA",
            "filialDoc": "01",
            "codigoDoc": "0000000349",
            "extDoc": "",
            "descrDoc": "dtpr006.prt",
            "idCod": "0000000065"
        }
    ]
}

Em caso de erro, o retorno deve ser:

Bloco de código
languagejs
themeRDark
titleresponse.json
{
    "operation": "ListFup",
    "messages": [
        {
            "detail": "Não foram encontrados registros.",
            "code": "1001",
            "type": "Error"
        }
    ],
    "hasNext": "false",
    "data": [],
    "length": 0
}

GET / JURFWREST/categories - (ListTypeFup)

Este serviço deve retornar a lista de Tipo de Follow-up, com os detalhes da mesma. Este serviço, não aceita nenhum parâmetro.

Parâmetros aceitos

nenhum

Retorno

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

PropriedadeTipoDescriçãoAdicional
operationstringIdentificação da operação 
dataArrayArray com os tipos de Follow-up 
data[n]. descriTipoFupstringDescrição do tipo de Follow-up 
data[n]. filialTipoFupstringFilial do tipo de Follow-up 
data[n]. codigoTipoFupstringCodigo do tipo de Follow-up 

Exemplo de retorno de aquisição

Bloco de código
languagejs
themeRDark
titleresponse.json
{
    "operation": "ListTypeFup",
    "data": [
        {
            "descriTipoFup": "Acompanhamento",
            "filialTipoFup": "",
            "codigoTipoFup": "00001"
        },
        {
            "descriTipoFup": "Audiência",
            "filialTipoFup": "",
            "codigoTipoFup": "00002"
        },
        {
            "descriTipoFup": "Julgamento",
            "filialTipoFup": "",
            "codigoTipoFup": "00003"
        },
        {
            "descriTipoFup": "Prazo",
            "filialTipoFup": "",
            "codigoTipoFup": "00004"
        },
        {
            "descriTipoFup": "Providências",
            "filialTipoFup": "",
            "codigoTipoFup": "00005"
        },
        {
            "descriTipoFup": "Reunião",
            "filialTipoFup": "",
            "codigoTipoFup": "00006"
        }
    ]
}

 

GET / JURFWREST /status - (ListStatsFup)

Este serviço deve retornar a lista de status de follow-up, com os detalhes da mesma. Este seviço somente não aceita nenhum parâmetro.