DESCRIPCIÓN.
Este Web Service, permite consultar las tasas en la Aplicación SIFCO WEB, las cuales incluyen su información, sus rangos y valores únicos.
...
DESCRIPCIÓN.
Este Web Service, permite consultar las tasas en la Aplicación SIFCO WEB, las cuales incluyen su información, sus rangos y valores únicos.
| 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: "WSApCaptacionProductosLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/PgGo"
produces:
- application/json
paths:
/WSTasasLista:
post:
tags:
- WSTasasLista
operationId: "WSTasasLista"
summary: "WSTasas Lista"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/WSTasasListaOutput"
404:
description: "Not found"
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:
WSTasasListaOutput:
properties:
Tasas:
description: WSTasas
type: array
items:
$ref: "#/definitions/WSTasas_Tasa"
WSTasas_Tasa:
properties:
Codigo:
description: Codigo de Tasa
type: "integer"
format: "int32"
Nombre:
description: Descripción
type: "string"
FormaAplicar:
description: Forma de Aplicar
type: "string"
Tipo:
description: Tipo de Tasa
type: "string"
Valores:
type: array
items:
description: Valor
$ref: "#/definitions/WSTasas.Valores"
Rangos:
type: array
items:
description: Rango
$ref: "#/definitions/WSTasas.Rangos"
WSTasas.Valores:
properties:
FechaVigencia:
description: Fecha Vigencia Tasa
type: "string"
format: "date"
ValorTasa:
description: Valor Tasa Unica por Fecha
type: "number"
format: "double"
x-gx-level: "WSTasas"
WSTasas.Rangos:
properties:
Fecha:
description: Fecha de Rangos de Tasas
type: "string"
format: "date"
Saldos:
type: array
items:
description: Saldo
$ref: "#/definitions/WSTasas.Rangos.Saldos"
x-gx-level: "WSTasas"
WSTasas.Rangos.Saldos:
properties:
SaldoInicial:
description: Saldo Inicial del Rango
type: "number"
format: "double"
SaldoFinal:
description: Saldo Final del Rango
type: "number"
format: "double"
ValorTasa:
description: Valor de Tasa por Rango
type: "number"
format: "double"
x-gx-level: "WSTasas.Rangos"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
type: "string"
message:
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 Obtenerel Listado de las tasas registrados en la Aplicación SIFCO WEB
El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
| ||||||||||
200 (Operación Exitosa) |
| ||||||||||
400 (Solicitud Errada). |
| ||||||||||
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) ). |
| ||||||||||
404 (Not Found). | Respuesta Vacía (Web Service, no encontrado) | ||||||||||
500 (Internal Server Error) (Error Interno del Servidor de las API’s REST). |
|
| 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 |
|---|
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. |