Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Current »

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

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful 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:

https://test.sifco.org/democoopgt/rest/WSCargaMasivaEmpleados

HEADERS:

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

BODY:

{
  "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

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

400 (Bad Request).

Solicitud Errada

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

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

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

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.

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.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

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

Version Date Comment
Current Version (v. 7) Sept 29, 2019 23:24 Alfredo Lopez
v. 7 Sept 29, 2019 23:24 Alfredo Lopez
v. 6 Sept 24, 2019 17:05 Alfredo Lopez
v. 5 Sept 15, 2019 03:24 Alfredo Lopez
v. 4 Sept 04, 2019 15:26 Alfredo Lopez
v. 3 Sept 04, 2019 15:14 Alfredo Lopez
v. 2 Sept 04, 2019 15:13 Alfredo Lopez
v. 1 Sept 04, 2019 15:11 Alfredo Lopez


  • No labels