Skip to main content

Cadastro de contrato de plano

Adiciona registro de contrato de plano na garagem.

POST api/planos_contratos

HEADERS

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

PARÂMETROSPARÂMETROS (BODY)

CHAVE
 DESCRIÇÃODESCRIÇÃO
 OBRIGATÓRIOOBRIGATÓRIO

nome

Nome a pessoa ou razãorazão social da emrpesa, até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âmetroparâmetro nãonão seja informado, seráserá cadastrado o valor 1.

NÃONÃO

valido_de

Data e hora do inícioinício do contrato de plano.

NÃONÃO

vencimento

Data e hora do vencimento do contrato de plano.

NÃONÃO

plano_id

CódigoCódigo do plano, esse valor de ser consultado na chamada api/planos, caso nãonão seja informado, iremos cadastrar com o valor padrãopadrão cadastrado para a garagem.

NÃONÃO

RETORNO EM CASO DE SUCESSO (200 –– OK)

CHAVE
 DESCRIÇÃODESCRIÇÃO
id

CódigoCódigo do contrato de plano gerado na garagem.

pessoa.id

CódigoCódigo da pessoa.

pessoa.nome

Nome da pessoa.

pessoa.documento

Documento da pessoa.

qtd_vagas

Quantidade de vagas do credenciado.

valido_de

Data e hora do inícioinício do contrato de plano.

valido_ate

Data e hora do fim do contrato de plano.

vencimento

Data e hora do vencimento do contrato de plano.

plano.id

CódigoCódigo do plano.

plano.identificacao

IdentificaçãoIdentificação do plano

calculo.valido_de

Data e hora do inícioinício do cálculocálculo do contrato de plano.

calculo.valido_ate

Data e hora do fim do cálculocálculo do contrato de plano.

calculo.vencimento

Data e hora do vencimento do cálculocálculo do contrato de plano.

calculo.valor

Valor do cálculo.cálculo.

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

{
    "plano_contrato": {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
        "qtd_vagas": 1,
        "valido_de": "2019-08-30T18:35:25.000-03:00",
        "valido_ate": "2019-09-30T18:35:25.000-03:00",
        "vencimento": "2019-08-30T18:35:25.000-03:00",
        "chaves": ["12344"],
        "pessoa" : {  
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
          "nome": "MARIA VITÓRIAVITÓRIA OLIVEIRA",
          "documento": "64454846626",
        },
        "plano": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05"",
          "identificao": "PLANO MENSAL"
        },
        "calculo": {          
          "valido_de": "2019-08-30T18:35:25.000-03:00",
          "valido_ate": "2019-09-30T18:35:25.000-03:00",
          "vencimento": "2019-08-30T18:35:25.000-03:00",
          "valor": 100.5
        }
    }
}

OUTROS RETORNOS

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

502

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

Back to top