Helper

Introducción

El objetivo del documento es explicar el proceso de implementación del servicio web, sus métodos existentes y los parámetros de entrada y salida para la consulta ws Detalleubicacion para conocer los posibles resultados obtenidos de la consulta, cumpliendo con las condiciones y dependiendo de los valores ingresados en los parámetros de entrada para obtener ya sea todas las localidades, las poblaciones y calles. Este método recibe 4 parámetros de entrada que son municipio, localidad, tipo y descripción que continuación explicaremos a mas detalles cada uno de ellos.

Url del Web service

https://apifinanzas.col.gob.mx/API/wsDetalleUbicacion

Autenticación del Web service.

Para su correcto funcionamiento, el servicio web cuenta con autenticación de usuarios. Para ello, a cada responsable de la implementación de dicho servicio, se le proporcionarán los datos de usuario y contraseña.

Parámetros de entrada

El método del servicio web requiere invariablemente de los campos de usuario y contraseña, pero de manera independiente requiere de diferentes parámetros de entrada necesarios, los cuales se especifican a continuación:

Parámetros	Tipo de dato	Tamaño	Descripción
Municipio	Varchar	2 máx.	Clave de municipio
Localidad	Varchar	5 máx.	Clave de localidad
Tipo	Varchar	1 máx.	Tipo de busqueda 1. Busca munipio. 2. Obtiene localidades. 3. Muestra colonias. 4. Obtiene calles.
Descripcion	Varchar	50 máx.	Si en el parámetro de entrada tipo se especifica que la búsqueda es 3 ó 4 en este campo ingresaras alguna clave para la búsqueda de una calle o todas aquellas calles que cumplan con la condición expuesta en este campo los parámetros de Municipio y Localidad son obligatorios en esta búsqueda.

Parámetros de salida

Parámetros	Tipo de dato	Tamaño	Descripción
ltDomicilios	json string	Máximo	Muestra el array bidimensional A continuación describiré todas la posibilidades de regresar el array si solo si en el parámetro de entrada Municipio ingresa 01 y en el parámetro de entrada Tipo 1 obtiene todos los municipio. Si solo si el parámetro de entrada Municipio cambia por alguna otra clave de municipio y la búsqueda se establece como 2 regresa todas las localidades existentes en ese municipio. Si en el parámetro de entrada Municipio ingresamos la clave de municipio y el Tipo establecemos la búsqueda de colonias que es igual a ingresar 3 en este parámetro obtendremos todas las colonias de ese municipio y para buscar una colonia en particular en el parámetro de descripción ingresamos alguna palabra clave para buscar una colonia en específico los campos obligatorios para efectuar esta búsqueda son Municipio y Localidad. Para obtener las calles existentes, los campos obligatorios son Municipio, Localidad y Colonias así como ingresar en el campo Tipo el numero 4 para así mostrar todas las calles de municipio con esa localidad y esa colonia en especificó.

Parámetros

Tipo de dato

Tamaño

Descripción

ltDomicilios

json string

Máximo

Muestra el array bidimensional A continuación describiré todas la posibilidades de regresar el array

si solo si en el parámetro de entrada Municipio ingresa 01 y en el parámetro de entrada Tipo 1 obtiene todos los municipio.
Si solo si el parámetro de entrada Municipio cambia por alguna otra clave de municipio y la búsqueda se establece como 2 regresa todas las localidades existentes en ese municipio.
Si en el parámetro de entrada Municipio ingresamos la clave de municipio y el Tipo establecemos la búsqueda de colonias que es igual a ingresar 3 en este parámetro obtendremos todas las colonias de ese municipio y para buscar una colonia en particular en el parámetro de descripción ingresamos alguna palabra clave para buscar una colonia en específico los campos obligatorios para efectuar esta búsqueda son Municipio y Localidad.
Para obtener las calles existentes, los campos obligatorios son Municipio, Localidad y Colonias así como ingresar en el campo Tipo el numero 4 para así mostrar todas las calles de municipio con esa localidad y esa colonia en especificó.

Detalle Ubicación