Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

DESCRIPCIÓN.

Este Web Service, permite el ingreso al sistemas de clientes (asociados / socios), permitiendo cargar solo los Datos Generales. Ademas de quedar registrado en la Aplicación SIFCO WEB, como un cliente. Es importante acotar que para la correcta carga de todos los parámetros de un cliente se deben consumir todos los Web Services de Consulta de Categorías Generales, dado a que ellos les permitan conocer todas las diferentes opciones de parámetros de clientes registrados en la Aplicación SIFCO WEB.

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

TClClientes

ClTipPersona

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ApTidCod

WSApTiposIdentificacionLista

ClPaiCod

WSApPaisLista

ClRegCod

WSApDepartamentoLista

ClDepCod

WSApMunicipioLista

ClSexo

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ClEstCivil

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

GrAfCodigo

WSClGruposLista

ApPrmCod

WSApUsuariosSistemaLista

ClImpuestos

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ClEstado

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ApActCod

WSActividadEconomicaLista

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 la Creación de Clientes en la Aplicación SIFCO WEB.

El siguiente ejemplo inserta un cliente en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

https://test.sifco.org/democoopgt/rest/tclclientes/3

HEADERS

content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

BODY:

{
    "ClCliCod": 3,
    "ClTipPersona": "N",
    "ApTidCod": 1,
    "ApTidDes": "DPI",
    "ApTidForma": "9999 99999 9999",
    "ClPaiCod": 320,
    "ClPaiNom": "GUATEMALA",
    "ClRegCod": 1,
    "ClRegDes": "Guatemala",
    "ClDepCod": 1,
    "ClDepDes": "Guatemala",
    "ClMunCod": 0,
    "ClMunDes": "",
    "ClNumID": "3001 35874 0101",
    "ClPNombre": "ANA",
    "ClSNombre": "MARIA DEL CARMEN MUJER",
    "ClPApellido": "CIFUENTES",
    "ClSApellido": "GONZALEZ",
    "ClApeCasada": "",
    "ClSexo": "F",
    "ClFNacimiento": "1996-04-01",
    "ClEstCivil": 1,
    "ClEdad": 23,
    "ClEdadRango": "De 21 a 30 años",
    "ClNomJuridico": "",
    "ClRepLegal": "",
    "ClRegMercantil": "",
    "ClFecConstitucion": "0000-00-00",
    "GrAfCodigo": 4,
    "GrAfDescripcion": "GRUPO ZONA 7",
    "ClIdeTrib": "C/F",
    "ApPrmCod": "agomez",
    "ApPrmNombre": "Anibal Gomez",
    "ClImpuestos": "S",
    "ClFIngreso": "2016-04-19",
    "ClEstado": "A",
    "ClFecInactivacion": "0000-00-00",
    "ClFotoArchivo": "PublicTempStorage/multimedia/foto01_a22b159c858a4dceadfb17128abe99ac.JPG",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefPerUlt": 4,
    "RefSegUlt": 0,
    "ClReferencia": "1234",
    "ClSoliAsigna": 0,
    "ClApSucCod": 1,
    "ClATMPin": "",
    "ApActCod": 6,
    "ApActDes": "PROFESOR",
    "ClMensajeAdvertencia": "",
    "ClFirma": "PublicTempStorage/multimedia/pulgar_1e0e1be95b69465588651bbdb2254fac.jpg",
    "ClHuella": "",
    "ClTipoHuella": 0,
    "ClPortalFechaActualizacion": "0000-00-00",
    "ClExcluirCorreosElectronicos": 0,
    "ClFechaModificacion": "2018-10-26",
    "ClUsuarioModificacionCodigo": "admin",
    "ClUsuarioModificacionNombre": "admin",
    "ClRazonListaNegra": "",
    "ClOtraNacionalidad": false,
    "ClNacionalidad1Codigo": "GTM",
    "ClNacionalidad1Descripcion": "GUATEMALA",
    "ClNacionalidad2Codigo": "",
    "ClNacionalidad2Descripcion": "",
    "ClCondicionMigratoria": 2,
    "gx_md5_hash": "15B28FE875F351FB93F8B4DBB9046EA9"
}

200 (Successful operation)

Operación Exitosa

{
    "ClCliCod": 3,
    "ClTipPersona": "N",
    "ApTidCod": 1,
    "ApTidDes": "DPI",
    "ApTidForma": "9999 99999 9999",
    "ClPaiCod": 320,
    "ClPaiNom": "GUATEMALA",
    "ClRegCod": 1,
    "ClRegDes": "Guatemala",
    "ClDepCod": 1,
    "ClDepDes": "Guatemala",
    "ClMunCod": 0,
    "ClMunDes": "",
    "ClNumID": "3001 35874 0101",
    "ClPNombre": "ANA",
    "ClSNombre": "MARIA DEL CARMEN MUJER",
    "ClPApellido": "CIFUENTES",
    "ClSApellido": "GONZALEZ",
    "ClApeCasada": "",
    "ClSexo": "F",
    "ClFNacimiento": "1996-04-01",
    "ClEstCivil": 1,
    "ClEdad": 23,
    "ClEdadRango": "De 21 a 30 años",
    "ClNomJuridico": "",
    "ClRepLegal": "",
    "ClRegMercantil": "",
    "ClFecConstitucion": "0000-00-00",
    "GrAfCodigo": 4,
    "GrAfDescripcion": "GRUPO ZONA 7",
    "ClIdeTrib": "C/F",
    "ApPrmCod": "agomez",
    "ApPrmNombre": "Anibal Gomez",
    "ClImpuestos": "S",
    "ClFIngreso": "2016-04-19",
    "ClEstado": "A",
    "ClFecInactivacion": "0000-00-00",
    "ClFotoArchivo": "PublicTempStorage/multimedia/foto01_a22b159c858a4dceadfb17128abe99ac.JPG",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefPerUlt": 4,
    "RefSegUlt": 0,
    "ClReferencia": "1234",
    "ClSoliAsigna": 0,
    "ClApSucCod": 1,
    "ClATMPin": "",
    "ApActCod": 6,
    "ApActDes": "PROFESOR",
    "ClMensajeAdvertencia": "",
    "ClFirma": "PublicTempStorage/multimedia/pulgar_1e0e1be95b69465588651bbdb2254fac.jpg",
    "ClHuella": "",
    "ClTipoHuella": 0,
    "ClPortalFechaActualizacion": "0000-00-00",
    "ClExcluirCorreosElectronicos": 0,
    "ClFechaModificacion": "2018-10-26",
    "ClUsuarioModificacionCodigo": "admin",
    "ClUsuarioModificacionNombre": "admin",
    "ClRazonListaNegra": "",
    "ClOtraNacionalidad": false,
    "ClNacionalidad1Codigo": "GTM",
    "ClNacionalidad1Descripcion": "GUATEMALA",
    "ClNacionalidad2Codigo": "",
    "ClNacionalidad2Descripcion": "",
    "ClCondicionMigratoria": 2,
    "gx_md5_hash": "15B28FE875F351FB93F8B4DBB9046EA9"
}

