v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Tipos de Arquivos

Retorna os tipos de arquivos disponíveis

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

A API retornará através do método GET os tipos de arquivos que poderão ser inseridos nos arquivos da reserva, dentre eles tipo_pessoa que retornará FISICA, JURIDICA ou AMBOS, quando este documento tiver relação com os dois tipos de pessoa. Também retornará a funcionalidade que este arquivo está ligado Reservas (RESERVAS), pré-cadastro (PRE_CADASTRO), AMBOS, quando o tipo de arquivo possuir ligação para as duas funcionalidades, e o exibir_painel_cliente, quando o tipo de arquivo for visível ao painel do cliente.

get/v1/configuracoes/tipos-arquivos

Query parameters

paginainteger

Example:1

Número da página que retorna os tipos de arquivos

registros_por_paginainteger

Example:100

Quantidade de registros por página que retorna tipos de arquivos

funcionalidadestring

Example:reservas/pre_cadastro

Filtra por tipo de funcionalidade

obrigatoriostring

Example:S/N

Filtra por obrigatório

exibir_painel_clientestring

Example:S

Filtra por tipos de arquivos exibidos no painel do cliente

Headers

emailstring required

Example:email@email.com

E-mail de autenticação para retornar tipos de arquivos

tokenstring required

Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Token de autenticação para retornar tipos de arquivos

Response

Tipos de Arquivos da Reserva

paginainteger

total_de_paginasinteger

registrosinteger

total_de_registrosinteger

Example response

{
  "pagina": 1,
  "total_de_paginas": 36,
  "registros": 30,
  "total_de_registros": 1054,
  "dados": [
    {
      "tipos": [
        {
          "idtipo": 1,
          "nome": "Procurador",
          "tipo_pessoa": "FISICA",
          "funcionalidade": "reservas",
          "obrigatorio": "S",
          "visivel": "S",
          "assinatura_digital": "S",
          "contrato": "S",
          "exibir_gestao_contrato": "S",
          "exibir_painel_cliente": "S"
        }
      ]
    }
  ]
}