Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Contracts - 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

title	Parameters

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)	string	Código da operadora no sistema (BT5_CODINT)	*required
companyCode (path)	string	Código da empresa no sistema (BT5_CODIGO)	*required
login-user (query)	string	Filtro 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

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 contratos retornados
items.company-code	string	Código da empresa	BT5_CODIGO	*required
items.contract-code	string	Número do contrato	BT5_NUMCON	*required
items.contract-version-code	string	Versão do contrato	BT5_VERSAO	*required
items.contract-date	date	Data do contrato	BT5_DATCON	*required
items.contract-type	string	Tipo do contrato	BT5_TIPCON	*required
items.description-contract-type	string	Descrição do tipo do contrato	BII_DESCRI	*required
items.links	array	links relacionados ao recurso contracts (Padrão HATEOAS): rel: subcontracts		*required

Bloco de código

language	c#
theme	Midnight
title	Exemplo
linenumbers	true

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

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 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

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": "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

titleColor	Orange
borderStyle	solid
title	Subcontracts - 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

title	Parameters

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)	string	Código da operadora no sistema (BQC_CODIGO)	*required
companyCode (path)	string	Código da empresa no sistema (BQC_CODIGO)	*required
contractCode (path)	string	Contrato da empresa (BQC_NUMCON+BQC_VERCON)	*required
login-user (query)	string	Filtro 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

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 subcontratos retornados
items.subcontract-code	string	Numero do subcontrato	BQC_SUBCON	*required
items.subcontract-version-code	string	Versão do subcontrato	BQC_VERSUB	*required
items.description	string	Descrição do subcontrato	BQC_DESCRI	*required
items.subcontract-date	date	Data do subcontrato	BQC_DATCON	*required
items.expiration-date	date	Data de validade do subcontrato	BQC_VALID

Bloco de código

theme
language	c#

Painel

titleColor	Orange
borderStyle	solid
title	Subcontracts - 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

title	Parameters

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)

string

Código da operadora no sistema (BQC_CODIGO)

*required

companyCode (path)

string

Código da empresa no sistema (BQC_CODIGO)

*required

contractCode (path)

string

Contrato da empresa (BQC_NUMCON+BQC_VERCON)

*required

login-user (query)

string

Filtro 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

title	Request

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 subcontratos retornados

items.subcontract-code

string

Numero do subcontrato

BQC_SUBCON

*required

items.subcontract-version-code

string

Versão do subcontrato

BQC_VERSUB

*required

items.description

string

Descrição do subcontrato

BQC_DESCRI

*required

items.subcontract-date

date

Data do subcontrato

BQC_DATCON

*required

items.expiration-date

date

Data de validade do subcontrato

BQC_VALID

Bloco de código

language	c#
theme	Midnight
title	Exemplo
linenumbers	true

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

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 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

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": "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

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-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

...

Árvore de páginas

Versões comparadas

Versão antiga 60

Nova versão 61

Chave

03. TELA API COMPANIES