# API Leitura de regras RT

**Método:** GET

**<span lang="EN-US" style="mso-ansi-language: EN-US;">API Rest/ Json: </span>**<span lang="EN-US" style="mso-ansi-language: EN-US;">https://wscockpit.systax.com.br/api/api/RegrasReforma/reforma/</span>

{paginacao}/{ponteiro}/{paramProxPag}

<u>Obs.:</u> 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**

<table border="0" cellpadding="0" cellspacing="0" class="MsoNormalTable" id="bkmrk-par%C3%A2metro-detalhamen" style="border-collapse: collapse; width: 67.2619%; height: 397.3px;"><thead><tr style="height: 23.7px;"><td style="border: 1pt solid windowtext; background: rgb(221, 221, 221); padding: 0cm 3.5pt; width: 19.1653%; height: 23.7px;">**<span style="color: black; mso-fareast-language: PT-BR;">Parâmetro</span>**

</td><td style="border-top: 1pt solid windowtext; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-image: initial; border-left: none; background: rgb(221, 221, 221); padding: 0cm 3.5pt; width: 62.5585%; height: 23.7px;">**<span style="color: black; mso-fareast-language: PT-BR;">Detalhamento do preenchimento</span>**

</td><td style="border-top: 1pt solid windowtext; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-image: initial; border-left: none; background: rgb(221, 221, 221); padding: 0cm 3.5pt; width: 18.2613%; height: 23.7px;">**<span style="color: black; mso-fareast-language: PT-BR;">Obrigatório</span>**

</td></tr></thead><tbody><tr style="height: 40.5125px;"><td style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 19.1653%; height: 40.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">Paginação</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 62.5585%; height: 40.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">Quantidade de registros/regras a serem entregues por página. Limite máximo 100.</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; padding: 0cm 3.5pt; vertical-align: middle; width: 18.2613%; height: 40.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">Sim</span>

</td></tr><tr style="height: 25.7125px;"><td rowspan="3" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 19.1653%; height: 158.15px;"><span style="color: black; mso-fareast-language: PT-BR;">Ponteiro</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 62.5585%; height: 25.7125px;"><span style="color: black; mso-fareast-language: PT-BR;">Ponteiro do controle de atualização.</span>

</td><td rowspan="3" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; padding: 0cm 3.5pt; vertical-align: middle; width: 18.2613%; height: 158.15px;"><span style="color: black; mso-fareast-language: PT-BR;">Sim</span>

</td></tr><tr style="height: 41.5125px;"><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 62.5585%; height: 41.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">-Para carga inicial (recebimento de todas as regras), informar 0.</span>

</td></tr><tr style="height: 90.925px;"><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 62.5585%; height: 90.925px;"><span style="color: black; mso-fareast-language: PT-BR;">-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).</span>

</td></tr><tr style="height: 174.938px;"><td style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 19.1653%; height: 174.938px;"><span style="color: black; mso-fareast-language: PT-BR;">\*paramProxPag</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 62.5585%; height: 174.938px;"><span style="color: black; mso-fareast-language: PT-BR;">É 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. </span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; padding: 0cm 3.5pt; vertical-align: middle; width: 18.2613%; height: 174.938px;"><span style="color: black; mso-fareast-language: PT-BR;">Sim</span>

</td></tr></tbody></table>

<span style="color: rgb(251, 238, 184); background-color: rgb(251, 238, 184);">*<span style="text-decoration: underline;">\* Os dados apresentados nesta Tag estão parametrizados em base64.</span>*</span>

**Descrição dos campos de retorno**

<table border="0" cellpadding="0" cellspacing="0" class="MsoNormalTable" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 774px; border-collapse: collapse; height: 317.137px;"><tbody><tr style="height: 27.7125px;"><td nowrap="nowrap" style="border: 1pt solid windowtext; background: rgb(221, 221, 221); padding: 0cm 3.5pt; vertical-align: middle; width: 103.625px; height: 27.7125px;">**<span style="color: black; mso-fareast-language: PT-BR;">Campo</span>**

</td><td nowrap="nowrap" style="border-top: 1pt solid windowtext; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-image: initial; border-left: none; background: rgb(221, 221, 221); padding: 0cm 3.5pt; vertical-align: middle; width: 63.625px; height: 27.7125px;">**<span style="color: black; mso-fareast-language: PT-BR;">Pai</span>**

</td><td nowrap="nowrap" style="border-top: 1pt solid windowtext; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-image: initial; border-left: none; background: rgb(221, 221, 221); padding: 0cm 3.5pt; vertical-align: middle; width: 518.75px; height: 27.7125px;">**<span style="color: black; mso-fareast-language: PT-BR;">Descrição</span>**

</td></tr><tr style="height: 90.8px;"><td nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 103.625px; height: 90.8px;"><span style="color: black; mso-fareast-language: PT-BR;">Ponteiro</span>

</td><td nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 63.625px; height: 90.8px;"><span style="color: black; mso-fareast-language: PT-BR;">-</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 518.75px; height: 90.8px;"><span style="color: black; mso-fareast-language: PT-BR;">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.</span>

</td></tr><tr style="height: 21.6875px;"><td nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 103.625px; height: 21.6875px;"><span style="color: black; mso-fareast-language: PT-BR;">codStatus</span>

</td><td nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 63.625px; height: 21.6875px;"><span style="color: black; mso-fareast-language: PT-BR;">status</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 518.75px; height: 21.6875px;"><span style="color: black; mso-fareast-language: PT-BR;">Código de retorno</span>

</td></tr><tr style="height: 24.7px;"><td nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 103.625px; height: 24.7px;"><span style="color: black; mso-fareast-language: PT-BR;">msgStatus</span>

</td><td nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 63.625px; height: 24.7px;"><span style="color: black; mso-fareast-language: PT-BR;">status</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 518.75px; height: 24.7px;"><span style="color: black; mso-fareast-language: PT-BR;">Mensagem de retorno</span>

</td></tr><tr style="height: 106.725px;"><td nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 103.625px; height: 106.725px;"><span style="color: black; mso-fareast-language: PT-BR;">paramProxPag</span>

</td><td nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 63.625px; height: 106.725px;"><span style="color: black; mso-fareast-language: PT-BR;">-</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; padding: 0cm 3.5pt; vertical-align: middle; width: 518.75px; height: 106.725px;"><span style="color: black; mso-fareast-language: PT-BR;">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. </span>

</td></tr><tr style="height: 45.5125px;"><td nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 103.625px; height: 45.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">retorno tributário</span>

</td><td nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 63.625px; height: 45.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">-</span>

</td><td style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 518.75px; height: 45.5125px;"><span style="color: black; mso-fareast-language: PT-BR;">O detalhamento do retorno a partir deste campo consta no item "Informações da RT retornadas no Cockpit" deste manual.</span>

</td></tr></tbody></table>

**Mensagens de retorno**

<table border="0" cellpadding="0" cellspacing="0" class="MsoNormalTable" id="bkmrk-cod_status-msg_statu" style="border-collapse: collapse; width: 34.5238%; height: 146.432px;"><thead><tr style="height: 31.3068px;"><td class="align-left" nowrap="nowrap" style="border: 1pt solid windowtext; background: rgb(221, 221, 221); padding: 0cm 3.5pt; vertical-align: middle; width: 27.3119%; height: 31.3068px;">**<span style="color: black; mso-fareast-language: PT-BR;">cod\_status</span>**

</td><td class="align-left" nowrap="nowrap" style="border-top: 1pt solid windowtext; border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-image: initial; border-left: none; background: rgb(221, 221, 221); padding: 0cm 3.5pt; vertical-align: middle; width: 72.3845%; height: 31.3068px;">**<span style="color: black; mso-fareast-language: PT-BR;">msg\_status</span>**

</td></tr></thead><tbody><tr style="height: 19.7017px;"><td class="align-left" nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 27.3119%; height: 19.7017px;"><span style="color: black; mso-fareast-language: PT-BR;">200</span>

</td><td class="align-left" nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 72.3845%; height: 19.7017px;"><span style="color: black; mso-fareast-language: PT-BR;">Sucesso</span>

</td></tr><tr style="height: 31.3068px;"><td class="align-left" nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 27.3119%; height: 31.3068px;"><span style="color: black; mso-fareast-language: PT-BR;">401</span>

</td><td class="align-left" nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 72.3845%; height: 31.3068px;"><span style="color: black; mso-fareast-language: PT-BR;">Token ou Login/ Senha inválidos</span>

</td></tr><tr style="height: 19.7131px;"><td class="align-left" nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 27.3119%; height: 19.7131px;"><span style="color: black; mso-fareast-language: PT-BR;">500</span>

</td><td class="align-left" nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 72.3845%; height: 19.7131px;"><span style="color: black; mso-fareast-language: PT-BR;">Falha na aplicação</span>

</td></tr><tr style="height: 20.696px;"><td class="align-left" nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 27.3119%; height: 20.696px;"><span style="color: black; mso-fareast-language: PT-BR;">901</span>

</td><td class="align-left" nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 72.3845%; height: 20.696px;"><span style="color: black; mso-fareast-language: PT-BR;">Usuario sem cliente</span>

</td></tr><tr style="height: 23.7074px;"><td class="align-left" nowrap="nowrap" style="border-right: 1pt solid windowtext; border-bottom: 1pt solid windowtext; border-left: 1pt solid windowtext; border-image: initial; border-top: none; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 27.3119%; height: 23.7074px;"><span style="color: black; mso-fareast-language: PT-BR;">902</span>

</td><td class="align-left" nowrap="nowrap" style="border-top: none; border-left: none; border-bottom: 1pt solid windowtext; border-right: 1pt solid windowtext; background: white; padding: 0cm 3.5pt; vertical-align: middle; width: 72.3845%; height: 23.7074px;"><span style="color: black; mso-fareast-language: PT-BR;">Cliente sem connection string</span>

</td></tr></tbody></table>