DESCRIPCIÓN.
Este Web Service, permite consultar el listado de Departamentos o Regiones registrados en la Aplicación SIFCO WEB, es importante tomar en cuenta que cada Región, Estado o Departamento, según sea el caso, esta asociado a un País. Y a su vez cada Región, Estado o Departamento tienen asociados Municipios, Alcaldías o Departamentos locales según sea el caso. Por ello es importante consumir este Web Service, previo a ingresar un cliente en la Aplicación SIFCO WEB, junto a los correspondientes a Países (WSApPaisLista) y Municipios (WSApMunicipioLista), y poder definir la ubicación exacta del cliente.
EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.
A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.
METODO POST
Este método para este Web Service en especifico permite Obtener el Listado de Departamentos o Regiones registrados en la Aplicación SIFCO WEB
El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo |
|---|---|
REQUEST | URL: https://test.sifco.org/democoopgt/rest/WSApDepartamentoLista HEADERS content-type: application/json authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........ genexus-agent: SmartDevice Application |
200 (Operación Exitosa) | {
"DepartamentoLista": [
{
"CodigoPais": 320,
"CodigoDepartamento": 1,
"Descripcion": "Guatemala",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 4,
"Descripcion": "Chimaltenango",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 5,
"Descripcion": "Chiquimula",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 6,
"Descripcion": "Petén",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 7,
"Descripcion": "Quiché",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 8,
"Descripcion": "Escuintla",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 9,
"Descripcion": "Huehuetenango",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 10,
"Descripcion": "Izabal",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 11,
"Descripcion": "Jalapa",
"URI": ""
},
{
"CodigoPais": 320,
"CodigoDepartamento": 12,
"Descripcion": "Jutiapa",
"URI": ""
},
{
"CodigoPais": 593,
"CodigoDepartamento": 1,
"Descripcion": "Pichincha",
"URI": ""
}
],
}
|
400 (Bad Request). Solicitud Errada | {
"error": {
"code": "string",
"message": "string"
}
}
|
401 (This service needs an Authorization Header) (No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ). | {
"error": {
"code":"0",
"message":"This service needs an Authorization Header"
}
}
{
"DepartamentoLista": []
}
|
404 (Not Found). | Respuesta Vacía (Web Service, no encontrado ) |
500 (Internal Server Error) (Error Interno del Servidor de las API’s REST). | {
"error": {
"code": "string",
"message": "string"
}
}
|
INFORMACIÓN
Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Mensajes), donde se describe el listado de mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.
Content-Type: application/json Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77... GENEXUS-AGENT: SmartDevice Application
EN CASO DE ERROR HTTP 401 (Not Authenticated)
Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST.
