Histórico da Página

...

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).
pageSize	Numérico	Sim	Quantidade de registros por página.
cnpjList	String	Sim	CNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM

Nota

title	Importante:

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

title	ImportanteAtenção:

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

Retorno

Deck of Cards

startHidden	false
id	retorno

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API	Descrição
cod	Código do Sindicato -

RCE_

PSINDIC.CODIGO
desc	Descrição do Sindicato -

RCE_DESCRI

PSINDIC.NOME
cnpj	CNPJ da

filial

Coligada-

M0_

GCOLIGADA.CGC

Será retornado uma lista com os sindicatos referente ao CNPJ da

filial cpp

coligada que foi enviado na requisição.

Bloco de código

language

js
theme	Confluence
title	Operação realizada com sucesso!


linenumbers	true

{ "response": [ {

erros

response": [
        {

"mensagem":

"CNPJ

não

encontrado na base de dados", "cnpj": "1A.23B.45C/678D-90"

"erros": [

},

"mensagem":

"CNPJ

não

encontrado

na

base

de

dados",

cnpj

mensagem": "

1F

05.

CFB

295.

57C

401/

9FG4

0001-

89

30",

},

{

"mensagem

"cnpj": "

Não

Necessário

existe

ativar

cadastro de sindicatos para o CNPJ",

a integração."

"cnpj":

"53.113.791/0012-85"

},

],

"items":

[

"cod":

"00",

desc

mensagem": "

SIND MEDIAS", "cnpj": "53.113.791

07.363.764/0001-

22

90",

},

{

cod

cnpj": "

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", "cnpj": "14.689.130/0001-98",

"items": [

},

"cod":

"52",

desc": "SIND EMP TURE HOSP PIRACICABA E REGIAO", "cnpj"

cod": "

82.714.573/

-41

",

},

{

cod

desc": "

53

SINDADOS",

"desc": "SIND EMP ESTAB SERVICOS SAUDE-SAO PAULO",

          "cnpj": "

82

07.

714

577.

573

599/0001-

41

70"

,

},

{

"cod": "01", "desc": "S001", "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

language	cpp
theme	Confluence
title	Operação realizada com sucesso!

{

"response":

[

"erros": [],

"items":

[

{

          "cod": "

00

0002",

"desc":

"SIND

MEDIAS",

cnpj

desc": "

53.113.791/0001-22" }, { "cod": "01"

SINDICATO COMERCIO",

"desc":

"SIND.EMPRE.INST.BENEF.REL.FILANTROPICOS",

         "cnpj": "

14

07.

689

577.

130

599/0001-

98

70"

,

},

{ "cod": "51"

},

"desc":

"SIND

INTER

EMP

INST

BEN RELIG FIL EST SP", "cnpj": "14.689.130/0001-98", }, ....

{

          "cod": "

52

0003",

"desc":

"SIND

EMP

TURE

HOSP

PIRACICABA

E

REGIAO",

"cnpj

"desc": "

82.714.573/0001-41", }, { "cod": "53",

SINDICATO DOS ADMINISTRADORES DE EMPRESA",

"desc":

"SIND EMP

ESTAB

SERVICOS

SAUDE-SAO

PAULO",

          "cnpj": "

82

07.

714

577.

573

599/0001-

41

70"

,

},

{

"cod": "01", "desc": "S001",

  ],
            "

cnpj

hasNext":

"82.714.573/0001-41",

false
        }

], "hasNext": true } ] }

]
}

Informações

title	Importante:

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.

cpp

Card

id	400bas
label	400 - Solicitação inválida
title	Body

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

Bloco de código

language

js
theme	Confluence
linenumbers	true

{
    "code":

400

"FE016",
    "message": "O campo CnpjList

"Necessário enviar o page, pageSize e cnpjList na requisição""

é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

03. SITUAÇÃO/REQUISITO

05. DEMAIS INFORMAÇÕES

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

03. SITUAÇÃO/REQUISITO

05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora