Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
titleColorOrange
borderStylesolid
titleContracts - Retorna os contratos da empresa

Retorna os contratos da empresa informada (somente para empresa do tipo pessoa jurídica)

/totvsHealthPlans/familyContract/v1/companies/{companyCode}/contracts

GET

Nota
Expandir
titleParameters
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
health-insurer-code (query)stringCódigo da operadora no sistema (BT5_CODINT)*required
companyCode (path)stringCódigo da empresa no sistema (BT5_CODIGO)*required
login-user (query)stringFiltro de contratos pelo usuário de login do portal (BSW_LOGUSR)
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
Dica
Expandir
titleRequest

Body


Não possui body!


Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados

remainingRecordsintegerQuantidade de registros ainda existem para retorno

itemsarrayLista de contratos retornados

items.company-codestringCódigo da empresaBT5_CODIGO*required
items.contract-codestringNúmero do contratoBT5_NUMCON*required
items.contract-version-codestringVersão do contratoBT5_VERSAO*required
items.contract-datedateData do contratoBT5_DATCON*required
items.contract-typestringTipo do contratoBT5_TIPCON*required
items.description-contract-typestringDescrição do tipo do contratoBII_DESCRI*required
items.linksarray

links relacionados ao recurso contracts (Padrão HATEOAS):
rel: subcontracts


*required
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "items": [
        {
            "company-code": "1008",
            "contract-code": "000000000001",
            "contract-version-code": "001",
            "contract-date": "2021-02-12",
            "contract-type": "3",
            "description-contract-type": "COLETIVO EMPRESARIAL",
            "links": [
                {
                    "rel": "subcontracts",
                    "href": "/totvsHealthPlans/familyContract/v1/companies/1008/contracts/000000000001001/subcontracts?health-insurer-code=0001"
                }
            ]
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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.
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "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 companyCode obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave companyCode."
        },
        {
            "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."
        }
    ]
}

...

Aviso

...

Expandir

...

title(404) - Empresa não encontrada
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.
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Empresa não encontrada na operadora.",
    "detailedMessage": "Não foi encontrada na tabela BG9 a empresa de código 1098 (BG9_CODIGO)."
}


Âncora
subcontracts
subcontracts

Painel
titleColorOrange
borderStylesolid
titleSubcontracts - Retorna os subcontratos do contrato da empresa

Retorna os subcontratos do contrato informado da empresa (somente para empresa do tipo pessoa jurídica)

/totvsHealthPlans/familyContract/v1/companies/{companyCode}/contracts/{contractCode}/subcontracts

GET

Nota
Expandir
titleParameters
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
health-insurer-code (query)stringCódigo da operadora no sistema (BQC_CODIGO)*required
companyCode (path)stringCódigo da empresa no sistema (BQC_CODIGO)*required
contractCode (path)stringContrato da empresa (BQC_NUMCON+BQC_VERCON)*required
login-user (query)stringFiltro de subcontratos pelo usuário de login do portal (BSW_LOGUSR)
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
Dica
Expandir
titleRequest

Body


Não possui body!


Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornados

remainingRecordsintegerQuantidade de registros ainda existem para retorno

itemsarrayLista de subcontratos retornados

items.subcontract-codestringNumero do subcontratoBQC_SUBCON*required
items.subcontract-version-codestringVersão do subcontratoBQC_VERSUB*required
items.descriptionstringDescrição do subcontratoBQC_DESCRI*required
items.subcontract-datedateData do subcontratoBQC_DATCON*required
items.expiration-datedateData de validade do subcontratoBQC_VALID
Bloco de código
languagec#
theme
Painel
titleColorOrange
borderStylesolid
titleSubcontracts - Retorna os subcontratos do contrato da empresa

Retorna os subcontratos do contrato informado da empresa (somente para empresa do tipo pessoa jurídica)

/totvsHealthPlans/familyContract/v1/companies/{companyCode}/contracts/{contractCode}/subcontracts

GET

Body

Não possui body!

Nota
Expandir
titleParameters
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
health-insurer-code (query)stringCódigo da operadora no sistema (BQC_CODIGO)*required
companyCode (path)stringCódigo da empresa no sistema (BQC_CODIGO)*required
contractCode (path)stringContrato da empresa (BQC_NUMCON+BQC_VERCON)*required
login-user (query)stringFiltro de subcontratos pelo usuário de login do portal (BSW_LOGUSR)page (query)

string

Valor numérico (maior que zero) representando a página solicitadapageSize (query)

string

Valor numérico (maior que zero) representando o total de registros retornados na consultaorder (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
Dica
Expandir
titleRequest
Dica
Expandir
title(200) - Operação realizada com sucesso
hasNextbooleanIndica se ainda existem registros a serem retornadosremainingRecordsintegerQuantidade de registros ainda existem para retornoitemsarrayLista de subcontratos retornados
items.subcontract-codestringNumero do subcontratoBQC_SUBCON*required
items.subcontract-version-codestringVersão do subcontratoBQC_VERSUB*required
items.descriptionstringDescrição do subcontratoBQC_DESCRI*required
items.subcontract-datedateData do subcontratoBQC_DATCON*required
items.expiration-datedateData de validade do subcontratoBQC_VALID
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "items": [
        {
            "subcontract-code": "000000001",
            "subcontract-version-code": "001",
            "description": "SUBCONTRATO USO GERAL",
            "subcontract-date": "2021-02-12",
            "expiration-date": ""
        },
        {
            "subcontract-code": "000000002",
            "subcontract-version-code": "001",
            "description": "COBRANCA PATRONAL COMPARTILHADA",
            "subcontract-date": "2021-02-12",
            "expiration-date": ""
        }
    ],
    "hasNext": false,
    "remainingRecords": 0
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
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.
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "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 companyCode obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave companyCode."
        },
        {
            "code": "E001-406",
            "message": "Chave contractCode obrigatória",
            "detailedMessage": "Não foi informado no pathParams da requisição a chave contractCode."
        },
          },
        {
        {
            "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."
        }
    ]
}
Aviso
Expandir
title(404) - Empresa não encontrado
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.
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Empresa não encontrada na operadora.",
    "detailedMessage": "Não foi encontrada na tabela BG9 a empresa de código 1098 (BG9_CODIGO)."
}
Aviso
Expandir
title(404) - Contrato não encontrado
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.
Bloco de código
languagec#
themeMidnight
titleExemplo
linenumberstrue
{
    "code": "E001-406",
            "message": "Chave health-insurer-code obrigatória "E003",
    "message": "Contrato da empresa não encontrado.",
    "detailedMessage": "Não foi encontrado na informadotabela noBT5 queryParamso dacontrato requisiçãode acódigo chave health-insurer-code."
        }
    ]000000000003001 (BT5_NUMCON+BT5_VERSAO)."
}

03. TELA API COMPANIES

Outras Ações / Ações relacionadas

...