Skip to main content

Cadastro de contratol de plano

Adiciona registro de credenciadocontrato de plano na garagem. O registro de credenciado, para ser efetivado, depende dos parâmetros “código da mensalidade”, “código do vencimento”, “códigos dos pátios habilitados” e “grupo”, que não estão presentes nesse serviço, portanto, não são passados na requisição. Esses parâmetros são definidos dentro da plataforma i e seus valores são utilizados para todos os credenciados cadastrados através desse serviço.

POST api/integradores/credenciadosplanos_contratos

HEADERS

CHAVE
VALOR
DESCRIÇÃO
OBRIGATÓRIO
Accept
application/vnd.linkc.com.br; version=1 Versão da API. SIM
Authorization
Bearer <TOKEN>
Token obtido na autenticação
SIM
Content-Type
application/json
Tipo de conteúdo do request
SIM

PARÂMETROS (BODY)

CHAVE
DESCRIÇÃO
OBRIGATÓRIO

tipo

“MEN” para mensalista, “AUT” para autorizado. Caso o credenciado seja mensalista ele será associado à mensalidade e vencimento préconfigurados na plataforma.

SIM

nome

Nome doa credenciado,pessoa ou razão social da emrpesa, até 50 caracteres.

SIM

documento

DocumentoCPF/CNPJ do credenciado, até 12 caracteres.

credenciado

NÃO

cpf

CPF do credenciado.

NÃO

SIM

qtd_vagas

Quantidade de vagas que o credenciadocontrato de plano tem direito de utilizar simultaneamente. Caso o parâmetro não seja informado, será cadastrado o valor 1.

NÃO

telefone

Telefone do credenciado, até 15 caracteres.

NÃO

mensalidade_idplano_id

Código dado mensalidade,plano, esse valor de ser consultado na chamada api/integradores/mesalidadesplabis, caso não seja informado, iremos cadastrar com o valor padrão cadastrado para a garagem.

NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
DESCRIÇÃO
id

Código do credenciadocontrato de plano gerado na garagem.

nomepessoa_id

Código da pessoa.

pessoa_nome

Nome doda credenciado.pessoa.

documento

Documento doda credenciado.

cpf

CPF do credenciado.

tipo

Tipo do credenciado.pessoa.

qtd_vagas

Quantidade de vagas do credenciado.

telefoneplano_id

TelefoneCódigo do credenciado.plano.

plano_identificacao

Identificação do plano

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "credenciado"plano_contrato": {
        "id": "123456",
        "nome"pessoa_id": "MARIA VITÓRIA OLIVEIRA",
        "documento"pessoa_nome": "12.345.678-X"MARIA VITÓRIA OLIVEIRA",
        "cpf"pessoa_documento": "64454846626",
        "tipo": "MEN",
        "qtd_vagas": 1,
        "telefone"plano_id": "(19)MEN",
        987654321""plano_identificao": "PLANO MENSAL"
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
DESCRIÇÃO
400
Caso os parâmetros passados estejam incorretos.
401
Caso as credenciais sejam inválidas.

502

Caso não seja possível realizar comunicação com a automação da garagem.