Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Companies - Retorna o cadastro de empresas

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

GET

Nota

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	Código da operadora no sistema (BG9_CODINT)	*required
login-user (query)	string	Filtro de empresas pelo usuário de login do portal (BSW_LOGUSR)
group-type (query)	string	Filtro de empresas pelo tipo de grupo (BG9_TIPO): 1=Pessoa Física e 2=Pessoa Jurídica
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
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Body

Não possui body!

Expandir

title	Request

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	Código da operadora no sistema (BG9_CODINT)	*required
login-user (query)	string	Filtro de empresas pelo usuário de login do portal (BSW_LOGUSR)
group-type (query)	string	Filtro de empresas pelo tipo de grupo (BG9_TIPO): 1=Pessoa Física e 2=Pessoa Jurídica
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
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Expandir

title	Request

Body

Não possui body!

Dica

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): rel: contracts (somente para pessoa jurídica).

Bloco de código

language	c#
theme	Midnight
title	Exemplo
linenumbers	true

{
    "items": [

Dica

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):
rel: contracts (somente para pessoa jurídica).

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": "00020001",
            "description": "CONTRATOS PESSOA JURIDICAFISICA",
            "group-type": "21",
            "use": "1",
        },
    "links": [    {
            "company-code": "0002",
     {
       "description": "CONTRATOS PESSOA JURIDICA",
            "relgroup-type": "contracts2",
            "use": "1",
            "hreflinks": "/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-code=0001"
[
                }{
             ]
        }"rel": "contracts",
    ],
           "hasNext": false,
    "remainingRecordshref": 0
}"/totvsHealthPlans/familyContract/v1/companies/0002/contracts?health-insurer-code=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}

Expandir

title	(200) - Operação realizada

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): rel: contracts (somente para pessoa jurídica).

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

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.

Bloco de código

language	c#
theme	Midnight
title	Exemplo
linenumbers	true

{
    "code": "E001",

"group-type

"message": "

2",

Existem chaves obrigatórias que não

"use": "1",

foram informadas.",
    "

links": [

detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details":

{

[
        {
            "

rel

code": "

contracts

E001-406",

href

message": "

/totvsHealthPlans/familyContract/v1/companies/0002/contracts?

Chave health-insurer-code

=0001

 obrigatória",
            "detailedMessage": "Não foi informado

}

no queryParams da requisição a

]

chave health-insurer-code."
        }
    ]

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

...

Árvore de páginas

Versões comparadas

Versão antiga 47

Nova versão 48

Chave