Herramientas de usuario

Herramientas del sitio


ada:tips:sicoferp:general:pbtows:procesos:inventario:nominamaestros:seccion

¡Esta es una revisión vieja del documento!


Maestro Secciones

Definición

Definición del Componente
Nombre n_ws05_seccion
Descripción Gestiona el maestro de secciones
Proyecto PBws05_seccion
Versión PB 12.5.1
URL SVNhttp://adacsc.co:1443/svn/repository/ADA/SICOF/SICOF%20PBtoWS/Branches/branches%2012.5.2.5.0/05_Nomina/seccion
Librerias PropiasTipo
ws05_seccion.pbl Libreria Lanzadora
sf05controller_seccion.pblLibreria Controladora
sf05model_seccion.pblLibreria Modelo DB
Librerias CoreTipo
sf00core_object.pbl Libreria Core de Objetos Base
sf00core_transaction.pblLibreria Core de control de Transacción DB
sf00core_proxy.pblLibreria de Soporte de Consumos WS - Internos
Requisitos Técnicos
Framework .Net 4.02 o Superior
Servidor Internet Information Server 7.5 o Superior
Sistema Operativo Windows Server 2012 R2
Memoria Ram 8GB
Exposición de Servicio
Tipo Servicio SOAP 1.1 y SOAP 1.2 (.Net Easy SOAP - Generado por Powerbuilder)
URL Recurso http://10.1.40.170:88/ws05_seccion/n_ws05_seccion.asmx
Operaciones Objetivo
ws_listarlista las secciones actuales de la tabla NOMINA.SECCIONES.
ws_insertaringresa un nuevo registro en la tabla NOMINA.SECCIONES.
ws_actualizaractualiza valores en un registro de la tabla NOMINA.SECCIONES.

Contrato de Consumo: WS_LISTAR

Contrato de Consumo
OperaciónObjetivo
ws_listarlista los registros actuales de la tabla NOMINA.SECCIONES.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto1)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datafirstpagIntegerIdentificador de registro inicial de la paginación del consumoSi1
as_datalastpagIntegerIdentificador de registro final de la paginación del consumoSi1
as_dataorderbyStringCadena que contiene las columnas de ordenamiento del consumoNoUtilizado por la DB
as_datawhereStringCadena que contiene la sentencia de filtrado del consumoNoN/A
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_listarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto2)
ws_listarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_listarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_listarResultreturn_technical_messageStringCadena que representa el mensaje técnico de retorno del consumoSiN/A
ws_listarResultreturn_objectStringCadena que representa el objeto de retorno del consumoNoN/A
return_objectalertStringCadena que representa el array de mensajes de alerta de retorno del consumoNoN/A
alertmsgStringCadena que representan una posición del array de mensajes de alerta de retorno del consumoNoN/A
return_objectcolumncountLongValor que representa la cantidad de columnas de la data devuelve en el objeto de consumoNoN/A
return_objectrowcountLongValor que representa la cantidad de filas totales de la data que representa el objeto de consumoNoN/A
return_objectseccionArray ObjectArray de Objetos que representan la data que devuelve el consumoNoN/A
seccionka_nl_seccionLongIdentificador del registroSiN/A
seccionka_ni_centro_costoLongIdentificador del centro de costo de la secciónNoN/A
seccionss_seccionStringDescripción de la secciónSiN/A
seccionusuario_empresaStringusuario de móduloSiN/A
seccioncodigo_mempresaLongCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
seccionrnumLongIdentificador de fila del registroSiAuto incremental por fila
ws_listarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_listarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_listar>
         <!--Optional:-->
         <tem:as_config>
         {"token_session": "d715d7c2d82c20e4237149aa58d2e6b391a619150733c59493cb442dbf1a5940"}
         </tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         </tem:as_data>
      </tem:ws_listar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_listarResponse xmlns="http://tempurl.org">
         <ws_listarResult>{
    "return_code": "1",
    "return_user_message": "consulta de datos existosa",
    "return_technical_message": "consulta de datos existosa",
    "return_object": {
        "alert": [
            {
                "msg": "no se identifica el parametro: firstpag"
            },
            {
                "msg": "no se identifica el parametro: lastpag"
            },
            {
                "msg": "no se identifica el parametro: where"
            },
            {
                "msg": "no se identifica el parametro: orderby"
            }
        ],
        "dataobject": "dsg_seccion",
        "columncount": 6,
        "seccion": [
            {
                "ka_nl_seccion": 1914,
                "ka_ni_centro_costo": 2000,
                "ss_seccion": "GENERICO",
                "usuario_empresa": "NOMINA",
                "codigo_mempresa": "9999999999",
				"rnum": 1
            }
        ],
        "rowcount": 1
    },
    "return_response_date": "25/06/2019 14:13:16",
    "return_execution_time": "531"
}</ws_listarResult>
      </ws_listarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_INSERTAR

