swagger: '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**, el cual permite consultar los Tipos de Documentos de Identificación registrados en la **Aplicación SIFCO WEB**, los mismos puedes aplicar a diferentes tipos de documentos (DNI, Pasaporte, Acta de Constitución, etc) según la figura jurídica del Asociado (Personales, Jurídicas, Cooperativas, etc)."
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: "WSApTiposIdentificacionLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/PYCo"
produces:
- application/json
paths:
/WSApTiposIdentificacionLista:
post:
tags:
- WSApTiposIdentificacionLista
operationId: "WSApTiposIdentificacionLista"
summary: "Lista de Tipos de Documento de Identificacion"
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
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/WSApTiposIdentificacionListaOutput"
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 metodo tipo GET
Insert: Permite el metodo tipo POST
Update: Permite el metodo tipo PUT
Delete: Permite el metodo tipo DELETE
FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
WSApTiposIdentificacionListaOutput:
properties:
TiposIdentificacionLista:
description: WSAp Tipos Identificacion SDT
type: array
items:
$ref: "#/definitions/WSApTiposIdentificacionSDT_TipoIdentificacion"
WSApTiposIdentificacionSDT_TipoIdentificacion:
properties:
CodigoTipoIdentificacion:
description: Tipo de Identificación
type: "integer"
format: "int32"
Descripcion:
description: Nombre de Identificación
type: "string"
URI:
description: URI
type: "string"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
description: Codigo de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError" |