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 obtener el formato definido por el usuario del sistema para Carga Masiva de Empleados 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: "WSCargasMasivasFormatosLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/EYWo"
produces:
- application/json
paths:
/WSCargasMasivasFormatosLista:
post:
tags:
- WSCargasMasivasFormatosLista
operationId: "WSCargasMasivasFormatosLista"
summary: "Obtener Formato de Cargas Masivas de Empleados"
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/WSCargasMasivasFormatosListaOutput"
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 metodométodo tipo GET
Insert: Permite el metodométodo tipo POST
Update: Permite el metodométodo tipo PUT
Delete: Permite el metodométodo tipo DELETE
FullControl: Permite el manejo de los Cuatro MetodosMétodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
WSCargasMasivasFormatosListaOutput:
properties:
WSCargasMasivasFormatoDefinicion_SDT:
description: WSCargas Masivas Formato DefinicionDefinición_SDT
type: array
items:
$ref: "#/definitions/WSCargasMasivasFormatoDefinicion_SDT_Formato"
WSCargasMasivasFormatoDefinicion_SDT_Formato:
properties:
CargasMasivasFormatoID:
description: Cargas Masivas Formato ID
type: "integer"
format: "int64"
CargasMasivasFormatoNombre:
description: Cargas Masivas Formato Nombre
type: "string"
CargasMasivasFormatoDescripcion:
description: Cargas Masivas Formato DescripcionDescripción
type: "string"
CargasMasivasFormatoTipo:
description: Cargas Masivas Formato Tipo
type: "integer"
format: "int32"
CargasMasivasFormatoTipoCarga:
description: Cargas Masivas Formato Tipo Carga
type: "integer"
format: "int32"
CargasMasivasFormatoCoincidencias:
description: Cargas Masivas Formato Coincidencias
type: "integer"
format: "int32"
CargasMasivasFormatoSeparador:
description: Separador para carga por separador
type: "string"
CargasMasivasFormatoImportarAEmpleados:
description: Cargas Masivas Formato Importar AEmpleados
type: "boolean"
CargasMasivasFormatoImportarActualizarClienteSocio:
description: Cargas Masivas Formato Importar Actualizar Cliente Socio
type: "boolean"
CargasMasivasFormatoImportarActualizarCredito:
description: Cargas Masivas Formato Importar Actualizar CreditoCrédito
type: "boolean"
CargasMasivasFormatoImportarCrearClienteYCuentas:
description: Cargas Masivas Formato Importar Crear Cliente YCuentas
type: "boolean"
FormatoDetalle:
type: array
items:
description: Detalle
$ref: "#/definitions/WSCargasMasivasFormatoDefinicion_SDT.FormatoDetalle"
WSCargasMasivasFormatoDefinicion_SDT.FormatoDetalle:
properties:
CargasMasivasFormatoDetalleColumna:
description: Numero de columna
type: "integer"
format: "int32"
CargasMasivasFormatoDetalleTipoColumna:
description: Tipo de columna, el valor que tomará
type: "integer"
format: "int32"
CargasMasivasFormatoDetalleValorPorDefecto:
description: Valor por defecto si el campo viene vacío o se forza utilizar este valor
type: "string"
CargasMasivasFormatoDetalleEntidad:
description: Entidad a la que aplica la carga masiva
type: "integer"
format: "int32"
CargasMasivasFormatoDetalleFormaBusqueda:
description: Forma en que se buscará si es un campo definido por el usuario
type: "integer"
format: "int32"
CargasMasivasFormatoDetalleAplicaInsert:
description: Se permite insert para el campo
type: "boolean"
CargasMasivasFormatoDetalleAplicaUpdate:
description: Se permite update para el campo
type: "boolean"
CargasMasivasFormatoDetalleCampoNombre:
description: Nombre del campo
type: "string"
CargasMasivasFormatoDetalleCampoDescripcion:
description: Descripcion del campo
type: "string"
CargasMasivasFormatoDetalleDescripcionBuscar:
description: Descripción de lo buscado para carga por correo electrónico
type: "string"
CargasMasivasFormatoDetalleTextoBuscar:
description: Cargas Masivas Formato Detalle Texto Buscar carga por correo electrónico
type: "string"
CargasMasivasFormatoDetalleIndicadorDeBaja:
description: Indica si se da de baja cuando este campo tiene valor
type: "boolean"
x-gx-level: "WSCargasMasivasFormatoDefinicion_SDT"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
description: CodigoCódigo de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError" |