Árvore de páginas

Versões comparadas

Chave

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

...

Authorization: Token de autorização para comunicar com a API
idTenant: Id do tenant da operadora
tenantName: Nome do tenant da operadora


Propriedades:

PropriedadeDescriçãoTamanhoTipoFormato
subscriberIdMatricula do beneficiário15Caractere012345678901234
contractNumber
contractVersion
Contrato do beneficiário
subContractNumber
12
subContractVersion
Caractere
holderCpf
098765432109
personId
contractVersion
name
Versão do contrato
birthdate
3
blockedDate
Caractere
unblockDate
098
gender
subContractNumber
effectiveDate
Subcontrato do beneficiário
healthInsuranceCode
9
healthInsuranceVersion
Caractere
zipCode
098765432
cityCode
subContractVersion
waitingPeriodDate
Versão do subcontrato
cardExpiration
3
holderRelationship
Caractere
cardMagneticField
098
oldSubscriberId
holderCpf
habilitagrpcob
CPF do beneficiário
habilitaclacar
11

...

Caractere

...

098765432
personIdCódigo da vida do beneficiário.
Deve ser o mesmo código do campo personId da API Persons
8Caractere98765432
nameNome do beneficiário70Caractere
birthdateData de nascimento do beneficiário8Caractereaaaammdd
blockedDateData de bloqueio do beneficiário8Caractereaaaammdd
unblockDateData de desbloqueio do beneficiário8Caractereaaaammdd
genderGênero do beneficiário1Caractere

1 - Masculino

2 - Feminino

effectiveDateData de inclusão do beneficiário8Caractereaaaammdd
healthInsuranceCodeCódigo do plano do beneficiário8Caractere09876543
healthInsuranceVersionVersão do plano do beneficiário3Caractere098
zipCodeCEP do beneficiário8Caractere09876543
cityCodeCódigo da cidade no IBGE7
0987654
waitingPeriodDateData de carência8Caractereaaaammdd
cardExpirationData de validade da carteirinha do beneficiário8Caractereaaaammdd
holderRelationshipRelacionamento do beneficiário com o titular do contrato1CaractereT - Titular
D - Dependente
cardMagneticFieldValor da tarja magnética do cartão254Caractere098765432109
oldSubscriberIdMatricula antiga do beneficiário17Caractere09876543210987654
habilitagrpcobIndica se considera grupo de cobertura no nível do beneficiário1Caractere0 - Não
1 - Sim
habilitaclacarIndica se habilita classe de carência para o beneficiário1Caractere0 - Não
1 - Sim


Body:

Bloco de código
themeMidnight
titleBeneficiaries
linenumberstrue
{
    "items": [
themeMidnight
titleBeneficiaries
linenumberstrue
{
    "items": [
        {
            "subscriberId": "BA1_CODINT + BA1_CODEMP + BA1_MATRIC + BA1_TIPREG + BA1_DIGITO (Varchar(15)) Example: 00010002012345010",
            "contractNumber": "BA1_CONEMP (Varchar(12)) Example: 098765432109",
            "contractVersion": "BA1_VERCON (Varchar(3)) Example: 098",
            "subContractNumber": "BA1_SUBCON (Varchar(9)) Example: 098765432",
            "subContractVersion": "BA1_VERSUB (Varchar(3)) Example: 098",
            "holderCpf": "BA1_CPFUSR (Varchar(11)) Example: 098765432",
            "personId": "BA1_MATVID (Varchar(8)) Example: 98765432 - Deve ser o mesmo código do campo personId da API Persons{
            "subscriberId": "00010002012345010",
            "namecontractNumber": "BA1_NOMUSR (Varchar(70)) Example: Usuario de exemplo098765432109",
            "birthdatecontractVersion": "BA1_DATNAS (Varchar(8)) Example: 19000101098",
            "blockedDate": "BA1_DATBLO (Varchar(8)) Example: 19000101subContractNumber": "098765432",
            "unblockDatesubContractVersion": "BA1_DESBLO (Varchar(8)) Example: 19000101098",
            "genderholderCpf": "BA1_SEXO (Varchar(1)) Example: F098765432",
            "effectiveDatepersonId": "BA1_DATINC (Varchar(8)) Example: 19000101"98765432",
            "name": "Usuario de exemplo",
            "healthInsuranceCodebirthdate": "BA1_CODPLA (Varchar(8)) Example: 09876519000101",
            "healthInsuranceVersionblockedDate": "BA1_VERSAO (Varchar(3)) Example: 09819000101",
            "zipCodeunblockDate": "BA1_CEPUSR (Varchar(8)) Example: 0987654319000101",
            "cityCodegender": "BA1_CODMUN (Varchar(7)) Example: 3550308F",
            "waitingPeriodDateeffectiveDate": "BA1_DATCAR (Varchar(8)) Example: 19000101",
            "cardExpirationhealthInsuranceCode": "BA1_DTVLCR (Varchar(8)) Example: 19000101"098765",
            "healthInsuranceVersion": "098",
            "holderRelationshipzipCode": "BA1_TIPUSU (Varchar(1)) Example: T - Indica se o usuário é Titular 'T' ou dependente 'D'"09876543",
            "cityCode": "3550308",
            "cardMagneticFieldwaitingPeriodDate": "BA1_TARCAR (Varchar(254)) Example: 098765432109"19000101",
            "cardExpiration": "19000101",
            "oldSubscriberIdholderRelationship": "BA1_MATANT (Varchar(17)) Example: 00010002012345010T",
            "habilitagrpcobcardMagneticField": "BA1_INFGCB (Varchar(1)) Example: Informa se utiliza grupo de cobertura '1' para sim / '2' para não"098765432109",
            "oldSubscriberId": "00010002012345010",
            "habilitaclacarhabilitagrpcob": "BA1_INFCOB (Varchar(1)) Example: Informa se a cobrança é feita no nível do beneficiário '1' para sim / '2' para não"0",
            "habilitaclacar": "0"
        }
    ],
    "healthInsurerId": "Example: 0001",
    "ansRegistry": "Example: 321456"
}


BeneficiaryStatus

...