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 Notificacion Cooperativa aNotificación Particular de la ejecución de un proceso dentro del Hub de Créditos 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: "API.HUB.V1.NotificacionCooperativa"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/mAWo"
produces:
  - application/json
paths:
  /API/HUB/V1/NotificacionCooperativa:
    post:
      tags:
        - API.HUB.V1.NotificacionCooperativa
      operationId: "API.HUB.V1.NotificacionCooperativa"
      summary: "Notificacion Cooperativa a Hub de Créditos"
      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: "NotificacionCooperativaInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/API.HUB.V1.NotificacionCooperativaInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/API.HUB.V1.NotificacionCooperativaOutput"

        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        400:
          description: "Bad request"
          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 metodométodo tipo POST
      Update: Permite el metodométodo tipo PUT
      Delete: Permite el metodométodo tipo DELETE
      FullControl: Permite el manejo de los Cuatro MetodosMétodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  API.HUB.V1.NotificacionCooperativaInput:
    properties:
      data:
        description: SDTNotificacion Cooperativa
        $ref: "#/definitions/SDTNotificacionCooperativa"

  SDTNotificacionCooperativa:
    properties:
      idHub:
        description: id Hub
        type: "string"

      idPrestador:
        description: id Prestador
        type: "integer"
        format: "int64"

      planesPagoCursados:
        type: array
        items:
          description: planesPagoCursadosItem
          $ref: "#/definitions/SDTNotificacionCooperativa.planesPagoCursados"

  SDTNotificacionCooperativa.planesPagoCursados:
    properties:
      idTransaccion:
        description: id TransaccionTransacción
        type: "integer"
        format: "int64"

      idTransaccionSifco:
        description: id TransaccionTransacción Sifco
        type: "string"

      tipoIdentidadCliente:
        description: tipo Identidad Cliente
        type: "integer"
        format: "int32"

      identidadCliente:
        description: identidad Cliente
        type: "string"

      fechaRespuestaPlan:
        description: fecha Respuesta Plan
        type: "string"

      idNegocio:
        description: id Negocio
        type: "integer"
        format: "int64"

      idOperacionNegocio:
        description: id OperacionOperación Negocio
        type: "string"

      idRelacionPN:
        description: id RelacionRelación PN
        type: "integer"
        format: "int64"

      idRelacionTP:
        description: id RelacionRelación TP
        type: "integer"
        format: "int64"

      montoAprobado:
        description: monto Aprobado
        type: "number"
        format: "double"

      idPlanPago:
        description: id Plan Pago
        type: "integer"
        format: "int64"

      idPlanPagoSifco:
        description: id Plan Pago Sifco
        type: "string"

      comprobanteVenta:
        description: comprobante Venta
        type: "integer"
        format: "int64"

      serieComprobanteVenta:
        description: serie Comprobante Venta
        type: "string"

      montoComprobanteVenta:
        description: monto Comprobante Venta
        type: "number"
        format: "double"

      fechaComprobanteVenta:
        description: fecha Comprobante Venta
        type: "string"

      codigoAutorizacion:
        description: codigocódigo AutorizacionAutorización
        type: "string"


    x-gx-level: "SDTNotificacionCooperativa"

  API.HUB.V1.NotificacionCooperativaOutput:
    properties:
      result:
        description: SDTNotificacion Cooperativa Result
        $ref: "#/definitions/SDTNotificacionCooperativaResult"

  SDTNotificacionCooperativaResult:
    properties:
      idPrestador:
        description: id Prestador
        type: "integer"
        format: "int32"

      acuseRecibo:
        type: array
        items:
          description: acuseReciboItem
          $ref: "#/definitions/SDTNotificacionCooperativaResult.acuseRecibo"


  SDTNotificacionCooperativaResult.acuseRecibo:
    properties:
      idTransaccion:
        description: id TransaccionTransacción
        type: "integer"
        format: "int64"

      idTransaccionSifco:
        description: id Transaccion Sifco
        type: "string"

      fechaOperacionPrestador:
        description: fecha OperacionOperación Prestador
        type: "string"

      observacion:
        description: observacionobservación
        type: "string"


    x-gx-level: "SDTNotificacionCooperativaResult"
 
  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: CodigoCódigo 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 Hub de Créditos, 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.