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 el Registro o Actualización de Garantías 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

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.atlassian.net/wiki/x/6Qao"
producesorg/sobre-nosotros/"
  contact:
  - application/json pathsemail: "soporte@sifco.org"
 /WSGarantiasCredito license:
    postname: "Apache 2.0"  
  tags:  url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - WSGarantiasCreditohttps
  - http
basePath:  operationId/<APPDIR>/rest
tags:
- name: "WSGarantiasCredito"
  externalDocs:
    summarydescription: "WebManual serviceSIFCO"
para el Registro o Actualización de Garantías de un Crédito"
      parametersurl: "https://sifco.atlassian.net/wiki/x/6Qao"
produces:
  - application/json
paths:
  /WSGarantiasCredito:
    post:
   - in: header  tags:
        name: Content-Type WSGarantiasCredito
         typeoperationId: "stringWSGarantiasCredito"
      summary: "Web service para required:el trueRegistro o Actualización de Garantías de un Crédito"
   default: application/json  parameters:
      -  - in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuthapplication/json
<Access Token>         - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: SmartDeviceOAuth <Access ApplicationToken>
        - in: header
          name: "WSGarantiasCreditoInput"GENEXUS-AGENT
          intype: "bodystring"
          required: falsetrue
          schemadefault: SmartDevice Application
        -  $refname: "#/definitions/WSGarantiasCreditoInput"
       responses:   in: "body"
    200:           descriptionrequired: "Successfulfalse
operation"           schema:
            $ref: "#/definitions/WSGarantiasCreditoOutputWSGarantiasCreditoInput"

      responses:
      401  200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorWSGarantiasCreditoOutput"

       404 401:
          description: "Not foundAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        400404:
          description: "BadNot requestfound"
          schema:
            $ref: "#/definitions/GxJsonError"
        500400:
          description: "InternalBad server errorrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
security        500:
  -  OAuth2: []     ApiKeyAuth1: []
securityDefinitions:description: "Internal server error"
     OAuth2:     typeschema:
oauth2      flow: password     tokenUrl$ref: https:"#//test.sifco.org/DemoCoopGT/oauth/access_token
definitions/GxJsonError"
security:
  - scopesOAuth2: []
     ExecuteApiKeyAuth1: Permite el método tipo GET
[]
securityDefinitions:
  OAuth2:
     Inserttype: Permiteoauth2
el método tipo POST flow: password
    Update: Permite el método tipo PUTtokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      DeleteExecute: Permite el método tipo DELETEGET
      FullControlInsert: Permite el método tipo manejoPOST
de los Cuatro Métodos GET, POST, PUT,DELETE, sobre Update: Permite el Webmétodo Servicetipo PUT
 ApiKeyAuth1:     typeDelete: apiKeyPermite el método tipo DELETE
in: header     nameFullControl: granttypePermite el definitions:manejo de los Cuatro WSGarantiasCreditoInput:Métodos GET, POST, PUT,DELETE, sobre properties:el Web Service
  ApiKeyAuth1:
 Entrada:   type: apiKey
    descriptionin: WSGarantiaheader
 Credito SDT  name: granttype

definitions:

  typeWSGarantiasCreditoInput:
array    properties:
      Entrada:
        description: WSGarantia Credito SDT
        type: array
        items:
          $ref: "#/definitions/WSGarantiaCreditoSDT"

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

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

      CorrelativoGarantia:
        description: Correlativo Garantia
        type: "integer"
        format: "int32"

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

      GaPDescripcion:
        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"
        format: "int64"

      GaPDepCod:  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"
        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 Garantia
          $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": "string",
      "GaPValorGarantia": 0,
      "GaPValorGarantizado": 0,
      "GaPDireccion": "string",
      "GaPPaiCod": 0,
      "GaPRegCod": 0,
      "GaPDepCod": 0,
      "GaPMunCod": 0,
      "GaPCuenta": "string",
      "CamposGarantia": [
        {

description

"CodigoCampo":

Código

0,

Departamento

Garantía

Préstamo

type

"ValorCampo": "

integer

string"

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

"GaPDescripcion":

Número

"string",

de

Cuenta

de

Aportaciones

   "GaPValorGarantia": 0,

type:

string

GaPValorGarantizado": 0,

CamposGarantia

"GaPDireccion": "string",

type

"GaPPaiCod":

array

0,

items

"GaPRegCod": 0,
      "GaPDepCod": 0,

description:

Campo

Garantia

   "GaPMunCod": 0,

$ref

"GaPCuenta": "

#/definitions/WSGarantiaCreditoSDT.CamposGarantia"

string",

WSGarantiaCreditoSDT.

"CamposGarantia": [

properties:

CodigoCampo:

description

"CodigoCampo":

Código

0,

type:

integer" 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 Errores) External Call Out, donde se describe el listado de errores 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
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 5

New Version 6

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 5

New Version 6

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