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": "123456",
        "plano_contrato": {
            "id": "74474aad-30a4-4dc8-979d-89ed96c8d27f",
            "plano": {
                "id": "f0ffbf99-9dc8-4f5f-974d-16e7c8c73c52",
                "identificao": "PLANO MENSAL"
            }
        }
    }
}

OUTROS RETORNOS