API - Leitura de regras RT
Método: GET
API Rest/ Json: https://wscockpit.systax.com.br/api/api/RegrasReforma/reforma/
{paginacao}/{ponteiro}/{paramProxPag}
Obs.: dada a utilização do método GET, os parâmetros da chamada são informados na própria URL e não há body.
Descricão dos parâmetros da chamada
|
Parâmetro |
Detalhamento do preenchimento |
Obrigatório |
|
Paginação |
Quantidade de registros/regras a serem entregues por página. Limite máximo 100. |
Sim |
|
Ponteiro |
Ponteiro do controle de atualização. |
Sim |
|
-Para carga inicial (recebimento de todas as regras), informar 0. |
||
|
-Para atualizações, informar o ponteiro retornado na primeira chamada do dia anterior (ou o ponteiro retornado na primeira chamada do processo anterior, caso seja realizado mais de um processo de leitura por dia). |
||
|
paramProxPag |
É o dado recebido no response que identificará quais regras devem retornar na próxima página. Na primeira chamada do processo, informar 0. Sempre que a quantidade de regras retornadas for igual ao valor informado no critério "paginacao", deverá ser feita mais uma chamda para obter a próxima página. A partir da 2ª chamada, informar no parâmetro "paramProxPagina" o valor retornado no campo "paramProxPagina" do response da página anterior. |
Sim |
Descrição dos campos de retorno
|
Parâmetro |
Detalhamento do preenchimento |
Obrigatório |
|
Ponteiro |
- |
Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo. Essa informação é retornada na primeira página do processo de carga e deverá ser armazenada para servir de parâmetro para utilização na próxima carga, que identificará quais regras já foram recebidas no processo anterior e, portanto, não deverão ser entregues novamente. |
|
codStatus |
status |
Código de retorno |
|
msgStatus |
status |
Mensagem de retorno |
|
paramProxPag |
- |
Retorna o resultado da concatenação de "IdCenario | codigoProduto | origemProduto" do último produto e cenário retornado nesta página. O objetivo é usar este valor como parâmetro na request da próxima página para definir quais regras devem retornar nesta, assim a primeira regra a ser entregue deverá ser a regra do produto e cenário identificados nesta concatenação e as próximas regras deverão ser as que são subsequentes à primeira. |
|
retorno tributário |
- |
O detalhamento do retorno a partir deste campo consta no item "Informações da RT retornadas no Cockpit" deste manual. |
Mensagens de retorno
|
cod_status |
msg_status |
|
200 |
Sucesso |
|
401 |
Token ou Login/ Senha inválidos |
|
500 |
Falha na aplicação |
|
901 |
Usuario sem cliente |
|
902 |
Cliente sem connection string |