DESCRIPCIÓN.
Este Web Service, permite consultar los Mensajes Enviados a los Clientes registrados en la Aplicación SIFCO WEB, esta consulta se hace a través del código del mensaje, el cual esta en código UUID.
Un identificador único universal o universally unique identifier (UUID) es un número de 16 bytes (128 bits). Por tanto, el número de posibles UUID es de 1632, o unos 3,4 × 1038. En su forma canónica un UUID se expresa mediante 32 dígitos hexadecimales divididos en cinco grupos separados por guiones de la forma 8-4-4-4-12 lo que da un total de 36 caracteres (32 dígitos y 4 guiones). Por ejemplo:
550e8400-e29b-41d4-a716-446655440000
Un UUID puede ser usado con un identificador específico "intencionalmente" y ser usado en varias ocasiones para identificar el mismo objeto en diferentes contextos. Ademas de permitir enmascarar el código de un Mensaje Enviados a los Clientes registrados en la Aplicación SIFCO WEB, con un código único de identificación.
RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.
Modelo de Datos de este Web Service | Web Service a Constantes del Sistema Relacionados |
|---|---|
MensajesParaClientes | |
DirCorreE | |
DirCorreE2 |
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 GET
Este método para este Web Service en especifico permite consultar los Mensajes Enviados a los Clientes registrados en la Aplicación SIFCO WEB.
El siguiente ejemplo permite consultar un Mensaje Enviado a un Cliente registrado en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo |
|---|---|
REQUEST | URL: https://test.sifco.org/democoopgt/rest/tcltelefonos/3 HEADERS content-type: application/json authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........ genexus-agent: SmartDevice Application BODY: {
"ClCliCod": "3",
"ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
"TelUlt": 2,
"Level1": [
{
"TelCor": 1,
"TelTipo": 1,
"TelNumero": "25124597",
"TelObservacion": ""
},
{
"TelCor": 2,
"TelTipo": 3,
"TelNumero": "58947846",
"TelObservacion": ""
}
],
"ClExcluirCorreosElectronicos": 0,
"gx_md5_hash": "39A53705754A6415A5C94C1B46388896"
}
|
200 (Successful operation) Operación Exitosa | {
"ClCliCod": "3",
"ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
"TelUlt": 2,
"Level1": [
{
"TelCor": 1,
"TelTipo": 1,
"TelNumero": "25124597",
"TelObservacion": ""
},
{
"TelCor": 2,
"TelTipo": 3,
"TelNumero": "58947846",
"TelObservacion": ""
}
],
"ClExcluirCorreosElectronicos": 0,
"gx_md5_hash": "39A53705754A6415A5C94C1B46388896"
}
|
201 (Created) (Registro Creado con Éxito) | {
"ClCliCod": "3",
"ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
"TelUlt": 2,
"Level1": [
{
"TelCor": 1,
"TelTipo": 1,
"TelNumero": "25124597",
"TelObservacion": ""
},
{
"TelCor": 2,
"TelTipo": 3,
"TelNumero": "58947846",
"TelObservacion": ""
}
],
"ClExcluirCorreosElectronicos": 0,
"gx_md5_hash": "39A53705754A6415A5C94C1B46388896"
}
|
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"
}
}
|
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.
NO DEBE OLVIDAR
NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Clientes, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecució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.
| |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Artículos Relacionados | |||||||||||||||||||||||||||||||||
Artículos Actualizados Recientemente | |||||||||||||||||||||||||||||||||
|
