Histórico da Página

Busca status do Log de exceções e processos (Rastro)

(Obrigatório)

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

Objetivo

Criar API com a finalidade de visualizar o conteúdo do parâmetro MV_PROCLOG da entidade.

(Obrigatório)

Definição da Regra de Negócio

A API será na estrutura WS REST com o nome RestViewPar e com apenas o método GET, que receberá a mensagem JSON codificada em base64 e chamará a função ViewParTss() passando a mensagem JSON decodificada.

Através da API, os clientes do TSS poderão visualizar o conteúdo do parâmetro MV_PROCLOG. A visualização do parâmetro será por entidade. O critério para visualização será com base nos dados de entrada. A API terá como retorno o conteúdo do parâmetro.

O consumo da API deverá ser realizado através de mensagens JSON definidas na função ViewParTss().

O processo de Deserialização de mensagens deverá ser realizado através da função FwJsonDeserialize().

Os códigos de status serão baseados no formato padrão de mensagens HTTP, conforme o link:

https://pt.wikipedia.org/wiki/Lista_de_c%C3%B3digos_de_status_HTTP

WebService: RestViewPar
WebService responsável pela definição da Interface da API que busca status do Log de exceções e processos (Rastro).
O WebService deverá receber mensagens na estrutura JSON codificado em base64, onde serão decodificadas e passadas como parâmetro para a função ViewParTSS().
O retorno do WebService será uma mensagem JSON.
Todos os parâmetros da mensagem serão obrigatórios.

Parâmetros: 

JSon = ew0KImVtcHJlc2EiOg0Kew0KIkVudGlkYWRlIjogIjAwMDAwMiINCn0sDQp9

Mensagem JSON decodificada:
{

"empresa":

{

"Entidade": "000002"

},

}
 

Retorno:

Retorno Negativo:
{

"result":{"parametro":{}} ,

"error": " Entidade não informada ou diferente de string. "

}

Retorno Positivo:
{

"result":{"parametro":{"Nome":"MV_PROCLOG","Conteudo":"0"}},

"error": null }

Função: ViewParTss()

Função responsável pela definição da Interface da API “visualiza conteúdo do parâmetro MV_PROCLOG”.

A função ViewParTss definirá a estrutura da API. A função deverá ser definida em um fonte.prw definido com o mesmo nome da função.

A função ViewParTss deverá ser implementada apenas como função de interface para a API. Deverá ser totalmente desacoplada de qualquer definição de instrução de processamento, devendo apenas realizar as devidas validações das mensagens. Todo o processamento deverá estar definido em funções auxiliares.

A função PutParTss deverá receber mensagens na estrutura JSON, onde serão convertidas em objeto pela função fwJsonDeserialize().

Caso não haja erro na deserialização de JSON para objeto, será chamada a rotina RetViewPar(), passando como parâmetro o objeto.

A função RetViewPar()  o conteúdo do parâmetro MV_PROCLOG da entidade. Este dado lógico será passado como parâmetro para a função getJSONResp() junto com o código de status e mensagem de erro (caso exista). O retorno da função getJSONResp() é a mensagem  já na estrutura JSON.

Todos os parâmetros da mensagem serão obrigatórios.

A rotina ViewParTss() será finalizada e como retorno será passado a mensagem na estrutura JSON.

Parâmetros: 

cJsonRequest =
{

"empresa":

{

"Entidade": "000002"

},

}
 

Retorno:

Retorno Negativo:
{

"result":{"parametro":{}} ,

"error": " Entidade não informada ou diferente de string. "

}

Retorno Positivo:
{

"result":{"parametro":{"Nome":"MV_PROCLOG","Conteudo":"0"}},

"error": null }

Função: ValView()

A função ValView() receberá como parâmetro o objeto da requisição, validará todos os campos quanto a obrigatoriedade, tamanho e tipo de dados. Se algum dado estiver inconsistente, deverá retorna a mensagem de validação correspondente informando.

Os dados contidos no objeto recebido como parâmetro, serão validados afim de identificar quais foram preenchidos, todos os campos são necessários para o retorno.

Com as informações tipo de documento e número da entidade, será chamada a função RetViewPar(), para essa função serão passados como parâmetros: o número da entidade do cliente. O retorno desta função será o conteúdo do parâmetro MV_PROCLOG da entidade passada como parâmetro.

Após obter o retorno da rotina RetViewPar(), a função ValView() será encerrada.

Parâmetros: 

GetXml(oDados,cError)

oDados – Objeto contendo as informações da requisição: entidade.

cError – Mensagem de erro, caso exista.

Retorno:

aMatriz – Array contendo o nome do parâmetro e o conteúdo do parâmetro.

Função: RetViewPar()

A função RetViewPar() receberá como parâmetro, a entidade do cliente afim de obter conteúdo do parâmetro MV_PROCLOG da entidade, que está contido na tabela SPED000.

A função verificará se o parâmetro existe, caso exista, obtém o conteúdo do parâmetro MV_PROCLOG. Está informação será o retorno da função.

Parâmetros: 

(cEntcError)

cEnt – Código da entidade do cliente.

cError – Mensagem de erro, caso exista.

Retorno:

aMatriz – Array contendo o nome do parâmetro e o conteúdo do parâmetro.

Função: GetJSONResp()

A rotina consiste em obter os dados de entrada e gerar a mensagem em estrutura JSON.

A rotina retornará uma string na estrutura JSON

Parâmetros: 

aArray – Array multidimensional.

cError – Mensagem de erro.

Retorno:

cJSONResponse – String na estrutura JSON.