Árvore de páginas

Versões comparadas

Chave

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

...

  1. Visão Geral
  2. Exemplo de utilização
    1. HealthProducts- Retorna os planos de saúde da operadora de saúde
    2. HealthProductsBeneficiary - Retorna o plano de saúde do beneficiário logado
    3. Specialties - Retorna as especialidades disponíveis da operadora de saúde
    4. ReferencedNetworks - Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada
  3. Tela API rede de AtendimentoRede Credenciada
    1. Outras Ações / Ações relacionadas
  4. Tela API rede de AtendimentoRede Credenciada
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas

...

Painel
titleColorOrange
titleReferencedNetworks - Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada

Retorna as redes credenciadas disponíveis para atendimento de acordo com o plano de saúde e especialidade informada

/totvsHealthPlans/attendanceNetwork/v1/healthProducts/:healthProductshealthProducId/specialties/:specialtieCode/referencedNetworks

      GET      
Nota
Expandir
titleParameters
Authorization (header)stringCabeçalho usado para autorização das requisições (Bearer token)*required
Content-Type (header)string'application/json' é o formato do conteúdo*required
healthProduct healthProducId (Path)stringProduto Saúde (BI3_CODINT + BI3_CODIGO + BI3_VERSAO)*required
specialtieCode(Path)stringEspecialidade disponível no produto saúde*required
healthInsurerCode (query)stringCódigo da operadora do produto Saúde (BI3_CODINT)*required
zipCode (query)stringFiltro por CEP (Caso informado o mesmo, não será considerado stateAbbreviation e cityCode caso informado)
stateAbbreviation (query)string

Filtro por Estado

Exemplo: SP


cityCode (query)string

Filtro pelo Código da Cidade

Exemplo: 3550308 (São Paulo)


page (query)string

Valor numérico (maior que zero) representando a página solicitada


pageSize (query)string

Valor numérico (maior que zero) representando o total de registros retornados na consulta


Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizado com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados
*required
remainingRecordsnumeric (integer)Quantidade de registros ainda existem para retorno
*required
itemsarrayLista de beneficiários retornados

items.codeIdstringCódigo de cadastro do prestador
*required
items.providerNamestringNome do prestador
*required
items.localDescriptionstringDescrição do prestador
*required
items.zipCodestringCEP do prestador
*required
items.addressNumberstringNúmero do endereço do prestador
*required
items.cityCodestringCódigo da cidade do prestador
*required
items.citystringCidade do prestador
*required
items.statestringEstado do prestador
*required
items.districtstringBairro do prestador
*required
items.DDDstringCódigo de área do telefone do prestador

items.telephonestringTelefone do prestador

items.CNESstringCNES do prestador

Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "items": [
        {
            "codeId": "000004",
            "providerName": "HOSPITAL BOM CLIMA",
            "localDescription": "HOSPITAIS",
            "zipCode": "07197000",
            "address": "MARIANA UBALDINA DO ESPÍRITO SANTO",
            "addressNumber": "654",
            "cityCode": "3518800",
            "city": "GUARULHOS",
            "state": "SP",
            "district": "BOM CLIMA",
            "DDD": "",
            "telephone": "",
            "CNES": ""
        },
        {
            "codeId": "000011",
            "providerName": "UNIMED SUL CAPIXABA",
            "localDescription": "OPERADORAS",
            "zipCode": "07197000",
            "address": "MARIANA UBALDINA DO ESPÍRITO SANTO",
            "addressNumber": "100",
            "cityCode": "3518800",
            "city": "GUARULHOS",
            "state": "SP",
            "district": "BOM CLIMA",
            "DDD": "",
            "telephone": "",
            "CNES": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 26
}
Aviso
Expandir
title(406) - Parâmetros Obrigatórios
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo 1
linenumberstrue
{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave healthInsurerCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave healthInsurerCode."
        }
    ]
}
Bloco de código
languagec#
themeEmacs
titleExemplo 2
linenumberstrue
{
    "code": "E002",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo healthProduct",
            "detailedMessage": "O valor do campo healthProduct deve ter o tamanho 7."
        },
        {
            "code": "E002E-406",
            "message": "Tamanho inválido para o campo specialtieCode",
            "detailedMessage": "O valor do campo specialtieCode deve ter o tamanho 3."
        }
    ]
}

...