Web Services para el registro o actualización de garantías de un crédito.

Swagger open api macroswagger: '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 Solicitud de Cotización de un Crédito 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: "WSGarantiasCredito" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/9ISo" produces: - application/json paths: /WSGarantiasCredito: post: tags: - WSGarantiasCredito operationId: "WSGarantiasCredito" summary: "Web service para

DESCRIPCIÓN.

Este Web Service, permite Registrar Diferentes Tipos o Modalidades de Garantías para un Crédito en la Aplicación SIFCO WEB, en el se detallan un conjunto de categorías y parámetros como por ejemplo, Valor de Garantía, y Valor Garantizado, ubicación Geográfica por ello se recomienda consumir los Web Service de la Aplicación SIFCO WEB, correspondiente a Web Services de Consulta de Categorías Generales, tal que le permita conocer los parámetros ya existentes en la Aplicación SIFCO WEB, en especial lo de Ubicación Geográfica.

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: "WSGarantiasCredito"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/6Qao"
produces:
  - application/json
paths:
  /WSGarantiasCredito:
    post:
      tags:
        - WSGarantiasCredito
      operationId: "WSGarantiasCredito"
      summary: "Web service para el Registro o Actualización de Garantías 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: "WSGarantiasCreditoInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/WSGarantiasCreditoInput"

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

        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:

  WSGarantiasCreditoInput:
    properties:
      Entrada:
        description: WSGarantia CreditoCrédito SDT
        type: array
        items:
          $ref: "#/definitions/WSGarantiaCreditoSDT"

  WSGarantiasCreditoOutput:
    properties:
      Salida:
        description: WSGarantia CreditoCrédito SDT
        type: array
        items:
          $ref: "#/definitions/WSGarantiaCreditoSDT"

  WSGarantiaCreditoSDT:
    properties:
      Prestamo:
        description: Préstamo
        type: "string"

      CorrelativoGarantia:
        description: Correlativo GarantiaGarantía
        type: "integer"
        format: "int32"

      GaPGarCod:
        description: Código Tipo GarantíaGarantía
        type: "integer"
        format: "int32"

      GaPDescripcion:
        description: Descripción de la Garantía
        type:         description: Descripción de la Garantía
        type: "string"

      GaPValorGarantia:
        description: Valor de Garantía
        type: "number"
        format: "double"

      GaPValorGarantizado:
        description: Valor Garantizado
        type: "number"
        format: "double"

      GaPDireccion:
        description: Dirección de la Garantía
        type: "string"

      GaPPaiCod:
        description: Código País Ubicación Garantía
        type: "integer"
        format: "int64"

      GaPRegCod:
        description: Código Región Garantía Préstamo
        type: "integer"
"string"

      GaPValorGarantia:
        description: Valor de Garantía
        type: "number"
        format: "double"

      GaPValorGarantizado:
        description: Valor Garantizado
        type: "number"
        format: "double"

      GaPDireccion:
        description: Dirección de la Garantía
        type: "string"

      GaPPaiCod:
        description: Código País Ubicación Garantía
        type: "integer"
        format: "int64"

      GaPRegCod:
        description: Código Región Garantía Préstamo
        type: "integer"
        format: "int64"

      GaPDepCod:
        description: Código Departamento Garantía Préstamo
        type: "integer"
        format: "int64"

      GaPMunCod:
        description: Código Municipio Garantía Préstamo
        type: "integer"
        format: "int64"

      GaPCuenta:
        description: Número de Cuenta de Aportaciones
        type: "string"

      CamposGarantia:
        type: array
        items:
          description: Campo Garantía
          $ref: "#/definitions/WSGarantiaCreditoSDT.CamposGarantia"


  WSGarantiaCreditoSDT.CamposGarantia:
    properties:
      CodigoCampo:
        description: Código
        type: "integer"
        format: "int32"

      ValorCampo:
        description: Valor Campo
        type: "string"


    x-gx-level: "WSGarantiaCreditoSDT"
 
  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
WSGarantiasCreditoInput >Entrada >WSGarantiaCreditoSDT
GaPPaiCod	WSApPaisLista
GaPRegCod	WSApDepartamentoLista
GaPDepCod	WSApMunicipioLista

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 registrar diferentes tipos o modalidades de Garantías de Crédito en la Aplicación SIFCO WEB.

El siguiente ejemplo permite cargar un Tipo de Garantía para un Crédito en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

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

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

{
  "Entrada": [
    {
      "Prestamo": "string",
      "CorrelativoGarantia": 0,
      "GaPGarCod": 0,
      "GaPDescripcion": "ELECTRONICA - CRIPTOMONEDAS",
      "GaPValorGarantia": 100000,
      "GaPValorGarantizado": 10000,
      "GaPDireccion": "CASA",
      "GaPPaiCod": 320,
      "GaPRegCod": 1,
      "GaPDepCod": 1,
      "GaPMunCod": 0,
      "GaPCuenta": "string",
      "CamposGarantia": [

format:

"int64"

GaPDepCod:

   "CodigoCampo": 0,

description:

Código

Departamento

Garantía

Préstamo

  "ValorCampo": "string"

type:

"integer"

format:

"int64"

GaPMunCod: description: Código Municipio Garantía Préstamo

]
}

200 (Successful operation)

Operación Exitosa

Code Block

language	json

{
  "Salida": [
    {

type

"Prestamo": "

integer

string"

format:

int64

CorrelativoGarantia": 0,

GaPCuenta

"GaPGarCod": 0,

description: Número de Cuenta de Aportaciones

"GaPDescripcion": "ELECTRONICA - CRIPTOMONEDAS",

type

"GaPValorGarantia": "

string

100000.00",

CamposGarantia

"GaPValorGarantizado": "10000.00",

type

"GaPDireccion":

array

"CASA",

items

"GaPPaiCod": 320,
      "GaPRegCod": 1,

description:

Campo Garantia

    "GaPDepCod": 1,

$ref:

#/definitions/WSGarantiaCreditoSDT.CamposGarantia"

GaPMunCod": 0,

WSGarantiaCreditoSDT.CamposGarantia:

   "GaPCuenta": "string",

properties:

CodigoCampo:

"CamposGarantia": [

description:

Código

type:

integer"

CodigoCampo": 0,

format

"ValorCampo": "

int32

string"

ValorCampo:

 }
      ]

description:

Valor

Campo

type: "string"

]
}

400 (Bad Request).

Solicitud Errada

Code Block

language	json

{
  "error": {

x-gx-level

"code": "

WSGarantiaCreditoSDT

string",

GxJsonError

"message": "string"

properties: error:

}
}

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

$ref: "#/definitions/GxJsonError.error"

"code":"0",

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

 "message":"This service needs an Authorization Header"
  }
}
{
  "Salida": []
}

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"

description: Mensaje de Error type: "string" x-gx-level: "GxJsonError"

}
}

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.

Live Search

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Web Services de Consulta de Categorías Generales

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 2

New Version Current

Key

Web Services para el registro o actualización de garantías de un crédito.

DESCRIPCIÓN.

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

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

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Web Services para el registro o actualización de garantías de un crédito.

DESCRIPCIÓN.

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

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

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente