Versões comparadas

Chave

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

...

Lembrando que, será a partir dos patches:

  • 12.1.2410.xxx
  • 12.1.2502.xxx
  • 12.1.2506 e superiores

03. SITUAÇÃO/REQUISITO

...

Parâmetro

Tipo

Obrigatório

Descrição

page

Numérico

Sim

Número da página a ser consultada (inicia em 1).

pageSizeNuméricoSimQuantidade de registros por página.
cnpjListStringSimCNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM



Nota
titleImportante:

O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no RM deve permitir esse acesso externo.

Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes.

Informações
titleImportanteAtenção:

Autenticação Basic: Enviar usuário e senha do RM no header da requisição.

...

Deck of Cards
startHiddenfalse
idretorno
Card
defaulttrue
id200ok
label200 - OK
titleSucesso
Propriedades APIDescrição
codCódigo do Sindicato - PSINDIC.CODIGO
descDescrição do Sindicato - PSINDIC.DESCRICAONOME
cnpjCNPJ da Coligada- PSINDICGCOLIGADA.CNPJCGC


Será retornado uma lista com os sindicatos referente ao CNPJ da filial coligada que foi enviado na requisição.

Bloco de código
languagecppjs
themeConfluence
titleOperação realizada com sucesso!
linenumberstrue
{
  "response": [
    {
      "errosresponse": [
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpjerros": "1A.23B.45C/678D-90"[
        },
        {
          "mensagem": "CNPJ não encontrado na base de dados",
          "cnpjmensagem": "1F05.CFB295.57C401/9FG40001-8930",
        },
        {
          "mensagemcnpj": "NãoNecessário existeativar cadastro de sindicatos para o CNPJ",
  a integração."
        "cnpj": "53.113.791/0012-85"
        },
      ],      
      "items": [
        {
          "cod": "00",
          "descmensagem": "SIND MEDIAS",
          "cnpj": "53.113.79107.363.764/0001-2290",
        },
        {
          "codcnpj": "01",
Coligada          "desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",não existe."
          "cnpj": "14.689.130/0001-98",
        },
        {
          "cod": "51",
          "desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
],
                "cnpjitems": "14.689.130/0001-98",[
        },
        {
          "cod": "52",
          "desccod": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
          "cnpj": "82.714.573/0001-41",
        },
        {
          "coddesc": "53SINDADOS",
          "desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "8207.714577.573599/0001-41",
        },
        {
          "cod": "01",
          "desc": "S001",70"
          "cnpj": "82.714.573/0001-41",
        }
      ],
      "hasNext": false
    }
  ]
}

Caso ultrapasse a paginação que é 500 items por página, será enviado o hasNext com true, para prosseguir com a requisição 

Bloco de código
languagecpp
themeConfluence
titleOperação realizada com sucesso!
{
  "response": [
    {
      "erros": [],
      "items": [
        {
          "cod": "000002",
          "desc": "SIND MEDIAS",
          "cnpjdesc": "53.113.791/0001-22"
        },
        {
          "cod": "01"SINDICATO COMERCIO",
          "desc": "SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",
          "cnpj": "1407.689577.130599/0001-9870",
        },
        {
          "cod": "51"},
          "desc": "SIND INTER EMP INST BEN RELIG FIL EST SP",
          "cnpj": "14.689.130/0001-98",
        },
		....
 {
          {
          "cod": "520003",
          "desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO",
          "cnpjdesc": "82.714.573/0001-41",
        },
        {
          "cod": "53",
  SINDICATO DOS ADMINISTRADORES DE EMPRESA",
        "desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",
          "cnpj": "8207.714577.573599/0001-4170",
        },
        {}
           "cod": "01",
          "desc": "S001",
 ],
             "cnpjhasNext": "82.714.573/0001-41",false
        }
      ],
      "hasNext": true
    }
  ]
}]
}



Informações
titleImportante:

Caso o número de itens ultrapasse o limite da página, o campo hasNext será retornado como true, indicando que há mais dados a serem requisitados.
O recomendável é solicitar 500 itens por página.

Card
id400bas
label400 - Solicitação inválida
titleBody

Verificar se todos os parâmetros foram passados na requisição

Bloco de código
languagecppjs
themeConfluence
linenumberstrue
{
    "code": "FE016",
    "message": "O campo CnpjList é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora