Árvore de páginas

Versões comparadas

Chave

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

...

Bloco de código
languagec#
themeMidnight
titleAPI Retorno - Sucesso
linenumberstrue
collapsetrue
{
    "total": 266,
    "count": 2,
    "startindex": 1,
    "resources": [
        {
            "id": "PLAltBenModel",
            "operation": 1,
            "pk": "TSBTUCAgICAwMDAwMDE=",
            "models": [
                {
                    "id": "MASTERBBA",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "BBA_FILIAL",
                            "order": 1,
                            "value": "M SP"
                        },
                        {
                            "id": "BBA_CODSEQ",
                            "order": 2,
                            "value": "000001"
                        },
                        {
                            "id": "BBA_TIPSOL",
                            "order": 3,
                            "value": "2"
                        },
                        {
                            "id": "BBA_STATUS",
                            "order": 4,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CODINT",
                            "order": 5,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_CODEMP",
                            "order": 6,
                            "value": "1007"
                        },
                        {
                            "id": "BBA_CONEMP",
                            "order": 7,
                            "value": "000000000001"
                        },
                        {
                            "id": "BBA_VERCON",
                            "order": 8,
                            "value": "001"
                        },
                        {
                            "id": "BBA_SUBCON",
                            "order": 9,
                            "value": "000000001"
                        },
                        {
                            "id": "BBA_VERSUB",
                            "order": 10,
                            "value": "001"
                        },
                        {
                            "id": "BBA_MATRIC",
                            "order": 11,
                            "value": "00011007000001012"
                        },
                        {
                            "id": "BBA_CODPRO",
                            "order": 13,
                            "value": "0005"
                        },
                        {
                            "id": "BBA_DATSOL",
                            "order": 15,
                            "value": "20220222"
                        },
                        {
                            "id": "BBA_HORSOL",
                            "order": 16,
                            "value": "14:35"
                        },
                        {
                            "id": "BBA_NROPRO",
                            "order": 18,
                            "value": "41750520220222000001"
                        },
                        {
                            "id": "BBA_TIPMAN",
                            "order": 19,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CPFTIT",
                            "order": 20,
                            "value": "76461633090"
                        },
                        {
               				"id":"BBA_CODCLI",
               				"order":24,
               				"value":"000001"
            			},
            			{
             			  "id":"BBA_LOJA",
            			   "order":25,
			               "value":"01"
			            }
                     ]
                }
            ]
        },
        {
            "id": "PLAltBenModel",
            "operation": 1,
            "pk": "TSBTUCAgICAwMDAwMDM=",
            "models": [
                {
                    "id": "MASTERBBA",
                    "modeltype": "FIELDS",
                    "fields": [
                        {
                            "id": "BBA_FILIAL",
                            "order": 1,
                            "value": "M SP"
                        },
                        {
                            "id": "BBA_CODSEQ",
                            "order": 2,
                            "value": "000003"
                        },
                        {
                            "id": "BBA_TIPSOL",
                            "order": 3,
                            "value": "2"
                        },
                        {
                            "id": "BBA_STATUS",
                            "order": 4,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CODINT",
                            "order": 5,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_CODEMP",
                            "order": 6,
                            "value": "0022"
                        },
                        {
                            "id": "BBA_MATRIC",
                            "order": 11,
                            "value": "00010022000012012"
                        },
                        {
                            "id": "BBA_CODPRO",
                            "order": 13,
                            "value": "0001"
                        },
                        {
                            "id": "BBA_DATSOL",
                            "order": 15,
                            "value": "20220310"
                        },
                        {
                            "id": "BBA_HORSOL",
                            "order": 16,
                            "value": "08:46"
                        },
                        {
                            "id": "BBA_NROPRO",
                            "order": 18,
                            "value": "41750520220310000003"
                        },
                        {
                            "id": "BBA_TIPMAN",
                            "order": 19,
                            "value": "2"
                        },
                        {
                            "id": "BBA_CPFTIT",
                            "order": 20,
                            "value": "42655436423"
                        }
                    ]
                }
            ]
        }
    ]
}

...

Sim

Parâmetro (fields)

Obrigatório

Tipo

Descrição

BBA_CODINTSimCaracterCódigo da Operadora (BA0) do Beneficiário
BBA_CODEMPSimCaracterCódigo da Empresa (BG9) do Beneficiário
BBA_CONEMPNãoCaracterCódigo do Contrato (BT5) do Beneficiário, Obrigatório em Empresa Jurídica. 
BBA_VERCONNãoCaracterVersão do Contrato do Beneficiário, Obrigatório em Empresa Jurídica. 
BBA_SUBCONNãoCaracterCódigo do SubContrato (BQC) do Beneficiário, Obrigatório em Empresa Jurídica.
BBA_VERSUBNãoCaracterVersão do SubContrato do Beneficiário, Obrigatório em Empresa Jurídica.
BBA_EMPBENSimCaracterNome do Beneficiário Titular.
BBA_CODPROSimCaracterCódigo do Plano do Beneficiário Titular. 
BBA_VERSAOSimCaracterVersão do Plano do Beneficiário Titular
BBA_CPFTITSimCaracterCPF do Beneficiário Titular.
BBA_NROPRONãoCaracterNumero do Protocolo, caso não seja informado o sistema irá gerar automaticamente um numero.
BBA_MATRICNãoCaracterMatricula do titular ou responsável familiar, esse campo é utilizado quando for incluir um beneficiário em uma família já existente, caso seja uma nova família, o mesmo não deverá ser preenchido.
BBA_CODCLINãoCaracterCódigo referente ao registro do Cadastro de Cliente (SA1).
BBA_LOJANãoCaracterCódigo da loja referente ao registro do Cadastro de Cliente (SA1).

B2N_NOMUSRSimCaracterNome do Beneficiário
B2N_DATNASSimCaracterData de Nascimento do Beneficiário
B2N_GRAUPASimCaracterCódigo do Grau de parentesco (BRP)
B2N_ESTCIVSimCaracterCódigo do estado civil com base no SX5 tabela 33
B2N_SEXOSimCaracterSexo do Beneficiário, sendo 1 para Masculino e 2 para Feminino.
B2N_CPFUSRNãoCaracterCPF do Beneficiário, Sendo obrigatório para beneficiário titular (independentemente de idade) ou beneficiário dependente com idade igual ou superior a 18 anos.
B2N_DRGUSRNãoCaracterRG do Beneficiário.
B2N_ORGEMNãoCaracterOrg. Emissor.
B2N_RGESTNãoCaracterEstado Emissor.
B2N_NRCRNANãoCaracterNumero da Carteira nacional de saúde.
B2N_CEPUSRNãoCaracterCEP do Beneficiário (Tabela BC9).
B2N_ENDERENãoCaracterEndereço do Beneficiário.
B2N_NR_ENDNãoCaracterNumero do Endereço do Beneficiário.
B2N_COMENDNãoCaracterComplemento do Endereço do Beneficiário.
B2N_UNIVERNãoCaracterInforma se o Beneficiário é Universitário. Sendo 1 pra Sim e 0 pra Não.
B2N_BAIRRONãoCaracterBairro do Beneficiário
B2N_EMAILNãoCaracterE-mail do Beneficiário.
B2N_CODMUNNãoCaracterCódigo do Município (Tabela BID).
B2N_INVALINãoCaracterInvalidez?, sendo 1 pra sim e 0 pra não;
B2N_MUNICINãoCaracterDescrição do Município.
B2N_ESTADONãoCaracterEstado.
B2N_TELEFONãoCaracterTelefone do Beneficiário
B2N_DDDNãoCaracterDDD do Telefone.
B2N_MAENãoCaracterNome Mãe do Beneficiário (Será obrigatório caso se o campo BQC_INFANS esteja igual a "1 - Sim").
B2N_PAINãoCaracterNome do Pai do Beneficiário.
B2N_COMUNINãoCaracterPreferência de Comunicação: 0 para E-mail, 1 para SMS e 2 para Ambos 
B2N_BANCONãoCaracterCódigo do Banco (Tabela SA6).
B2N_AGENCNãoCaracterAgência correspondente ao Banco.
B2N_CONTANãoCaracterNumero da Conta correspondente a Agência.
B2N_DATADTNãoCaracterData de adoção do Beneficiário
B2N_CODPRONãoCaracterCodigo do Plano do Beneficiário, caso não seja informado o sistema irá utilizar o do títular (BBA_CODPRO).

DIRECTORYNãoCaracterDiretório http do arquivo para anexar ao protocolo de inclusão.
FILENAMENãoCaracterNome para ao arquivo.

Os demais parâmetros do json, segue o mesmo padrão para toda requisição de POST.

...