Page Comparison

DESCRIPCIÓN.

Este Web Service, permite aplicar una Planilla de Pago Grupal en la Aplicación SIFCO WEB. En ella se cargan los montos y detalles del crédito para su cancelación y luego permitiendo su aplicación con este WS, devuelve valores como código del crédito, Monto del Pago Sugerido, Cuotas que se están pagando, estatus en Linea, etc.

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: "PCrGrPagoGrupal"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/RQCx"
produces:
  - application/json
paths:
  /PCrGrPagoGrupal:
    post:
      tags:
        - PCrGrPagoGrupal
      operationId: "PCrGrPagoGrupal"
      summary: "Web Services para Aplicar un Pago Grupal"
      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: "PCrGrPagoGrupalInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/PCrGrPagoGrupalInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/PCrGrPagoGrupalOutput"

        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 método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
      Delete: Permite el método tipo DELETE
      FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  PCrGrPagoGrupalInput:
    properties:
      CrPagGrTipo:
        description: Tipo de Pago
        type: "integer"
        format: "int32"
      CrPagGrCod:
        description: Código Correlativo de Pago
        type: "integer"
        format: "int64"
      CrPagGrCta:
        description: Numero de Cuenta
        type: "integer"
        format: "int64"
      CrPagGrBol:
        description: Boleta de Pago
        type: "integer"
        format: "int64"
      CrPagGrFec:
        description: Frecuencia de Pago
        type: "string"
        format: "date"
      CrPagGrRef:
        description: Referencia
        type: "string"
      BoletaSelec:
        description: Tipo de Boleta
        type: "integer"
        format: "int64"
      CrPagGrMonto:
        description: Monto del Pago
        type: "number"
        format: "double"
      Detalle:
        description: Detalle Pago Grupal
        type: array
        items:
          $ref: "#/definitions/DetallePagoGrupal_DetallePagoGrupalItem"

  PCrGrPagoGrupalOutput:
    properties:
      CrPagGrCod:
        description: Código Correlativo
        type: "integer"
        format: "int64"
      Detalle:
        description: Detalle Pago Grupal
        type: array
        items:
          $ref: "#/definitions/DetallePagoGrupal_DetallePagoGrupalItem"
      Error:
        description: Código de Error
        type: "integer"
        format: "int32"
      Errores:
        description: Detalles de Errores
        type: "string"
      CrPagGrId:
        description: Correlativo
        type: "integer"
        format: "int64"

  DetallePagoGrupal_DetallePagoGrupalItem:
    properties:
      CrPagGrId:
        description: Correlativo
        type: "integer"
        format: "int64"

      CrPagGrPréstamo:
        description: Numero de Préstamo
        type: "string"

      CrPagGrPrNom:
        description: Nombre Préstamo
        type: "string"

      CrPagGrSugerido:
        description: Monto del Pago Sugerido
        type: "number"
        format: "double"

      CrPagGrCuotas:
        description: Cuotas que esta pagando
        type: "integer"
        format: "int32"

      CrPagGrPago:
        description: Monto del Pago
        type: "number"
        format: "double"

      CrPagGrObservacion:
        description: Observaciones de Pago
        type: "string"

      CrPagGrLinStatus:
        description: Estatus de la Linea
        type: "integer"
        format: "int32"

      CrMoNuMov:
        description: Número del Movimiento Créditos
        type: "integer"
        format: "int64"

      UltimaTransaccion:
        description: Ultimo Número del Movimiento Créditos
        type: "integer"
        format: "int64"

  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"

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 aplicar una Planilla de Pago Grupal en la Aplicación SIFCO WEB..

El siguiente ejemplo permite aplicar una Planilla de Pago Grupal en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/PCrGrPagoGrupal

HEADERS

Code Block

language	json

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

BODY:

Code Block

language	json

{
  "CrPagGrTipo": 0,
  "CrPagGrCod": 0,
  "CrPagGrCta": 0,
  "CrPagGrBol": 0,
  "CrPagGrFec": "2019-10-01",
  "CrPagGrRef": "string",
  "BoletaSelec": 0,
  "CrPagGrMonto": 0,
  "Detalle": [
      {
      "CrPagGrId": 0,
      "CrPagGrPréstamo": "string",
      "CrPagGrPrNom": "string",
      "CrPagGrSugerido": 0,
      "CrPagGrCuotas": 0,
      "CrPagGrPago": 0,
      "CrPagGrObservacion": "string",
      "CrPagGrLinStatus": 0,
      "CrMoNuMov": 0,
      "UltimaTransaccion": 0
      }
    ]
 }

200 (Successful operation)

Operación Exitosa

Code Block

language	json

{
  "CrPagGrCod": 0,
  "Detalle": [
    {
      "CrPagGrId": 0,
      "CrPagGrPréstamo": "string",
      "CrPagGrPrNom": "string",
      "CrPagGrSugerido": 0,
      "CrPagGrCuotas": 0,
      "CrPagGrPago": 0,
      "CrPagGrObservacion": "string",
      "CrPagGrLinStatus": 0,
      "CrMoNuMov": 0,
      "UltimaTransaccion": 0
    }
  ],
  "Error": 0,
  "Errores": "string",
  "CrPagGrId": 0
}

400 (Bad Request).

Solicitud Errada

Code Block

language	json

{
  "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

language	json

{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "Detalle": []
}

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

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Info

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.

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 Créditos, 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

language	json

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.ADVERTENCIAS

Live Search

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 8

New Version Current

Key

DESCRIPCIÓN.

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Artículos Relacionados

Artículos Actualizados Recientemente