Histórico da Página

...

Painel

titleColor	Orange
title	Healthproducts - Retorna os planos de saúde disponíveis na operadora de saúde

Retorna os planos de saúde disponíveis na operadora de saúde

/totvsHealthPlans/attendanceNetwork/v1/healthProducts

GET

Nota

Expandir

title	Parameters

Authorization (header)	string	Cabeçalho usado para autorização das requisições (Bearer token)	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
healthInsurerCode (query)	string	Código da operadora (BAU_CODINT)	*required
portalProduct (query)	string	Define se irá retornar apenas produtos configurados para serem exibidos no portal, sendo: 0 - Não 1 - Sim
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

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizado com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de beneficiários retornados
items.productId	string	Código do produto saúde	BI3_CODIGO	*required
items.version	string	Versão do produto saúde	BI3_VERSAO	*required
items.description	string	Descrição do produto saúde	BI3_DESCRI	*required
items.coverage	string	Abrangência do produto saúde	BI3_ABRANG
items.susep	string	Número de registro Ans do produto saúde	BI3_SUSEP
items.segmentation	string	Segmentação do produto saúde	BI3_CODSEG
items.scpaCode	string	Código SCPA do produto saúde	BI3_SCPA

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "productId": "0001",
            "version": "001",
            "description": "PRODUTO EXEMPLO 1",
            "coverage": "01",
            "susep": "123456",
            "segmentation": "001",
            "scpaCode": ""
        },
        {
            "productid": "0002",
            "version": "001",
            "description": "PRODUTO INTERCAMBIO",
            "coverage": "01",
            "susep": "423423423",
            "segmentation": "001",
            "scpaCode": ""
        }
    ],
    "hasNext": true,
    "remainingRecords": 58
}

Aviso

Expandir

title	(406) - Parâmetros Obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "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."
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 29

Nova versão 30

Chave