Versions Compared

Old Version 4

changes.mady.by.user Alfredo Lopez

Saved on

compared with

New Version Current

changes.mady.by.user Alfredo Lopez

Saved on

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), iniciando con 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

para Carga Masiva (Ingreso) de Empleados, según formato definido

de Clientes. 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.

Ademas de utilizar como guía para armar las Listas de Empleados en Formato JSON, los formatos que se obtienen consumiendo el Web Service (WSCargasMasivasFormatosLista), que fueron previamente definidos de forma manual en la Aplicación SIFCO WEB.

Swagger open api macro
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 la 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: "WSCargaMasivaEmpleados"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/AYCt"
produces:
  - application/json
paths:
  /WSCargaMasivaEmpleados:
    post:
      tags:
        - WSCargaMasivaEmpleados
      operationId: "WSCargaMasivaEmpleados"
      summary: "Ejecutar 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
        - name: "WSCargaMasivaEmpleadosInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/WSCargaMasivaEmpleadosInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/WSCargaMasivaEmpleadosOutput"

        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:

  WSCargaMasivaEmpleadosInput:
    properties:
      CargasMasivasAutomaticasFormatoID:
        type: "integer"
        format: "int64"
      CargasMasivasArchivoTipoCarga:
        type: "integer"
        format: "int32"
      CargasMasivasWSCampos_SDT:
        description: Cargas Masivas WSCampos_SDT
        type: array
        items:
          $ref: "#/definitions/CargasMasivasWSCampos_SDT_CargasMasivasWSCampos_Persona"

  CargasMasivasWSCampos_SDT_CargasMasivasWSCampos_Persona:
    properties:
      PersonaCampos:
        type: array
        items:
          description: Campo
          $ref: "#/definitions/CargasMasivasWSCampos_SDT.PersonaCampos"


  CargasMasivasWSCampos_SDT.PersonaCampos:
    properties:
      Valor:
        description: Valor
        type: "string"


    x-gx-level: "CargasMasivasWSCampos_SDT"

  WSCargaMasivaEmpleadosOutput:
    properties:
      Messages:
        description: Messages
        type: array
        items:
          $ref: "#/definitions/Messages_Message"
  
  Messages_Message:
    properties:
      Id:
        description: Id
        type: "string"

      Type:
        description: Type
        type: "integer"
        format: "int32"

      Description:
        description: Description
        type: "string"

  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"

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.

Modelo de Datos de este Web Service

Web Service a Constantes del Sistema Relacionados

CargasMasivasWSCampos_SDT

>PersonaCampos

ClTipPersona

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ApTidCod

WSApTiposIdentificacionLista

ClSexo

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ClEstCivil

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ClImpuestos

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

ClEstado

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

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 la Carga Masiva de Empleados en la Aplicación SIFCO WEB.

El siguiente ejemplo permite la carga de un empleado en la Aplicación SIFCO WEB, que luego debe ser dado de alta como Cliente de forma manual en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/WSCargaMasivaEmpleados

HEADERS:

Code Block
languagejson
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

BODY:

Code Block
languagejson
{
  "CargasMasivasAutomaticasFormatoID": 1,
  "CargasMasivasArchivoTipoCarga": 0,
  "CargasMasivasWSCampos_SDT": [
    {
      "PersonaCampos": [
        {
          "ClTipPersona": "N",
          "ApTidCod" : 1,
          "ClNumID" : "49409384",
          "ClPNombre": "Alfredo",
          "ClSNombre": "Javier",
          "ClPApellido": "Lopez",
          "ClSApellido": "Herize",
          "ClSexo": "M",
          "ClFNacimiento": "1980-03-06",
          "ClEstCivil": 1,
          "ClIdeTrib": "03045803",
          "ClImpuestos": "N",
          "ClEstado": "E",
          "ClReferencia": "string"
        }
      ]
    }
  ]
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
  "Messages": [
        {
          "Id": "CargasMasivas",
          "Type": 0,
          "Description": "Carga Masiva ha sido procesada"
        }
  ],
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "error": {
    "code": "string",
    "message": "string"
  }
}

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) ).

Code Block
languagejson
{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "Messages":[]
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block
languagejson
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
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

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
languagejson
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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" , "carga" , "masivas" , "empleados" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History