Skip to main content

Excluir chave no contrato de plano

Endpoint para inserirexcluir uma chave (placa) em um contrato de plano através de um documento (CPF/CNPJ) de cliente que tenha um contrato de plano.

POSTDELETE api/planos_contratos/<documento_cliente>/chaveschaves/<chave>

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

documento_cliente

Documento do cliente (CPF/CNPJ) que tenha um contrato de plano

SIM

chave

Chave (placa) a ser inseridoexcluída

SIM

pessoa_id

Id da pessoa a ser vinculada a chave

NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
DESCRIÇÃO
id
Identificador único da chave do contrato de plano
chave
Chave
pessoa.id
Identificador único da pessoa
pessoa.nome
Nome da pessoa

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

{
    "contrato_plano_chave": {
      "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
      "chave": "AAA111",
      "pessoa": {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "nome": "FULANO",
        "documento": "012345678901",
      }
}


OUTROS RETORNOS

CÓDIGO HTTP
DESCRIÇÃO
201Sucesso na exclusão
401
Caso as credenciais sejam inválidas.
404 Contrato de plano ou chave não encontrado
400Chave já cadastrada