Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite el ingreso al sistemas de clientes (asociados / socios), logrando obtener el formato lista definido por el administrador o usuario de la Aplicación SIFCO WEB, que le permitirá la carga masiva de empleados, estatus previo a convertirse en Cliente de forma manual en la Aplicación SIFCO WEB, tal como esta definido en el Flujograma descrito en la pagina Web Services de Clientes. Este Web Service, solo entrega el formato que ya fue definido en la Aplicación SIFCO WEB, para la carga masiva de empleados, no permite su modificación.
Es importante acotar que para la correcta carga de todos los parámetros de un cliente se deben consumir todos los Web Services de Consulta de Categorías Generales, ademas de revisar las Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB. dado a que ellos les permitan conocer todas las diferentes opciones de parámetros de clientes registrados en la Aplicación SIFCO WEB.
| 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: "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 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:
WSCargasMasivasFormatosListaOutput:
properties:
WSCargasMasivasFormatoDefinicion_SDT:
description: WSCargas Masivas Formato Definició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 Descripció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 Cré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: Código de Error
type: "string"
message:
description: Mensaje de Error
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 el Formato Lista para la Carga Masiva de Empleados en la Aplicación SIFCO WEB.
El siguiente ejemplo permite obtener dicho formato ya cargado manualmente en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
| ||||||||||
200 (Successful operation) Operación Exitosa |
| ||||||||||
400 (Bad Request). 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 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 Clientes, 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. |
| ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Enlaces Relevantes | ||||||||||||
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
| ||||||||||||
|