Versions Compared

Old Version 5

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Swagger open api macro
swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license:
    name: "Apache 2.0"  
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "TClClientes"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/BQDU"
produces:
  - application/json
paths:
  /TClClientes/{ClCliCod}:
    get:
      tags:
        - TClClientes
      operationId: "GetTClClientes"
      summary: "Consultar Parámetros de un Cliente en el Sistema"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "ClCliCod"
          in: "path"
          description: "Código del Cliente"
          required: true
          type: "integer"
          format: "int64"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClClientes"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Data with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    post:
      tags:
        - TClClientes
      operationId: "InsertTClClientes"
      summary: "Modificar Parámetros de un Cliente en el Sistema"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "ClCliCod"
          in: "path"
          description: "Código del Cliente"
          required: true
          type: "integer"
          format: "int64"
        - name: "TClClientes"
          in: "body"
          description: "SDT of TClClientes"
          required: false
          schema:
            $ref: "#/definitions/TClClientes"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClClientes"
        201:
          description: "Created"
          schema:
            $ref: "#/definitions/TClClientes"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Data with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    put:
      tags:
        - TClClientes
      operationId: "UpdateTClClientes"
      summary: "Actualizar Parámetros de un Cliente en el Sistema"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "ClCliCod"
          in: "path"
          description: "Código del Cliente"
          required: true
          type: "integer"
          format: "int64"
        - name: "TClClientes"
          in: "body"
          description: "SDT of TClClientes"
          required: true
          schema:
            $ref: "#/definitions/TClClientes"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClClientes"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        409:
          description: "TClClientes was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"
security:
  -  deleteOAuth2: []
     tagsApiKeyAuth1: []
securityDefinitions:
  OAuth2:
   - TClClientestype: oauth2
     operationIdflow: "DeleteTClClientes"password
    tokenUrl:  summary: "Eliminar Parámetros de un Cliente en el Sistema"https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el parameters:método tipo GET
      - inInsert: headerPermite el método tipo POST
      nameUpdate: Content-TypePermite el método tipo PUT
      typeDelete: "string"Permite el método tipo DELETE
      requiredFullControl: truePermite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  defaultApiKeyAuth1:
application/json    type: apiKey
   - in: header
    name: granttype

definitions:

  nameTClClientes:
Authorization    properties:
      typeClCliCod:
"string"        description: Código del required:Cliente
true        type: "integer"
 default: OAuth <Access Token>    format: "int64"

  - in: header  ClTipPersona:
        namedescription: GENEXUS-AGENTTipo de Persona
        type: "string"

         requiredApTidCod:
true           defaultdescription: SmartDeviceTipo Applicationde Identificación
       - nametype: "ClCliCodinteger"
          informat: "pathint32"

      ApTidDes:
   description: "Código del Cliente"  description: Nombre de Identificación
     required: true  type: "string"

      typeApTidForma:
"integer"        description: Formato de format:Identificación
"int64"        responsestype: "string"

      200ClPaiCod:
 
        description: "SuccessfulPaís operation"de Emisión Documento
        schematype: "integer"
           $refformat: "#/definitions/TClClientesint64"

       204ClPaiNom:
 
        description: "SuccessfulNombre operation"del País
         schematype: "string"

      ClRegCod:
   $ref: "#/definitions/TClClientes"    description: Código Región Emisión Identificación
400:           descriptiontype: "Bad requestinteger"
        format: "int64"
schema:
      ClRegDes:
     $ref: "#/definitions/GxJsonError"  description: Descripción de Región
   401:     type: "string"

   description: "Not Authenticated" ClDepCod:
         schemadescription: Departamento Emisión Identificación
         $reftype: "#/definitions/GxJsonErrorinteger"
        404format: "int64"

        descriptionClDepDes:
"Not found"           schemadescription: Nombre del Departamento
         $reftype: "#/definitions/GxJsonErrorstring"

       500ClMunCod:
          description: "InternalCódigo serverMunicipio error"Emisión Ident
         schematype: "integer"
           $refformat: "#/definitions/GxJsonErrorint64"

 security:    - OAuth2ClMunDes:
[]        ApiKeyAuth1description: Nombre []Municipio
securityDefinitions:   OAuth2:     type: oauth2"string"

   flow: password  ClNumID:
  tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token     scopesdescription: Número de Identificación Cliente
  Execute: Permite el método tipo GET type: "string"

   Insert: Permite el métodoClPNombre:
