Cadastro de contratol de plano
Adiciona registro de contrato de plano na garagem.
POST api/integradores/planos_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 a pessoa ou razão social da emrpesa, até 50 caracteres. |
SIM |
|
documento |
CPF/CNPJ do credenciado | SIM |
|
qtd_vagas |
Quantidade de vagas que o contrato de plano tem direito de utilizar simultaneamente. Caso o parâmetro não seja informado, será cadastrado o valor 1. |
NÃO |
|
plano_id |
Código do plano, esse valor de ser consultado na chamada api/integradores/plabis, 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 contrato de plano gerado na garagem. |
|
pessoa_id |
Código da pessoa. |
|
pessoa_nome |
Nome da pessoa. |
|
documento |
Documento da pessoa. |
|
qtd_vagas |
Quantidade de vagas do credenciado. |
|
plano_id |
Código do plano. |
|
plano_identificacao |
Identificação do plano |
EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)
{
"plano_contrato": {
"id": "123456",
"pessoa_id": "MARIA VITÓRIA OLIVEIRA",
"pessoa_nome": "MARIA VITÓRIA OLIVEIRA",
"pessoa_documento": "64454846626",
"qtd_vagas": 1,
"plano_id": "MEN",
"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. |