...
Bloco de código |
---|
theme | Midnight |
---|
title | Persons |
---|
linenumbers | true |
---|
|
{
"items": [
{
"personId": "BTS_MATVID (Varchar(8)) Example: 98765432",
"holderCPF": "BTS_CPFUSR (Varchar(14)) Example: 321654987",
"name": "BTS_NOMUSR (Varchar(70)) Example: Usuario de exemplo",
"birthdate": "BTS_DATNAS (Varchar(8)) Example: 19000101",
"gender": "BTS_SEXO (Varchar(1)) Example: F",
"nationalhealthcard": "BTS_NRCRNA (Varchar(15)) Example: 098765432109876",
"phonenumber": "BTS_TELEFO (Varchar(15)) Example: 5511987654321",
"zipcode": "BTS_CEPUSR (Varchar(8)) Example: 09876543",
"citycode": "BTS_CODMUN (Varchar(7)) Example: 3550308",
"email": "BTS_EMAIL (Varchar(60)) Example: [email protected]"
}
],
"healthInsurerId": "Example: 0001",
"ansRegistry": "Example: (321456)"
} |
Beneficiaries
API: Beneficiaries (Beneficiários - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de beneficiarios na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/beneficiaries
...
Bloco de código |
---|
theme | Midnight |
---|
title | Beneficiaries |
---|
linenumbers | true |
---|
|
{
"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",
"name": "BA1_NOMUSR (Varchar(8)) Example: 98765432 - Deve ser o mesmo código do campo personId da API Persons",
"birthdatename": "BA1_DATNASNOMUSR (Varchar(70)) Example: Usuario de exemplo",
"blockedDatebirthdate": "BA1_DATBLODATNAS (Varchar(8)) Example: 19000101",
"unblockDateblockedDate": "BA1_DESBLODATBLO (Varchar(8)) Example: 19000101",
"genderunblockDate": "BA1_SEXODESBLO (Varchar(8)) Example: 19000101",
"effectiveDategender": "BA1_DATINCSEXO (Varchar(1)) Example: F",
"healthInsuranceCodeeffectiveDate": "BA1_CODPLA",
DATINC (Varchar(8)) Example: 19000101",
"healthInsuranceVersionhealthInsuranceCode": "BA1_VERSAOCODPLA (Varchar(8)) Example: 098765",
"zipCodehealthInsuranceVersion": "BA1_CEPUSRVERSAO (Varchar(3)) Example: 098",
"cityCodezipCode": "BA1_CODMUNCEPUSR (Varchar(8)) Example: 09876543",
"waitingPeriodDatecityCode": "BA1_DATCARCODMUN (Varchar(7)) Example: 3550308",
"cardExpirationwaitingPeriodDate": "BA1_DTVLCRDATCAR (Varchar(8)) Example: 19000101",
"holderRelationshipcardExpiration": "BA1_TIPUSUDTVLCR (Varchar(8)) Example: 19000101",
"cardMagneticFieldholderRelationship": "BA1_TARCAR",
TIPUSU (Varchar(1)) Example: T - Indica se o usuário é Titular 'T' ou dependente 'D'",
"oldSubscriberIdcardMagneticField": "BA1_MATANTTARCAR (Varchar(254)) Example: 098765432109",
"habilitagrpcoboldSubscriberId": "BA1_INFGCB",
"habilitaclacar": "BA1_INFCOB"MATANT (Varchar(17)) Example: 00010002012345010",
"habilitagrpcob": "BA1_INFGCB (Varchar(1)) Example: Informa se utiliza grupo de cobertura '1' para sim / '2' para não",
"habilitaclacar": "BA1_INFCOB (Varchar(1)) Example: Informa se a cobrança é feita no nível do beneficiário '1' para sim / '2' para não"
}
],
"healthInsurerId": "BA0_CODIDE+BA0_CODINTExample: 0001",
"ansRegistry": "BA0_SUSEPExample: 321456"
} |
BeneficiaryStatus
API: beneficiaryStatus (Beneficiários - Bloqueio/Desbloqueio)
Funcionalidade: API utilizada para a bloqueio e desbloqueio de beneficiários na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/beneficiaryStatus
...
Bloco de código |
---|
theme | Midnight |
---|
title | beneficiaryStatus |
---|
linenumbers | true |
---|
|
{
"items": [
{
"eventDate": "Data do evento",
"eventType": "Tipo de evento(Bloqueio/Desbloqueio)",
"entry_hour": "Hora do registro",
"subscriberId": "Matricula do beneficiário",
"entry_date": "Data do registro"
}
],
"healthInsurerId": "BA0_CODIDE+BA0_CODINTExample: 0001",
"ansRegistry": "Example: "BA0_SUSEP321456"
} |
HealthProviders
API: healthProviders (Redes de Atendimento - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de redes de atendimento na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/healthProviders
...
Bloco de código |
---|
theme | Midnight |
---|
title | healthProviders |
---|
linenumbers | true |
---|
|
{
"items": [
{
"healthProviderCode": "BAU_CODIGO",
"healthProviderDocument": "BAU_CPFCGC",
"name": "BAU_NOME",
"reducedName": "BAU_NREDUZ",
"healthProviderType": "BAU_TIPPE",
"healthProviderClass": "BAU_TIPPRE",
"email": "BAU_EMAIL",
"cnesCode": "BAU_CNES"
}
],
"healthInsurerId": "BA0_CODIDE+BA0_CODINTExample: 0001",
"ansRegistry": "BA0_SUSEPExample: 321456"
} |
AttendanceLocations
API: attendanceLocations (Locais de atendimento - Inclusão/Alteração)
Funcionalidade: API utilizada para a inclusão e alteração de locais de atendimento na base de dados
Tipo de transação: POST
Endpoint: {apiversion}/attendanceLocations
...
Bloco de código |
---|
theme | Midnight |
---|
title | attendanceLocations |
---|
linenumbers | true |
---|
|
{
"items": [
{
"codint": "BB8_CODINT",
"healthProviderCode": "BB8_CODIGO",
"locationCode": "BB8_CODLOC",
"locationTypeCode": "BB8_LOCAL",
"locationDescription": "BB8_DESLOC",
"zipCode": "BB8_CEP",
"streetType": "BB8_TIPLOG",
"address": "BB8_END",
"addressNumber": "BB8_NR_END",
"addressComplement": "BB8_COMEND",
"cityCode": "BB8_CODMUN",
"cityName": "BB8_MUN",
"stateAbbreviation": "BB8_EST",
"district": "BB8_BAIRRO",
"phoneAreaCode": "BB8_DDD",
"phone": "BB8_TEL",
"contactName": "BB8_CONTAT",
"cnesCode": "BB8_CNES",
"region": "BB8_REGMUN"
}
],
"healthInsurerId": "BA0_CODIDE+BA0_CODINTExample: 0001",
"ansRegistry": "BA0_SUSEPExample: 321456"
} |
HealthProviderSpecialties
...
Bloco de código |
---|
title | HealthProviderSpecialties |
---|
linenumbers | true |
---|
|
{
"items": [
{
"codint": "BAX_CODINT",
"healthProviderCode": "BAX_CODIGO",
"specialtyCode": "BAX_CODESP",
"subspecialtyCode": "BAX_CODSUB",
"locationCode": "BAX_CODLOC",
"blockDate": "BAX_DATBLO",
"considerSpecialty": "BAX_CONESP",
"allowsMaterial": "BAX_LIMATM",
"searchOrder": "BAX_ORDPES"
}
],
"healthInsurerId": "BA0_CODIDE+BA0_CODINTExample: 0001",
"ansRegistry": "BA0_SUSEPExample: 321456"
} |