Descrição dos campos de chamada e retorno

Chamada 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 Tipo 

 

 

 

 

 mas_cod_prod 

 

 

 Código do semelhante. Iniciar a sequência de requisições pelo menor código de semelhante, por exemplo, 0. 

 

 

 String 

 

 

 

 

 mas_origem 

 

 

 Origem do semelhante. Iniciar a sequência de requisições pelo menor código de origem, por exemplo, 0. 

 

 

 String 

 

 

 

 

 retornar_excluidos 

 

 

 Caso "false" será retornado apenas os semelhantes ativos. Caso "true" será retornado apenas os semelhantes excluídos. 

 

 

 Boolean 

 

 

 

 

 paginacao 

 

 

 Quantidade de registros retornados por requisição com um limite de 100.  

 

 

 Numerico 

 

 

 

 

 ponteiro_atualizacao 

 

 

 Controle do envio de registros novos, modificados e excluídos. 

 

 

 String 

 

 

 

 

 

 Paginação : Quando a quantidade de registros a serem exibidos excede o valor informado no parâmetro "paginação", é necessário fazer uma nova requisição para listar os registros restantes. Para isso, é preciso combinar os campos " mas_cod_prod " e " mas_origem " informando-os com os  últimos valores  da  requisição anterior .  

 

 Ponteiro_atualização : Esse parâmetro garante o retorno somente dos registros novos, alterados ou excluídos a partir de uma determinada data e hora. A máscara utilizada é:  aaaammddhhmmss . O valor desse campo deve ser armazenado para requisições de atualizações, evitando assim, o envio do cadastro todo. 

   

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 Tipo 

 

 

 

 

 total_registro 

 

 

 Quantidade de registros retornados 

 

 

 Numeric 

 

 

 

 

 cod_prod 

 

 

 Código do produto original 

 

 

 String 

 

 

 

 

 mat_origem 

 

 

 Origem do produto original 

 

 

 String 

 

 

 

 

 mas_cod_prod 

 

 

 Código do semelhante 

 

 

 String 

 

 

 

 

 mas_origem 

 

 

 Origem do semelhante 

 

 

 String 

 

 

 

 

 mas_desc 

 

 

 Descrição do semelhante 

 

 

 String 

 

 

 

 

 mas_dt_incl 

 

 

 Data de criação do semelhante 

 

 

 String 

 

 

 

 

 usu_nome 

 

 

 Usuário responsável pela criação do semelhante 

 

 

 String 

 

 

 

 

 excluido 

 

 

 Caso "true" o semelhante está excluído. Caso "false" o semelhante encontra-se ativo. 

 

 

 Boolean 

 

 

 

 

 cod_status 

 

 

 Código de retorno da requisição 

 

 

 String 

 

 

 

 

 msg_status 

 

 

 Mensagem de retorno da requisição 

 

 

 String 

 

 

 

 

 ponteiro_atualizacao 

 

 

 Armazena a data e hora da requisição com a máscara: aaaammddhhmmss

 

 

 

 String 

 

 

 

 

   

 Tabela de código

(campos "cód_status" e "msg_status" ) 

 

 

 

 

 cod_status 

 

 

 msg_status 

 

 

 

 

 0 

 

 

 Retorno com sucesso 

 

 

 

 

 10 

 

 

 Ocorreu uma falha na aplicação 

 

 

 

 

 401 

 

 

 Token inválido ou expirado