Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 13

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

comparado com

Nova versão 14

changes.mady.by.user Vinicius Queiros Teixeira

Gravado em

Chave

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

...

/totvsHealthPlans/familyContract/v1/companies

GET



Expandir
titlePARAMETERS
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)stringPaginação da Coleção*required
login-user (query)stringPaginação da Coleção
group-type (query)stringPaginação da Coleção
page (query)

string

Paginação da Coleção
pageSize (query)

string

Quantidade de Itens por Página
order (query)

string

Ordenação da Coleção
fields (query)

string

Filtro de campos dos registros
filter (query)

string

Indica o filtro querystring recebido (pode se utilizar um filtro oData)



Expandir
titleREQUEST

Body

Não possui body!


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



Expandir
title(406) - PARÂMETROS OBRIGATÓRIOS


...