Histórico da Página

...

Painel

Retorna o Cadastro de Empresas

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

GET

Expandir

title	PARAMETERS

Authorization (header)	string	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	string	'application/json' é o formato do conteúdo	*required
health-insurer-code (query)	string	Paginação da Coleção	*required
login-user (query)	string	Paginação da Coleção
group-type (query)	string	Paginação da Coleção
page (query)	string	Paginação da Coleção
pageSize (query)	string	Quantidade de Itens por Página
order (query)	string	Ordenação da Coleção
fields (query)	string	Filtro de campos dos registros
filter (query)	string	Indica o filtro querystring recebido (pode se utilizar um filtro oData)

Expandir

title	REQUEST

Body

Não possui body!

Expandir

title	(200) - OPERAÇÃO REALIZADA COM SUCESSO

hasNext	boolean	Indica se ainda existem registros a serem retornados
remainingRecords	integer	Quantidade de registros ainda existem para retorno
items	array	Lista de empresas retornadas
items.company-code	string	Código	BG9_CODIGO	*required
items.description	string	Descrição	BG9_DESCRI	*required
items.group-type	string	Tipo de grupo (Pessoa física ou jurídica)	BG9_TIPO	*required
items.use	string	Uso	BG9_USO	*required
items.links	array	links relacionados ao recurso companies (Padrão HATEOAS)

Bloco de código

language	c#
theme	Midnight
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "company-code": "0001",
            "description": "CONTRATOS PESSOA FISICA",
            "group-type": "1",
            "use": "1"
        },
        {
            "company-code": "0002",
            "description": "CONTRATOS PESSOA JURIDICA",
            "group-type": "2",
            "use": "1",
            "links": [
                {
                    "rel": "contracts",
                    "href": "/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-code=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

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.

Bloco de código

language	c#
theme	Midnight
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 health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

Retorna o Cadastro de Empresas

...

Árvore de páginas

Versões comparadas

Versão antiga 20

Nova versão 21

Chave

Retorna o Cadastro de Empresas

Retorna o Cadastro de Empresas