Árvore de páginas

Versões comparadas

Chave

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

...

Painel
titleColorOrange
borderStylesolid
titleCompanies - Retorna o cadastro de empresas

Retorna as empresas cadastradas da operadora informada.

/totvsHealthPlans/familyContract/v1/companies

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 (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
Dica
Expandir
titleRequest

Body


Não possui body!


Bloco de código
languagec#
themeRDark
titleExemplo (TL++)
linenumberstrue
local cUrl := "{{host}}/api/totvsHealthPlans/familyContract/v1" as character
local oRestClient := FWRest():new(cUrl) as object
local aHearder := {} as array
local cBody := "" as character

aAdd(aHeader, "Content-Type: application/json; charset=UTF-8")
aAdd(aHeader, "Accept: application/json")
aAdd(aHeader, "User-Agent: Chrome/65.0 (compatible; Protheus "+getBuild()+")")

oRestClient:setPath("/companies")

if oRestClient:Get(aHeader)
  ConOut("GET", oRestClient:GetResult())
else
  ConOut("GET", oRestClient:GetLastError())
endif
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 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).



Bloco de código
languagec#
themeRDark
titleExemplo
linenumberstrue
{
    "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
}
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#
themeRDark
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 health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

...