swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Registrar o Modificar clientes en la **Aplicación SIFCO WEB** ."
  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 Clientes 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: "Insertar Clientes 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 Clientes 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"

    delete:
      tags:
        - TClClientes
      operationId: "DeleteTClClientes"
      summary: "Eliminar Clientes 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"
        204:
          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"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"


security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el metodo tipo GET
      Insert: Permite el metodo tipo POST
      Update: Permite el metodo tipo PUT
      Delete: Permite el metodo tipo DELETE
      FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  TClClientes:
    properties:
      ClCliCod:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClTipPersona:
        description: Tipo de Persona
        type: "string"

      ApTidCod:
        description: Tipo de Identificación
        type: "integer"
        format: "int32"

      ApTidDes:
        description: Nombre de Identificación
        type: "string"

      ApTidForma:
        description: Formato de Identificación
        type: "string"

      ClPaiCod:
        description: Pais de Emisión Documento
        type: "integer"
        format: "int64"

      ClPaiNom:
        description: Nombre del Pais
        type: "string"

      ClRegCod:
        description: Código Región Emisión Identifi
        type: "integer"
        format: "int64"

      ClRegDes:
        description: Descripción de Región
        type: "string"

      ClDepCod:
        description: Departamento Emisión Identific
        type: "integer"
        format: "int64"

      ClDepDes:
        description: Nombre del Departamento
        type: "string"

      ClMunCod:
        description: Código Municipio Emisión Ident
        type: "integer"
        format: "int64"

      ClMunDes:
        description: Nombre Municipio
        type: "string"

      ClNumID:
        description: Número de Identificación Clien
        type: "string"

      ClPNombre:
        description: Primer Nombre
        type: "string"

      ClSNombre:
        description: Segundo Nombre
        type: "string"

      ClPApellido:
        description: Primer Apellido
        type: "string"

      ClSApellido:
        description: Segundo Apellido
        type: "string"

      ClApeCasada:
        description: Apellido de Casada
        type: "string"

      ClSexo:
        description: Sexo Cliente
        type: "string"

      ClFNacimiento:
        description: Fecha de Nacimiento
        type: "string"
        format: "date"

      ClEstCivil:
        description: Estado Civil
        type: "integer"
        format: "int32"

      ClEdad:
        description: Edad
        type: "integer"
        format: "int32"

      ClEdadRango:
        description: Rango de Edad
        type: "string"

      ClNomJuridico:
        description: Nombre de Empresa o Sociedad
        type: "string"

      ClRepLegal:
        description: Nombre del Representante Legal
        type: "string"

      ClRegMercantil:
        description: Número de Registro Mercantil
        type: "string"

      ClFecConstitucion:
        description: Fecha de Constitución
        type: "string"
        format: "date"

      GrAfCodigo:
        description: Código del Grupo de Afinidad
        type: "integer"
        format: "int64"

      GrAfDescripcion:
        description: Descripción del Grupo Afinidad
        type: "string"

      ClIdeTrib:
        description: Número de Identificación Tributaria
        type: "string"

      ApPrmCod:
        description: Código Promotor
        type: "string"

      ApPrmNombre:
        description: Nombre
        type: "string"

      ClImpuestos:
        description: Afecto a Impuestos
        type: "string"

      ClFIngreso:
        description: Fecha de Ingreso al Sistema
        type: "string"
        format: "date"

      ClEstado:
        description: Estado del Cliente
        type: "string"

      ClFecInactivacion:
        description: Fecha de Inactivación
        type: "string"
        format: "date"

      ClFotoArchivo:
        description: Nombre Archivo de Foto
        type: "string"

      ClNomSocio:
        description: Nombre del Cliente
        type: "string"

      RefPerUlt:
        description: Ultima Referencia Personal
        type: "integer"
        format: "int32"

      RefSegUlt:
        description: Ultima Referencia de Seguro
        type: "integer"
        format: "int32"

      ClReferencia:
        description: Referencia
        type: "string"

      ClSoliAsigna:
        description: No. Solicitud Autorizada
        type: "integer"
        format: "int64"

      ClApSucCod:
        description: Código de Agencia
        type: "integer"
        format: "int32"

      ClATMPin:
        description: Clave ATM Pin
        type: "string"

      ApActCod:
        description: Código de actividad económica
        type: "integer"
        format: "int32"

      ApActDes:
        description: Descripción de actividad económica
        type: "string"

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

      ClFirma:
        description: Firma del Cliente
        type: "string"

      ClHuella:
        description: Huella Digial
        type: "string"

      ClTipoHuella:
        description: Mano y dedo utilizado para autenticacion
        type: "integer"
        format: "int32"

      ClPortalFechaActualizacion:
        description: Ultima fecha en la que el cliente actualizó sus datos
        type: "string"
        format: "date"

      ClExcluirCorreosElectronicos:
        description: Excluir de Correos Electronicos
        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: Codigo de Error
        type: "string"

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


    x-gx-level: "GxJsonError"

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.