tipo POST       Updatedescription: PermitePrimer elNombre
método tipo PUT       Deletetype: Permite"string"
el
método tipo DELETE    ClSNombre:
  FullControl: Permite el manejo de los Cuatrodescription: MétodosSegundo GET,Nombre
POST, PUT,DELETE, sobre el Web Service   ApiKeyAuth1type: "string"

  type: apiKey   ClPApellido:
 in:  header     namedescription: Primer granttypeApellido
 definitions:    TClClientes:   type: "string"
properties:
      ClCliCodClSApellido:
        description: CódigoSegundo del ClienteApellido
        type: "integerstring"

       formatClApeCasada:
"int64"        ClTipPersona:
        description: TipoApellido de PersonaCasada
        type: "string"

      ApTidCodClSexo:
        description: TipoSexo de IdentificaciónCliente
        type: "integerstring"

       formatClFNacimiento:
"int32"        ApTidDesdescription: Fecha de Nacimiento
      description: Nombre de Identificacióntype: "string"
        typeformat: "stringdate"

      ApTidFormaClEstCivil:
        description: FormatoEstado deCivil
Identificación         type: "stringinteger"
        ClPaiCodformat: "int32"

      descriptionClEdad:
     País  de Emisióndescription: DocumentoEdad
        type: "integer"
        format: "int64int32"

      ClPaiNomClEdadRango:
        description: NombreRango delde PaísEdad
        type: "string"

      ClRegCodClNomJuridico:
        description: CódigoNombre Regiónde EmisiónEmpresa Identificacióno Sociedad
        type: "integerstring"

       formatClRepLegal:
"int64"        ClRegDesdescription: Nombre del Representante Legal
    description: Descripción de Región
        type: "string"

      ClDepCodClRegMercantil:
        description: DepartamentoNúmero de EmisiónRegistro IdentificaciónMercantil
        type: "integerstring"

       formatClFecConstitucion:
"int64"        ClDepDesdescription: Fecha de Constitución
      description: Nombre del Departamentotype: "string"
        typeformat: "stringdate"

      ClMunCodGrAfCodigo:
        description: Código del MunicipioGrupo Emisiónde IdentAfinidad
        type: "integer"
        format: "int64"

      ClMunDesGrAfDescripcion:
        description: Nombre MunicipioDescripción del Grupo Afinidad
        type: "string"

      ClNumIDClIdeTrib:
        description: Número de Identificación ClienteTributaria
        type: "string"

      ClPNombreApPrmCod:
        description: PrimerCódigo NombrePromotor
        type: "string"

      ClSNombreApPrmNombre:
        description: Segundo NombreNombre
        type: "string"

      ClPApellidoClImpuestos:
        description: PrimerAfecto a ApellidoImpuestos
        type: "string"

      ClSApellidoClFIngreso:
        description: Segundo Apellido Fecha de Ingreso al Sistema
        type: "string"
       ClApeCasada:
        description: Apellido de Casada
        type: "string format: "date"

      ClSexoClEstado:
        description: SexoEstado del Cliente
        type: "string"

      ClFNacimientoClFecInactivacion:
        description: Fecha de NacimientoInactivación
        type: "string"
        format: "date"

      ClEstCivilClFotoArchivo:
        description: Nombre Archivo Estadode CivilFoto
        type: "integerstring"

       formatClNomSocio:
"int32"        ClEdaddescription: Nombre del Cliente
     description: Edad
        type: "integerstring"

      RefPerUlt:
format: "int32"       description: ClEdadRango:Ultima Referencia Personal
      description: Rango de Edadtype: "integer"
        typeformat: "stringint32"

      ClNomJuridicoRefSegUlt:
        description: Ultima NombreReferencia de Empresa o SociedadSeguro
        type: "stringinteger"
       ClRepLegal format: "int32"

      descriptionClReferencia:
 Nombre      del Representantedescription: LegalReferencia
        type: "string"

      ClRegMercantilClSoliAsigna:
        description: Número de Registro Mercantil No. Solicitud Autorizada
        type: "integer"
        typeformat: "stringint64"

      ClFecConstitucionClApSucCod:
        description: FechaCódigo de ConstituciónAgencia
        type: "stringinteger"
        format: "dateint32"

      GrAfCodigoClATMPin:
        description: CódigoClave delATM GrupoPin
