CONTEÚDO
- Visão Geral
- Exemplo de utilização
- API companies - v1.000
- contracts
- subcontracts
- Tela api companies
- Outras Ações / Ações relacionadas
- Tela api companies
- Principais Campos e Parâmetros
- 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
| Painel |
|---|
| titleColor | Orange |
|---|
| borderStyle | solid |
|---|
| title | Retorna o Cadastro de Empresas |
|---|
|
Retorna as empresas cadastradas da operadora informada. | /totvsHealthPlans/familyContract/v1/companies | |
| Expandir |
|---|
|
| Authorization (header) | | Cabeçalho usado para autorização das requisições | *required | Content-Type (header) | | '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) | | Valor numérico (maior que zero) representando a página solicitada |
| | pageSize (query) | | Valor numérico (maior que zero) representando o total de registros retornados na consulta |
| | order (query) | | Lista de campos para ordenação, separada por virgula (,). |
| | fields (query) | | Lista com o nome das propriedades JSON que serão retornadas. |
| | filter (query) | | Filtros seguindo o padrão ODATA |
|
|
| Expandir |
|---|
| 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):
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",
"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."
}
]
} |
|
|
03. TELA API COMPANIES
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|
| Não se aplica | Não se aplica |
04. TELA API COMPANIES
Principais Campos e Parâmetros
05. TABELAS UTILIZADAS
- Empresas (BG9)
- Usuário Portal x Empresa (B40)
- Usuarios do Portal (BSW)
