Consulta chave de contrato de plano

Consulta código do cartão de um contrato de plano, que é uma chave, para obter o código do plano contrato e o código do plano. A chave (número do cartão) é passado como parâmetro na URL do serviço.

Como consulta opcional, pode-se informar o CPF do credenciado como parâmetro QUERY STRING, desta forma, iremos validar se o documento (CFP/CNPJ) informado pertence à chave informada. Caso não pertença, iremos retornar chave não encontrada.

Em ambiente de desenvolvimento, todas chaves, com exceção daqueles iniciados pelo dígito “9”, serão encontrados e possuirão um plano_contrato_id e plano_id gerado aleatoriamente. As requisições com chaves iniciadas pelo dígito “9” retornarão código de erro 404 (not found).

GET api/contratos_planos_chaves/<chave>

HEADERS

PARÂMETRO QUERY STRING

RETORNO EM CASO DE SUCESSO (200 – OK)

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

{
    "plano_contrato_chave": {
        "chave": "1234567890",
        "contrato_plano": {
          "id": "4413b7e9-82ec-49ec-ab9c-cef8642bdaa0",
          "plano_id": "e1c0e701-56ed-49a4-af8f-001131ff9bad"
        }
    }
}

OUTROS RETORNOS