Contrato de Consumo
OperaciónObjetivo
ws_insertarAgrega un nuevo registro en la tabla NOMINA.SECCIONES.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto3)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datadatarecordObjeto JsonObjeto que contiene la data a registrarSi1
datarecordka_nl_seccionLongIdentificador del registroSi0
datarecordka_ni_centro_costoLongIdentificador del centro de costo asociadoSi0
datarecordss_seccionStringDescripción de la secciónSiN/A
datarecordcodigo_mempresaLongCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_insertarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto4)
ws_insertarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_insertarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_insertarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_insertarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_insertar>
         {"token_session": "d715d7c2d82c20e4237149aa58d2e6b391a619150733c59493cb442dbf1a5940"}
         <tem:as_config>?</tem:as_config>
         <!--Optional:-->
         <tem:as_data>{"datarecord":{"ka_nl_seccion":0,"ka_ni_centro_costo":3148,"ss_seccion":"GENERICO_006"}}</tem:as_data>
      </tem:ws_insertar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_insertarResponse xmlns="http://tempurl.org">
         <ws_insertarResult>{
    "return_code": "1",
    "return_user_message": "información registrada correctamente.",
    "return_response_date": "21/06/2019 19:36:48",
    "return_execution_time": "906"
}</ws_insertarResult>
      </ws_insertarResponse>
   </soap:Body>
</soap:Envelope>

Contrato de Consumo: WS_ACTUALIZAR

Contrato de Consumo
OperaciónObjetivo
ws_actualizaractualiza un registro en la tabla NOMINA.SECCIONES.
Parámetros de Entrada
NombreTipo de DatosDescripciónFormato Tipo
as_configStringCadena de Configuración del ConsumoJson
as_dataStringCadena que contiene los parámetros del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto5)
as_configtoken_sessionStringCadena que representa el hash de autenticación de acceso al consumoSiN/A
as_datadatarecordObjeto JsonObjeto que contiene la data a actualizarSi1
datarecordka_nl_seccionLongIdentificador del registro a actualizarSiN/A
datarecordss_seccionStringDescripción del motivo de retiroSiN/A
datarecordcodigo_mempresaLongCódigo de la Empresa (Entorno Multiempresa)Si“9999999999”
Parámetros de Retorno
NombreTipo de DatosDescripciónFormato Tipo
ws_actualizarResultStringCadena de retorno del ConsumoJson
Definición Interna
Parámetro EntradaAtributoTipo DatoDescripciónRequeridoValor por Defecto6)
ws_actualizarResultreturn_codeStringCadena que representa el código de retorno del consumo 1: OK -1: ErrorSiN/A
ws_actualizarResultreturn_user_messageStringCadena que representa el mensaje de usuario de retorno del consumoSiN/A
ws_actualizarResultreturn_response_dateDateFecha y hora de ejecución del consumoSifecha y hora del sistema
ws_actualizarResultreturn_execution_timeLongTiempo de ejecución del consumo en milisegundosSi0

Ejemplos

Entrada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:tem="http://tempurl.org">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ws_insertar>
         {"token_session": "d715d7c2d82c20e4237149aa58d2e6b391a619150733c59493cb442dbf1a5940"}
         <tem:as_config>?</tem:as_config>
         <!--Optional:-->
         <tem:as_data>
         {"datarecord":{"ka_nl_seccion":2213,"ss_seccion":"GENERICO_006_3"}}
         </tem:as_data>
      </tem:ws_insertar>
   </soapenv:Body>
</soapenv:Envelope>
Retorno
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <ws_actualizarResponse xmlns="http://tempurl.org">
         <ws_actualizarResult>{
    "return_code": "1",
    "return_user_message": "información actualizada correctamente",
    "return_response_date": "21/06/2019 20:06:07"
}</ws_actualizarResult>
      </ws_actualizarResponse>
   </soap:Body>
</soap:Envelope>

Validaciones

idcodigoDescripción
162CRUD_THE_QUERY_PARAMETER_IS_NOT_IDENTIFIEDno se identifica el parámetro
163CRUD_LIMIT_CONTROL_OF_RECORD_PER_PAGEcontrol de límite de registros por paginación
283CRUD_THERE_PREVIOUSLY_ENTERED_RECORD_IDENTIFIERexiste un registro previamente ingresado con el identificador
381CRUD_INDEFINITE_QUERY_CONFIGURATIONconfiguración de consulta indefinida
402CRUD_INDEFINITE_QUERY_VALIDATIONvalidación de consulta indefinida
403CRUD_INDEFINITE_UPDATE_CONFIGURATIONconfiguración de actualización indefinida
404CRUD_INDEFINITE_UPDATE_VALIDATIONvalidación de actualización indefinida
405CRUD_INDEFINITE_INSERT_VALIDATIONvalidación de inserción indefinida
406CRUD_INDEFINITE_INSERT_CONFIGURATIONconfiguración de inserción indefinida
407CRUD_INDEFINITE_DELETE_VALIDATIONvalidación de eliminacion indefinida
408CRUD_INDEFINITE_DELETE_CONFIGURATIONconfiguración de eliminación indefinida
421CRUD_ROW_NUMBER_IN_UPDATE_IS_NOT_IDENTIFIEDno se identifica el número de fila en la actualización
441CRUD_EMPTY_OR_NULL_FIELDcampo nulo o vacío
461CRUD_THERE_IS_NO_INFORMATION_TO_ELIMINATEno existe información para eliminar
462CRUD_ERROR_WHEN_IDENTIFYING_RECORD_ELIMINATIONerror al identificar registros de la eliminación
501CRUD_CONSUMPTION_OPERATION_IS_NOT_IDENTIFIEDno se identifica la operación crud del consumo
502CRUD_NAME_CAN_NOT_BE_IDENTIFIEDno se puede identifcar el nombre del crud
1) , 2) , 3) , 4) , 5) , 6)
Los valores por defecto son asumidos por el consumo interno
ada/tips/sicoferp/general/pbtows/procesos/inventario/nominamaestros/seccion.1561473821.txt.gz · Última modificación: 2019/06/25 14:43 por edixson.matos