Árvore de páginas

Versões comparadas

Chave

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

...

04. USO DA API 


GET

Dados do pathparam da requisição:

Tipo

Descrição

CaracterMatrícula do Beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)


Dados do queryparam de envio:

Atributo

Tipo

Descrição

Obrigatoriedade

healthProviderCodeCaracterCódigo da RDAObrigatório
pageCaracter

Controle de número de paginas da aplicação

Opcional

pageSizeCaracter

Controle de quantidade de itens que serão retornados.

Opcional

expandCaracter

Indica os expandables que serão retornados no json.

Opcional

05. ATRIBUTOS DE RESPOSTA

Exemplo de chamada para validação:

http://localhost:8080/rest/totvshealthplans/v1/dentalTreatment/00010013000009012?healthProviderCode=000004&pageSize=5&page=1&expand=procedures,professional,cbos


GET - JSON de resposta - Sucesso


Expandir
titleSucesso 200 - Liberações Encontradas

{
    "items": [
        {
            "ansRegistry": "888888",
            "idOnHealthInsurer": "000120240800000030",
            "idOnHealthProvider": "000120240800000030",
            "journey": "9",
            "subscriberId": "00010013000009012",
            "primaryICD": "",
            "attendanceLocation": "008",
            "password": "10321822938239901599",
            "accidentIndication": "",
            "attendanceModel": "1",
            "attendanceProtocol": "88888820240805300031",
            "attendanceType": "1",
            "authorizationDate": "2024-08-05",
            "authorizationStatus": "1",
            "authorizationType": "9",
            "guideType": "13",
            "billingType": "1",
            "clinicalCondition": "",
            "closingReason": "",
            "consultationType": "1",
            "endTreatmentDate": "",
            "healthProviderId": "000004",
            "idAuthOnHealthProvider": "",
            "locationCode": "001",
            "mainAuthorizationCode": "",
            "newbornAttendance": false,
            "passwordExpireDate": "2298-05-20",
            "priorAuthorization": true,
            "priorAuthorizationStatus": "1",
            "professionalRequestorId": "A00599",
            "professionalExecutorId": "A00599",
            "requestDate": "2024-08-05",
            "attendanceToken": "",
            "missingValidationCode": "",
            "specialtyCode": "002",
            "specialCoverage": "",
            "attendanceScheme": "",
            "occupationalHealth": "",
            "attendanceNote": "Teste ",
            "professionalRequestorCouncil": "CRO",
            "professionalRequestorState": "SP",
            "professionalRequestorCouncilNumber": "654321",
            "professionalRequestorSpecialtyCode": "007",
            "professionalExecutorCouncil": "CRO",
            "professionalExecutorState": "SP",
            "professionalExecutorCouncilNumber": "654321",
            "dischargedType": "",
            "dischargedDate": "",
            "dischargedHour": "",
            "expectedHospitalizationDate": "",
            "expectedAdmissionDate": "",
            "hospitalizationDate": "",
            "hospitalizationHour": "",
            "hospType": "1",
            "hasClinicalAttachment": false,
            "hasTreatmentExtension": false,
            "hasInitialSituation": false,
            "professional": {
                "idOnHealthInsurer": "A00599",
                "phoneNumber": "",
                "professionalCouncil": "CRO",
                "professionalIdentifier": "",
                "professionalCouncilNumber": "654321",
                "name": "SOLANGE DA SILVA NOGUEIRA",
                "email": "",
                "stateAbbreviation": "SP",
                "cbos": {
                    "code": "201115",
                    "specialtyDescription": "Geneticista",
                    "specialtyCode": "002",
                    "description": "Geneticista"
                }
            },
            "professionalRequestor": {
                "idOnHealthInsurer": "A00599",
                "phoneNumber": "",
                "professionalCouncil": "CRO",
                "professionalIdentifier": "",
                "professionalCouncilNumber": "654321",
                "name": "SOLANGE DA SILVA NOGUEIRA",
                "email": "",
                "stateAbbreviation": "SP",
                "cbos": {
                    "code": "223208",
                    "specialtyDescription": "Cirurgiao dentista - clinico geral",
                    "specialtyCode": "007",
                    "description": "Cirurgiao dentista - clinico geral"
                }
            },
            "procedures": [
                {
                    "authLevel": "BR8",
                    "sequence": "001",
                    "status": 1,
                    "requestedQuantity": 6,
                    "authorizedQuantity": 6,
                    "authorized": "S",
                    "balance": 5,
                    "unitaryWorth": 0,
                    "executionDate": "2024-08-05",
                    "startingTime": "1339",
                    "endingTime": "1339",
                    "accessWay": "",
                    "usedTechnique": "",
                    "authLevelKey": "0181000065",
                    "auditing": "0",
                    "toothRegion": "11",
                    "surfaces": "",
                    "priorAuthorization": "1",
                    "priorAuthorizationStatus": "1",
                    "obsAudito": "Teste",
                    "medicalTeam": [
                        []
                    ],
                    "tableCode": "22",
                    "procedureCode": "81000065",
                    "procedureDescription": "CONSULTA ODONTOLOGICA INICIAL",
                    "procedureType": "0",
                    "rejectionCauses": []
                }
            ]
        }
    ],
    "hasNext": true
}


GET - JSON de resposta - Erro "Beneficiário não encontrado"

Image Added


Expandir
titleErro 400 - Beneficiário não encontrado

{
    "code": 400,
    "message": "Beneficiario informado nao encontrado",
    "detailedMessage": "Entre em contato com o Suporte"
}