CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. API companies - v1.000
    2. contracts
    3. subcontracts
  3. Tela api companies
    1. Outras Ações / Ações relacionadas
  4. Tela api companies
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade companies (Empresas) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs

02. EXEMPLO DE UTILIZAÇÃO

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

GET


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)stringCódigo da operadora no sistema (BG9_CODINT)*required
login-user (query)stringFiltro de empresas pelo usuário de login do portal (BSW_LOGUSR)
group-type (query)stringFiltro 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!


hasNextbooleanIndica se ainda existem registros a serem retornados

remainingRecordsintegerQuantidade de registros ainda existem para retorno

itemsarrayLista de empresas retornadas

items.company-codestringCódigoBG9_CODIGO*required
items.descriptionstringDescriçãoBG9_DESCRI*required
items.group-typestringTipo de grupo (Pessoa física ou jurídica)BG9_TIPO*required
items.usestringUsoBG9_USO*required
items.linksarray

links relacionados ao recurso companies (Padrão HATEOAS):
rel: contracts (somente para pessoa jurídica).



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



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

03. TELA API COMPANIES

Outras Ações / Ações relacionadas

AçãoDescrição
Não se aplicaNão se aplica

04. TELA API COMPANIES

Principais Campos e Parâmetros

CampoDescrição
Inclua o campo Inclua a descrição relacionada

05. TABELAS UTILIZADAS