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**, como es Registrar o Modificar un País 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: "TApPais"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/eQDc"
produces:
- application/json
paths:
/TApPais/{ApPaiCod}:
get:
tags:
- TApPais
operationId: "GetTApPais"
summary: "Consultar los Países Registrados en el Sistema"
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: "ApPaiCod"
in: "path"
description: "Código"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TApPais"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Data with the specified key could not be found"
schema:
$ref: "#/definitions/GxJsonError"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/GxJsonError"
post:
tags:
- TApPais
operationId: "InsertTApPais"
summary: "Insertar los Países Registrados en el Sistema"
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: "ApPaiCod"
in: "path"
description: "Código"
required: true
type: "integer"
format: "int64"
- name: "TApPais"
in: "body"
description: "SDT of TApPais"
required: false
schema:
$ref: "#/definitions/TApPais"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TApPais"
201:
description: "Created"
schema:
$ref: "#/definitions/TApPais"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Data with the specified key could not be found"
schema:
$ref: "#/definitions/GxJsonError"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/GxJsonError"
put:
tags:
- TApPais
operationId: "UpdateTApPais"
summary: "Actualizar los Países Registrados en el Sistema"
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: "ApPaiCod"
in: "path"
description: "Código"
required: true
type: "integer"
format: "int64"
- name: "TApPais"
in: "body"
description: "SDT of TApPais"
required: true
schema:
$ref: "#/definitions/TApPais"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TApPais"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Not found"
schema:
$ref: "#/definitions/GxJsonError"
409:
description: "TApPais was changed"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/GxJsonError"
delete:
tags:
- TApPais
operationId: "DeleteTApPais"
summary: "Eliminar los Países Registrados en el Sistema"
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: "ApPaiCod"
in: "path"
description: "Código"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TApPais"
204:
description: "Successful operation"
schema:
$ref: "#/definitions/TApPais"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Not found"
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:
TApPais:
properties:
ApPaiCod:
description: Código
type: "integer"
format: "int64"
ApPaiNombre:
description: País
type: "string"
ApPaiGeo:
description: Geo-Ubicación de País
type: "string"
gx_md5_hash:
description: gx_md5_hash is an identifier for a specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and ignored on insert.
type: "string"
required:
- ApPaiCod
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" |