Versions Compared

Key

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

DESCRIPCIÓN.

Este Web Service, permite Realizar la Reversiones del Pago de un Crédito en la Aplicación SIFCO WEB. Solo se requiere para ello el código de la transacción o movimiento registrado en la Aplicación SIFCO WEB, referente al Crédito

Swagger open api macroswagger: '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: "WSCrReversiones" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/yAip" produces: - application/json paths: /WSCrReversiones: post: tags: - WSCrReversiones operationId: "WSCrReversiones" summary: "Web Service para Realizar la Reversion de un Pago de un Crédito" 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: "WSCrReversionesInput" in: "body" required: false schema: $ref: "#/definitions/WSCrReversionesInput" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/WSCrReversionesOutput" 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: WSCrReversionesInput: properties: reversion: description: WSCr Reversiones SDT $ref: "#/definitions/WSCrReversionesSDT" WSCrReversionesSDT: properties: NumeroMovimiento: description: Número del Movimiento Créditos type: "integer" format: "int64" WSCrReversionesOutput: properties: result: description: WSCr Reversiones SDT_Result $ref: "#/definitions/WSCrReversionesSDT_Result" WSCrReversionesSDT_Result: properties: NumeroMovimiento: description: Número del Movimiento Créditos type: "integer" format: "int64" Success: description: Exitoso type: "boolean" Descripcion: description: Descripción type: "string" 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 realizar una Cotización de Crédito en la Aplicación SIFCO WEB.

El siguiente ejemplo permite realizar una Cotización de Crédito en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/DemoCoopGT/rest/WSCrCotizador

HEADERS

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

BODY:

Code Block
languagejson
{
    "ApEmpCodigo": 1,
    "ApPrdCod": 3,
    "ApColCod": 2,
    "PreMonOriginal": 1000,
    "PreSpreCorr": 2,
    "PreSpreMora": 0,
    "PrePlazo": 3,
    "PreFacPlazo": 1,
    "PreTipCom": 2,
    "PreFecInicio": "27/10/2020"
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
    "PlanPagos": [
        {
            "Fecha": "2021-01-18",
            "CapitalNumeroCuota": 1,
            "CapitalMonto": "326.49",
            "CapitalAbonado": "0.00",
            "CapitaAtrasado": "N",
            "CapitalPagado": "N",
            "CapitalSaldo": "326.49",
            "InteresNumeroCuota": 1,
            "InteresMonto": "20.83",
            "InteresAbonado": "0.00",
            "InteresAtrasado": "N",
            "InteresPagado": "N",
            "InteresSaldo": "20.83",
            "OtrosMonto": "0.00"
        },
        {
            "Fecha": "2021-02-18",
            "CapitalNumeroCuota": 2,
            "CapitalMonto": "333.29",
            "CapitalAbonado": "0.00",
            "CapitaAtrasado": "N",
            "CapitalPagado": "N",
            "CapitalSaldo": "333.29",
            "InteresNumeroCuota": 2,
            "InteresMonto": "14.03",
            "InteresAbonado": "0.00",
            "InteresAtrasado": "N",
            "InteresPagado": "N",
            "InteresSaldo": "14.03",
            "OtrosMonto": "0.00"
        },
        {
            "Fecha": "2021-03-18",
            "CapitalNumeroCuota": 3,
            "CapitalMonto": "340.22",
            "CapitalAbonado": "0.00",
            "CapitaAtrasado": "N",
            "CapitalPagado": "N",
            "CapitalSaldo": "340.22",
            "InteresNumeroCuota": 3,
            "InteresMonto": "7.09",
            "InteresAbonado": "0.00",
            "InteresAtrasado": "N",
            "InteresPagado": "N",
            "InteresSaldo": "7.09",
            "OtrosMonto": "0.00"
        }
    ],
    "Mensaje": ""
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
    "PlanPagos": [],
    "Mensaje": "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"
  }
}
{
  "result": {}
}

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 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
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" , "creditos" , "reversiones" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History