de Afinidad
        type: "integerstring"

       formatApActCod:
"int64"        GrAfDescripciondescription: Código de actividad económica
     description: Descripción del Grupo Afinidadtype: "integer"
        typeformat: "stringint32"

      ClIdeTribApActDes:
        description: NúmeroDescripción de Identificaciónactividad Tributariaeconómica
        type: "string"

      ApPrmCodClMensajeAdvertencia:
        description: CódigoMensaje de Promotoradvertencia
        type: "string"

      ApPrmNombreClFirma:
        description: NombreFirma del Cliente
        type: "string"

      ClImpuestosClHuella:
        description: AfectoHuella a ImpuestosDigital
        type: "string"

      ClFIngresoClTipoHuella:
        description: Mano Fechay dededo Ingresoutilizado alpara Sistemaautenticación
        type: "stringinteger"
        format: "dateint32"

      ClEstadoClPortalFechaActualizacion:
        description: EstadoUltima delfecha Clienteen la que el cliente actualizó sus datos
        type: "string"
        format: "date"

      ClFecInactivacionClExcluirCorreosElectronicos:
        description: FechaExcluir de InactivaciónCorreos Electrónicos
        type: "stringinteger"
        format: "dateint32"

      ClFotoArchivoClFechaModificacion:
        description: Ultima fecha Nombrede Archivomodificación de datos Fotodel cliente
        type: "string"
       ClNomSocio format: "date"

      ClUsuarioModificacionCodigo:
        description: NombreCódigo del Cliente usuario que realizó la modificación
        type: "string"

      RefPerUltClUsuarioModificacionNombre:
        description: Ultima Referencia Personal Nombre del usuario que realizó la modificación
        type: "integerstring"

       formatClRazonListaNegra:
"int32"        RefSegUltdescription: Razón por la que ingresa o sale de description:la Ultimalista Referencianegra
de Seguro         type: "integerstring"

       formatClOtraNacionalidad:
"int32"        ClReferenciadescription: Cliente tiene       description: Referenciaotra nacionalidad
        type: "stringboolean"

      ClSoliAsignaClNacionalidad1Codigo:
        description: No. Solicitud AutorizadaCódigo de nacionalidad 1
        type: "integerstring"

       format: "int64"

      ClApSucCodClNacionalidad1Descripcion:
        description: CódigoNombre de nacionalidad Agencia1
        type: "integerstring"

       formatClNacionalidad2Codigo:
"int32"        ClATMPindescription: Código de       description: Clave ATM Pinnacionalidad 1
        type: "string"

      ApActCodClNacionalidad2Descripcion:
        description: CódigoNombre de actividadnacionalidad económica2
        type: "integerstring"

       formatClCondicionMigratoria:
"int32"        ApActDesdescription: Condición migratoria
      description: Descripción de actividad económicatype: "integer"
        typeformat: "stringint32"

      ClMensajeAdvertenciagx_md5_hash:
        description: Mensaje de advertencia
        type: "string"

      ClFirma:
        description: Firma del Clientegx_md5_hash is an identifier for a specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and  ignored on insert.
          type: "string"


    required:
   ClHuella:   - ClCliCod
 
  descriptionGxJsonError:
Huella  Digital  properties:
      typeerror:
"string"        ClTipoHuella$ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    descriptionproperties:
 Mano y dedo utilizado para autenticacióncode:
        typedescription: "integer" Código de Error
        formattype: "int32string"

      ClPortalFechaActualizacionmessage:
        description: UltimaMensaje fechade enError
la que el cliente actualizó sus datos         type: "string"


      formatx-gx-level: "date"

      ClExcluirCorreosElectronicos:
        description: Excluir de Correos Electrónicos
        type: "integer"
        format: "int32"

      ClFechaModificacion:
        description: Ultima fecha de modificación de datos del cliente
        type: "string"
        format: "date"

      ClUsuarioModificacionCodigo:
        description: Código del usuario que realizó la modificación
        type: "string"

      ClUsuarioModificacionNombre:
        description: Nombre del usuario que realizó la modificación
        type: "string"

      ClRazonListaNegra:
        description: Razón por la que ingresa o sale de la lista negra
        type: "string"

      ClOtraNacionalidad:
        description: Cliente tiene otra nacionalidad
        type: "boolean"

      ClNacionalidad1Codigo:
        description: Código de nacionalidad 1
        type: "string"

      ClNacionalidad1Descripcion:
        description: Nombre de nacionalidad 1
        type: "string"

      ClNacionalidad2Codigo:
        description: Código de nacionalidad 1
        type: "string"

      ClNacionalidad2Descripcion:
        description: Nombre de nacionalidad 2
        type: "string"

      ClCondicionMigratoria:
        description: Condición migratoria
        type: "integer"
        format: "int32"

      gx_md5_hash:
        description: gx_md5_hash is an identifier for a specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and  ignored on insert.
        type: "string"


    required:
      - ClCliCod
 
  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: Código de Error
        type: "string"

      message:
        description: Mensaje de Error
        type: "string"


    x-gx-level: "GxJsonError"

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:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/TClClientes/3

HEADERS

Code Block
languagehtml
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application
BODY:
GxJsonError"

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 preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ApTidCod

WSApTiposIdentificacionLista

ClPaiCod

WSApPaisLista

ClRegCod

WSApDepartamentoLista

ClDepCod

WSApMunicipioLista

ClSexo

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ClEstCivil

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

GrAfCodigo

WSClGruposLista

ApPrmCod

WSApUsuariosSistemaLista

ClImpuestos

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ClEstado

Constantes preestablecidas asociadas a variables o parámetros de 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:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/tclclientes/3

HEADERS

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

BODY:

Code Block
languagejson
{
    "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

Code Block
languagejson
{
    "ClCliCod": 03,
    "ClTipPersona": "stringN",
    "ApTidCod": 01,
    "ApTidDes": "stringDPI",
    "ApTidForma": "string9999 99999 9999",
    "ClPaiCod": 0320,
    "ClPaiNom": "stringGUATEMALA",
    "ClRegCod": 01,
    "ClRegDes": "stringGuatemala",
    "ClDepCod": 01,
    "ClDepDes": "stringGuatemala",
    "ClMunCod": 0,
    "ClMunDes": "string",
    "ClNumID": "string3001 35874 0101",
    "ClPNombre": "stringANA",
    "ClSNombre": "stringMARIA DEL CARMEN MUJER",
    "ClPApellido": "stringCIFUENTES",
    "ClSApellido": "stringGONZALEZ",
    "ClApeCasada": "string",
    "ClSexo": "stringF",
    "ClFNacimiento": "20191996-0904-2301",
    "ClEstCivil": 01,
    "ClEdad": 023,
    "ClEdadRango": "stringDe 21 a 30 años",
    "ClNomJuridico": "string",
    "ClRepLegal": "string",
    "ClRegMercantil": "string",
    "ClFecConstitucion": "20190000-0900-2300",
    "GrAfCodigo": 04,
    "GrAfDescripcion": "stringGRUPO ZONA 7",
    "ClIdeTrib": "stringC/F",
    "ApPrmCod": "stringagomez",
    "ApPrmNombre": "stringAnibal Gomez",
    "ClImpuestos": "stringS",
    "ClFIngreso": "20192016-0904-2319",
    "ClEstado": "stringA",
    "ClFecInactivacion": "20190000-0900-2300",
    "ClFotoArchivo": "stringPublicTempStorage/multimedia/foto01_a22b159c858a4dceadfb17128abe99ac.JPG",
    "ClNomSocio": "stringANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefPerUlt": 04,
    "RefSegUlt": 0,
    "ClReferencia": "string1234",
    "ClSoliAsigna": 0,
    "ClApSucCod": 01,
    "ClATMPin": "string",
    "ApActCod": 06,
    "ApActDes": "stringPROFESOR",
    "ClMensajeAdvertencia": "string",
    "ClFirma": "stringPublicTempStorage/multimedia/pulgar_1e0e1be95b69465588651bbdb2254fac.jpg",
    "ClHuella": "string",
    "ClTipoHuella": 0,
    "ClPortalFechaActualizacion": "20190000-0900-2300",
    "ClExcluirCorreosElectronicos": 0,
    "ClFechaModificacion": "20192018-0910-2326",
    "ClUsuarioModificacionCodigo": "stringadmin",
    "ClUsuarioModificacionNombre": "stringadmin",
    "ClRazonListaNegra": "string",
    "ClOtraNacionalidad": truefalse,
    "ClNacionalidad1Codigo": "stringGTM",
    "ClNacionalidad1Descripcion": "stringGUATEMALA",
    "ClNacionalidad2Codigo": "string",
    "ClNacionalidad2Descripcion": "string",
    "ClCondicionMigratoria": 02,
    "gx_md5_hash": "string15B28FE875F351FB93F8B4DBB9046EA9"
}

200 (Operación Exitosa201 (Created)

(Registro Creado con Éxito)

Code Block
languagejson
{
    "ClCliCod": 03,
    "ClTipPersona": "stringN",
    "ApTidCod": 01,
    "ApTidDes": "stringDPI",
    "ApTidForma": "string9999 99999 9999",
    "ClPaiCod": 0320,
    "ClPaiNom": "stringGUATEMALA",
    "ClRegCod": 01,
    "ClRegDes": "stringGuatemala",
    "ClDepCod": 01,
    "ClDepDes": "stringGuatemala",
    "ClMunCod": 0,
    "ClMunDes": "string",
    "ClNumID": "string3001 35874 0101",
    "ClPNombre": "stringANA",
    "ClSNombre": "stringMARIA DEL CARMEN MUJER",
    "ClPApellido": "stringCIFUENTES",
    "ClSApellido": "stringGONZALEZ",
    "ClApeCasada": "string",
    "ClSexo": "stringF",
    "ClFNacimiento": "20191996-0904-2301",
    "ClEstCivil": 01,
    "ClEdad": 023,
    "ClEdadRango": "stringDe 21 a 30 años",
    "ClNomJuridico": "string",
    "ClRepLegal": "string",
    "ClRegMercantil": "string",
    "ClFecConstitucion": "20190000-0900-2300",
    "GrAfCodigo": 04,
    "GrAfDescripcion": "stringGRUPO ZONA 7",
    "ClIdeTrib": "stringC/F",
    "ApPrmCod": "stringagomez",
    "ApPrmNombre": "stringAnibal Gomez",
    "ClImpuestos": "stringS",
    "ClFIngreso": "20192016-0904-2319",
    "ClEstado": "stringA",
    "ClFecInactivacion": "20190000-0900-2300",
    "ClFotoArchivo": "stringPublicTempStorage/multimedia/foto01_a22b159c858a4dceadfb17128abe99ac.JPG",
    "ClNomSocio": "stringANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "RefPerUlt": 04,
    "RefSegUlt": 0,
    "ClReferencia": "string1234",
    "ClSoliAsigna": 0,
    "ClApSucCod": 01,
    "ClATMPin": "string",
    "ApActCod": 06,
    "ApActDes": "stringPROFESOR",
    "ClMensajeAdvertencia": "string",
    "ClFirma": "stringPublicTempStorage/multimedia/pulgar_1e0e1be95b69465588651bbdb2254fac.jpg",
    "ClHuella": "string",,
    "ClTipoHuella": 0,
    "ClPortalFechaActualizacion": "20190000-0900-2300",
    "ClExcluirCorreosElectronicos": 0,
    "ClFechaModificacion": "20192018-0910-2326",
    "ClUsuarioModificacionCodigo": "stringadmin",
    "ClUsuarioModificacionNombre": "stringadmin",
    "ClRazonListaNegra": "string",
    "ClOtraNacionalidad": truefalse,
    "ClNacionalidad1Codigo": "stringGTM",
    "ClNacionalidad1Descripcion": "stringGUATEMALA",
    "ClNacionalidad2Codigo": "string",
    "ClNacionalidad2Descripcion": "string",
    "ClCondicionMigratoria": 02,
    "gx_md5_hash": "string15B28FE875F351FB93F8B4DBB9046EA9"
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "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) ).

Code Block
languagejson
{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"

 } }
{
  "CodigoCliente": 0,
 
"ConsultaResultados": []
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block
languagejson
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Info

INFORMACIÓN

Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de ErroresMensajes) External Call Out, donde se describe el listado de errores mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.

Note

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.

Note

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Code Block
languagejson
Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application
Warning

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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History