201 (Created)

(Registro Creado con Éxito)

{
    "ClCliCod": 3,
    "ClTipPersona": "N",
    "ApTidCod": 1,
    "ApTidDes": "DPI",
    "ApTidForma": "9999 99999 9999",
    "ClPaiCod": 320,
    "ClPaiNom": "GUATEMALA",
    "ClRegCod": 1,
    "ClRegDes": "Guatemala",
    "ClDepCod": 1,
    "ClDepDes": "Guatemala",
    "ClMunCod": 0,
    "ClMunDes": "",
    "ClNumID": "3001 35874 0101",
    "ClPNombre": "ANA",
    "ClSNombre": "MARIA DEL CARMEN MUJER",
    "ClPApellido": "CIFUENTES",
    "ClSApellido": "GONZALEZ",
    "ClApeCasada": "",
    "ClSexo": "F",
    "ClFNacimiento": "1996-04-01",
    "ClEstCivil": 1,
    "ClEdad": 23,
    "ClEdadRango": "De 21 a 30 años",
    "ClNomJuridico": "",
    "ClRepLegal": "",
    "ClRegMercantil": "",
    "ClFecConstitucion": "0000-00-00",
    "GrAfCodigo": 4,
    "GrAfDescripcion": "GRUPO ZONA 7",
    "ClIdeTrib": "C/F",
    "ApPrmCod": "agomez",
    "ApPrmNombre": "Anibal Gomez",
    "ClImpuestos": "S",
    "ClFIngreso": "2016-04-19",
    "ClEstado": "A",
    "ClFecInactivacion": "0000-00-00",
    "ClFotoArchivo": "PublicTempStorage/multimedia/foto01_a22b159c858a4dceadfb17128abe99ac.JPG",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefPerUlt": 4,
    "RefSegUlt": 0,
    "ClReferencia": "1234",
    "ClSoliAsigna": 0,
    "ClApSucCod": 1,
    "ClATMPin": "",
    "ApActCod": 6,
    "ApActDes": "PROFESOR",
    "ClMensajeAdvertencia": "",
    "ClFirma": "PublicTempStorage/multimedia/pulgar_1e0e1be95b69465588651bbdb2254fac.jpg",
    "ClHuella": "",
    "ClTipoHuella": 0,
    "ClPortalFechaActualizacion": "0000-00-00",
    "ClExcluirCorreosElectronicos": 0,
    "ClFechaModificacion": "2018-10-26",
    "ClUsuarioModificacionCodigo": "admin",
    "ClUsuarioModificacionNombre": "admin",
    "ClRazonListaNegra": "",
    "ClOtraNacionalidad": false,
    "ClNacionalidad1Codigo": "GTM",
    "ClNacionalidad1Descripcion": "GUATEMALA",
    "ClNacionalidad2Codigo": "",
    "ClNacionalidad2Descripcion": "",
    "ClCondicionMigratoria": 2,
    "gx_md5_hash": "15B28FE875F351FB93F8B4DBB9046EA9"
}

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 Errores) External Call Out, donde se describe el listado de errores 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.

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente

Show More Please wait
Version Date Comment
Current Version (v. 9) Sept 23, 2019 16:39 Alfredo Lopez
v. 15 Oct 07, 2019 01:13 Alfredo Lopez
v. 14 Sept 29, 2019 21:26 Alfredo Lopez
v. 13 Sept 28, 2019 05:55 Alfredo Lopez
v. 12 Sept 28, 2019 05:53 Alfredo Lopez
v. 11 Sept 23, 2019 23:25 Alfredo Lopez
v. 10 Sept 23, 2019 17:23 Alfredo Lopez
v. 9 Sept 23, 2019 16:39 Alfredo Lopez
v. 8 Sept 23, 2019 15:58 Alfredo Lopez
v. 7 Sept 23, 2019 15:01 Alfredo Lopez
v. 6 Sept 23, 2019 14:59 Alfredo Lopez
v. 5 Sept 23, 2019 13:17 Alfredo Lopez
v. 4 Sept 17, 2019 20:20 Alfredo Lopez
v. 3 Sept 15, 2019 02:49 Alfredo Lopez
v. 2 Sept 13, 2019 19:32 Alfredo Lopez
v. 1 Sept 11, 2019 17:26 Alfredo Lopez


  • No labels

(c) 2020 por SIFC.O, S.A.