Diferencia entre revisiones de «Descripción de los Atributos de la respuesta JSON»
De Documentación del API Cedula
Línea 1: | Línea 1: | ||
− | * '''error''': Campo Boolean, si esta en “true” | + | * '''error''': Campo Boolean, si esta en “true” ocurrió un error en la consulta, la descripción del error estará en el atributo “error_str”. |
* '''error_str''': Campo String|Boolean, retorna “false” si no ocurrió ningún error. En el caso que haya ocurrido un error contendrá una cadena string con alguna de las siguientes opciones: | * '''error_str''': Campo String|Boolean, retorna “false” si no ocurrió ningún error. En el caso que haya ocurrido un error contendrá una cadena string con alguna de las siguientes opciones: | ||
** ''DB_ERROR'': Indica que ocurrió un error temporal en la Base de Datos. | ** ''DB_ERROR'': Indica que ocurrió un error temporal en la Base de Datos. | ||
Línea 9: | Línea 9: | ||
** '''''nacionalidad''''': Indica el tipo de nacionalidad, V para venezolanos y E para extranjeros. | ** '''''nacionalidad''''': Indica el tipo de nacionalidad, V para venezolanos y E para extranjeros. | ||
** '''''cedula''''': Indica el número de cédula consultada. | ** '''''cedula''''': Indica el número de cédula consultada. | ||
− | ** '''''rif''''': Campo String, contiene el RIF de la persona si el plan contratado lo permite. En caso contrario no se | + | ** '''''rif''''': Campo String, contiene el RIF de la persona si el plan contratado lo permite. En caso contrario no se retornará este atributo. |
** '''''primer_apellido''''':Campo String, contiene el primer apellido de la persona. | ** '''''primer_apellido''''':Campo String, contiene el primer apellido de la persona. | ||
− | ** '''''segundo_apellido''''': Campo String, contiene el segundo apellido de la persona, si lo posee. En | + | ** '''''segundo_apellido''''': Campo String, contiene el segundo apellido de la persona, si lo posee. En caso contrario este atributo no se retorna. |
** '''''primer_nombre''''':Campo String, contiene el primer nombre de la persona. | ** '''''primer_nombre''''':Campo String, contiene el primer nombre de la persona. | ||
− | ** '''''segundo_nombre''''': Campo String, contiene el segundo nombre de la persona, si lo posee. En | + | ** '''''segundo_nombre''''': Campo String, contiene el segundo nombre de la persona, si lo posee. En caso contrario este atributo no se retorna. |
** '''cne''': Campo Json-Object, contiene la información electoral de la cédula (hasta la fecha Febrero 2012), si no existe esta información no se retorna este atributo, en caso contrario se retornara un Json-Object con los siguientes atributos: | ** '''cne''': Campo Json-Object, contiene la información electoral de la cédula (hasta la fecha Febrero 2012), si no existe esta información no se retorna este atributo, en caso contrario se retornara un Json-Object con los siguientes atributos: | ||
*** '''''estado''''': Campo String, muestra el estado de Venezuela o Embajada donde vota esta persona, puede ser utilizada como dirección fiscal. | *** '''''estado''''': Campo String, muestra el estado de Venezuela o Embajada donde vota esta persona, puede ser utilizada como dirección fiscal. |
Última revisión de 13:51 6 abr 2015
- error: Campo Boolean, si esta en “true” ocurrió un error en la consulta, la descripción del error estará en el atributo “error_str”.
- error_str: Campo String|Boolean, retorna “false” si no ocurrió ningún error. En el caso que haya ocurrido un error contendrá una cadena string con alguna de las siguientes opciones:
- DB_ERROR: Indica que ocurrió un error temporal en la Base de Datos.
- MAX_NUM_REQUEST: Indica que superó el límite máximo de consultas por hora de su plan contratado.
- INVALID_TOKEN: Indica que el APP-ID o Token son inválidos, puede ser porque han caducado o son erróneos.
- URL_ERROR: Indica que alguno de los campos app_id, token o cédula de la consulta presentan un formato inválido o está faltando algunos de ellos en la consulta.
- RECORD_NOT_FOUND: Indica que la cédula solicitada no fue encontrada en nuestra Base de Datos.
- data: Campo Json-Object|Boolean, contiene un booleano en false si ocurrió algún error o no fue localizada la cédula consultada. En caso contrario contiene un Json-Object con los siguientes atributos:
- nacionalidad: Indica el tipo de nacionalidad, V para venezolanos y E para extranjeros.
- cedula: Indica el número de cédula consultada.
- rif: Campo String, contiene el RIF de la persona si el plan contratado lo permite. En caso contrario no se retornará este atributo.
- primer_apellido:Campo String, contiene el primer apellido de la persona.
- segundo_apellido: Campo String, contiene el segundo apellido de la persona, si lo posee. En caso contrario este atributo no se retorna.
- primer_nombre:Campo String, contiene el primer nombre de la persona.
- segundo_nombre: Campo String, contiene el segundo nombre de la persona, si lo posee. En caso contrario este atributo no se retorna.
- cne: Campo Json-Object, contiene la información electoral de la cédula (hasta la fecha Febrero 2012), si no existe esta información no se retorna este atributo, en caso contrario se retornara un Json-Object con los siguientes atributos:
- estado: Campo String, muestra el estado de Venezuela o Embajada donde vota esta persona, puede ser utilizada como dirección fiscal.
- municipio: Campo String, muestra el municipio de Venezuela o Embajada donde vota la persona, puede ser utilizada como dirección fiscal.
- parroquia: Campo String, muestra la parroquia de Venezuela o Embajada donde vota la persona, puede ser utilizada como dirección fiscal de la persona.
- centro_electoral: Campo String, muestra el nombre del centro de votación donde vota la persona.
- request_date: Campo Date, retorna la fecha de la consulta actual.