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 |
|
|
| |
nome |
Nome |
SIM |
|
documento |
|
|
|
|
|
|
qtd_vagas |
Quantidade de vagas que o |
NÃO |
|
|
|
|
|
Código |
NÃO |
RETORNO EM CASO DE SUCESSO (200 – OK)
| CHAVE |
DESCRIÇÃO |
|
id
|
Código do |
|
|
Código da pessoa. |
|
pessoa_nome |
Nome |
|
documento |
Documento |
|
|
|
|
|
qtd_vagas |
Quantidade de vagas do credenciado. |
|
|
|
|
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. |