Herramientas de usuario
ada:howto:sicoferp:factory:integrations:portal.contribuyente:administracionws
Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
|
ada:howto:sicoferp:factory:integrations:portal.contribuyente:administracionws [2021/09/01 14:01] 192.168.177.37 [Descripción del Servicio] |
ada:howto:sicoferp:factory:integrations:portal.contribuyente:administracionws [2021/09/01 17:56] (actual) 192.168.177.37 |
||
|---|---|---|---|
| Línea 7: | Línea 7: | ||
| |Ada|Funcionalidad exponer microservicios para gestión de parámetros|Rest|RESTFull|Java 11.0.315|Nuevo|0.0.1-SNAPSHOT|configuration.properties| | |Ada|Funcionalidad exponer microservicios para gestión de parámetros|Rest|RESTFull|Java 11.0.315|Nuevo|0.0.1-SNAPSHOT|configuration.properties| | ||
| ^Tipo Empaquetado^Gestor de Dependencias^Servidor de Despliegue^IDE Proyecto^Tipo Repositorio^Url Desarrollo^Url Calidad^Url Producción^ | ^Tipo Empaquetado^Gestor de Dependencias^Servidor de Despliegue^IDE Proyecto^Tipo Repositorio^Url Desarrollo^Url Calidad^Url Producción^ | ||
| - | |war|Maven 3.8.2|wildfly-18.0.1.Final|Eclipse 2019-12 (4.14.0)|Subversión |[[http://adacsc.co:1443/svn/repository/ADA/NOTIFICACION_ELECTRONICA/branches/development/enotificacion/administracion|SVN branches]]|[[|SVN trunk]]|[[|SVN tags]]| | + | |war|Maven 3.8.2|wildfly-18.0.1.Final|Eclipse 2019-12 (4.14.0)|Subversión |[[http://adacsc.co:1443/svn/repository/ADA/NOTIFICACION_ELECTRONICA/branches/development/enotificacion/administracion|SVN branches]]|[[|SVN trunk]]|[[http://adacsc.co:1443/svn/repository/ADA/NOTIFICACION_ELECTRONICA/Tags/1.0.0/back-end/development/enotificacion/administracion|SVN tags]]| |
| ^Dependencias^^^^^^^^ | ^Dependencias^^^^^^^^ | ||
| ^groupId^artifactId^^version^scope^optional^Descripción^^ | ^groupId^artifactId^^version^scope^optional^Descripción^^ | ||
| - | |org.springframework.boot|spring-boot-starter-data-jpa||N/A|N/A|N/A|API de persistencia|| | + | |co.ada.enotificacion|comun||0.0.1-SNAPSHOT|N/A|N/A|API de utilidades comunes en el sistema|| |
| - | |org.springframework.boot|spring-boot-starter-web||N/A|N/A|N/A|Core Servicios Web|| | + | |co.ada.enotificacion|administracionNegocio||0.0.1-SNAPSHOT|N/A|N/A|API de utilidades comunes en el sistema|| |
| - | |org.springframework.boot|spring-boot-devtools||N/A|runtime|true|Recarga de aplicaciones|| | + | |commons-discovery|commons-discovery||0.4|N/A|N/A|API de persistencia|| |
| - | |com.oracle.ojdbc|ojdbc8||N/A|runtime|N/A|Driver DB Oracle|| | + | |org.mybatis|mybatis||3.1.1|N/A|N/A|API de persistencia|| |
| - | |org.springframework.boot|spring-boot-starter-test||N/A|test|N/A|Core|| | + | |javax.faces|javax.faces-api||2.3|N/A|N/A|Recarga de aplicaciones|| |
| - | |org.springframework.boot|spring-boot-starter-data-jdbc||N/A|N/A|N/A|API JDBC para conexión a Base de Datos|| | + | |
| - | |org.apache.tomcat.embed|tomcat-embed-jasper||N/A|provided|N/A|Servidor embebido tomcat|| | + | |
| - | |org.springframework.boot|spring-boot-starter-tomcat||N/A|provided|N/A|Core tomcat|| | + | |
| - | |org.apache.maven.plugins|maven-compiler-plugin||3.8.1|N/A|N/A|Gestor de dependencias|| | + | |
| - | |io.springfox|springfox-swagger2||2.9.2|N/A|N/A|Core Documentación Web Services RESTful|| | + | |
| - | |io.springfox|springfox-swagger-ui||2.9.2|N/A|N/A|GUI Documentación Web Services RESTful|| | + | |
| ^Operaciones^^^^^^^^ | ^Operaciones^^^^^^^^ | ||
| ^Tipo Petición Http^Nombre operación^^Descripción^^^Documentación^^ | ^Tipo Petición Http^Nombre operación^^Descripción^^^Documentación^^ | ||
| Línea 39: | Línea 33: | ||
| ^Ambientes de Despliegue^^^^^^^^ | ^Ambientes de Despliegue^^^^^^^^ | ||
| ^Tipo^Url^^Observaciones^^^^^ | ^Tipo^Url^^Observaciones^^^^^ | ||
| - | |Desarrollo:|http://10.1.140.20:8001/ ||Ambiente de desarrollo||||| | + | |Desarrollo:| http://10.1.140.1:42002/ ||Ambiente de desarrollo||||| |
| - | |Calidad:| ||Ambiente de validación||||| | + | |Calidad:| http://10.1.140.1:42002/ ||Ambiente de validación||||| |
| |Producción:| ||Ambiente de producción||||| | |Producción:| ||Ambiente de producción||||| | ||
| Línea 47: | Línea 41: | ||
| ==== Contrato de Servicio ==== | ==== Contrato de Servicio ==== | ||
| A continuación se presenta el contrato de servicio con las operaciones implementadas. La documentación está realizada en el estandar [[https://spec.openapis.org/oas/v3.1.0|OpenAPI V3.0.1]]. Para visualizar la documentación (Vista html) copie el código [[https://yaml.org/spec/1.2/spec.html|Yaml]] en un visor [[https://editor.swagger.io/|Swagger]]. | A continuación se presenta el contrato de servicio con las operaciones implementadas. La documentación está realizada en el estandar [[https://spec.openapis.org/oas/v3.1.0|OpenAPI V3.0.1]]. Para visualizar la documentación (Vista html) copie el código [[https://yaml.org/spec/1.2/spec.html|Yaml]] en un visor [[https://editor.swagger.io/|Swagger]]. | ||
| - | |||
| - | Para más información acerca de la estructura de los campos, puede consultar el [[http://10.1.20.89/doku.php?id=ada:howto:sicoferp:factory:logmodels|Diccionario de datos]] | ||
| <code yaml> | <code yaml> | ||
| openapi: 3.0.1 | openapi: 3.0.1 | ||
| info: | info: | ||
| - | title: Service Log | + | title: Servicio Portal del Contribuyente |
| contact: | contact: | ||
| name: ADA.S.A | name: ADA.S.A | ||
| Línea 60: | Línea 52: | ||
| license: | license: | ||
| name: Apache License Version 2.0 | name: Apache License Version 2.0 | ||
| - | version: "1.0" | + | version: '1.0' |
| servers: | servers: | ||
| - | - url: //10.1.140.20:8001/ | + | - url: //10.1.140.1:42002/ |
| tags: | tags: | ||
| - | - name: file-upload-log-controller | + | - name: administracion-ws |
| - | description: File Upload Log Controller | + | description: Gestor de usuarios y parámetros |
| - | - name: mov-log-errores-controller | + | - name: portal-ws |
| - | description: Mov Log Errores Controller | + | description: Gestor core del portal, sesiones, consultas, pagos en línea |
| - | - name: session-log-app | + | - name: notificacion-ws |
| - | description: Session Log App | + | description: Gestor de transacciones masivas entre el cliente y el portal |
| - | - name: transactional-log-app | + | - name: registro-ws |
| - | description: Transactional Log App | + | description: Gestor del registro de usuarios al sistema |
| paths: | paths: | ||
| - | /error/getRegisters: | + | /administracionws/consulta/parametros/todos/: |
| get: | get: | ||
| tags: | tags: | ||
| - | - mov-log-errores-controller | + | - administracion-ws |
| - | summary: getRegisters | + | summary: obtenerListadoParametros |
| - | operationId: getRegistersUsingGET_1 | + | operationId: obtenerListadoParametrosGET |
| parameters: | parameters: | ||
| - | - name: codigoInterno | + | - name: authorization |
| - | in: query | + | in: header |
| - | description: codigoInterno | + | required: true |
| - | schema: | + | description: token de la aplicación |
| - | type: integer | + | schema: |
| - | format: int32 | + | type: string |
| - | default: 0 | + | |
| - | - name: codOracle | + | |
| - | in: query | + | |
| - | description: codOracle | + | |
| - | schema: | + | |
| - | type: integer | + | |
| - | format: int32 | + | |
| - | default: 0 | + | |
| - | - name: msjOracle | + | |
| - | in: query | + | |
| - | description: msjOracle | + | |
| - | schema: | + | |
| - | type: string | + | |
| - | default: "0" | + | |
| - | - name: nomPrecedimiento | + | |
| - | in: query | + | |
| - | description: nomPrecedimiento | + | |
| - | schema: | + | |
| - | type: string | + | |
| - | default: "0" | + | |
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| type: array | type: array | ||
| items: | items: | ||
| - | $ref: '#/components/schemas/MovLogErrores' | + | $ref: '#/components/schemas/Parametros' |
| - | 401: | + | '204': |
| - | description: Unauthorized | + | description: NoContent |
| - | content: {} | + | |
| - | 403: | + | |
| - | description: Forbidden | + | |
| - | content: {} | + | |
| - | 404: | + | |
| - | description: Not Found | + | |
| - | content: {} | + | |
| - | /error/save: | + | |
| - | post: | + | |
| - | tags: | + | |
| - | - mov-log-errores-controller | + | |
| - | summary: save | + | |
| - | operationId: saveUsingPOST | + | |
| - | requestBody: | + | |
| - | description: sessionLog | + | |
| - | content: | + | |
| - | application/json: | + | |
| - | schema: | + | |
| - | $ref: '#/components/schemas/MovLogErrores' | + | |
| - | required: true | + | |
| - | responses: | + | |
| - | 200: | + | |
| - | description: OK | + | |
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| - | type: integer | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | format: int32 | + | '401': |
| - | 201: | + | |
| - | description: Created | + | |
| - | content: {} | + | |
| - | 401: | + | |
| description: Unauthorized | description: Unauthorized | ||
| - | content: {} | + | content: |
| - | 403: | + | application/json: |
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | x-codegen-request-body-name: sessionLog | + | '500': |
| - | /error/{id}/getRegister: | + | description: Internal Server Error |
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /administracionws/consulta/aplicaciones/todos/: | ||
| get: | get: | ||
| tags: | tags: | ||
| - | - mov-log-errores-controller | + | - administracion-ws |
| - | summary: getRegisterById | + | summary: obtenerListadoAplicaciones |
| - | operationId: getRegisterByIdUsingGET | + | operationId: obtenerListadoAplicacionesGET |
| parameters: | parameters: | ||
| - | - name: id | + | - name: authorization |
| - | in: path | + | in: header |
| - | description: id | + | required: true |
| - | required: true | + | description: token de la aplicación |
| - | schema: | + | schema: |
| - | type: string | + | type: string |
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| - | $ref: '#/components/schemas/MovLogErrores' | + | type: array |
| - | 401: | + | items: |
| + | $ref: '#/components/schemas/Aplicaciones' | ||
| + | '204': | ||
| + | description: NoContent | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '401': | ||
| description: Unauthorized | description: Unauthorized | ||
| - | content: {} | + | content: |
| - | 403: | + | application/json: |
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | /session/getRegisters: | + | '500': |
| + | description: Internal Server Error | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /administracionws/consulta/usuarios/todos/: | ||
| get: | get: | ||
| tags: | tags: | ||
| - | - session-log-app | + | - administracion-ws |
| - | summary: getRegisters | + | summary: obtenerListadoUsuarios |
| - | operationId: getRegistersUsingGET_2 | + | operationId: obtenerListadoUsuariosGET |
| parameters: | parameters: | ||
| - | - name: codigoAplicacion | + | - name: authorization |
| - | in: query | + | in: header |
| - | description: codigoAplicacion | + | required: true |
| - | schema: | + | description: token de la aplicación |
| - | type: integer | + | schema: |
| - | format: int64 | + | type: string |
| - | - name: codigoDependencia | + | |
| - | in: query | + | |
| - | description: codigoDependencia | + | |
| - | schema: | + | |
| - | type: integer | + | |
| - | format: int64 | + | |
| - | - name: codigoUsuario | + | |
| - | in: query | + | |
| - | description: codigoUsuario | + | |
| - | schema: | + | |
| - | type: integer | + | |
| - | format: int64 | + | |
| - | - name: id | + | |
| - | in: query | + | |
| - | description: id | + | |
| - | schema: | + | |
| - | type: string | + | |
| - | - name: nitEmpresa | + | |
| - | in: query | + | |
| - | description: nitEmpresa | + | |
| - | schema: | + | |
| - | type: integer | + | |
| - | format: int64 | + | |
| - | - name: tipoRegistro | + | |
| - | in: query | + | |
| - | description: tipoRegistro | + | |
| - | schema: | + | |
| - | type: string | + | |
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| type: array | type: array | ||
| items: | items: | ||
| - | $ref: '#/components/schemas/SessionLog' | + | $ref: '#/components/schemas/Usuarios' |
| - | 401: | + | '204': |
| + | description: NoContent | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '401': | ||
| description: Unauthorized | description: Unauthorized | ||
| - | content: {} | + | content: |
| - | 403: | + | application/json: |
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | /session/save: | + | '500': |
| - | post: | + | description: Internal Server Error |
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /portalws/login/: | ||
| + | get: | ||
| tags: | tags: | ||
| - | - session-log-app | + | - portal-ws |
| - | summary: saveSessionLog | + | summary: login |
| - | operationId: saveSessionLogUsingPOST_1 | + | operationId: loginGET |
| - | requestBody: | + | parameters: |
| - | description: sessionLog | + | - name: authorization |
| - | content: | + | in: header |
| - | application/json: | + | required: true |
| - | schema: | + | description: Nombre del path del cliente, según el valor en la tabla aplicacion |
| - | $ref: '#/components/schemas/SessionLog' | + | schema: |
| - | required: true | + | type: string |
| + | - name: usuario | ||
| + | in: header | ||
| + | required: true | ||
| + | description: Cuenta de correo del usuario o nickname | ||
| + | schema: | ||
| + | type: string | ||
| + | - name: password | ||
| + | in: header | ||
| + | required: true | ||
| + | description: Contraseña de la cuenta de usuario | ||
| + | schema: | ||
| + | type: string | ||
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| - | content: | + | headers: |
| - | '*/*': | + | authorization: |
| + | description: Token de sesión del usuario | ||
| schema: | schema: | ||
| type: string | type: string | ||
| - | 201: | + | authorization_app: |
| - | description: Created | + | description: Token de la aplicación asociada al path recibido en el request |
| - | content: {} | + | schema: |
| - | 401: | + | type: string |
| - | description: Unauthorized | + | content: |
| - | content: {} | + | application/json: |
| - | 403: | + | schema: |
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | x-codegen-request-body-name: sessionLog | + | '500': |
| - | /session/{id}: | + | description: Internal Server Error |
| - | put: | + | content: |
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /portalws/factura/: | ||
| + | post: | ||
| tags: | tags: | ||
| - | - session-log-app | + | - portal-ws |
| - | summary: updateRegister | + | summary: consultaFacturasPortalContribuyente |
| - | operationId: updateRegisterUsingPUT | + | operationId: consultaFacturasPortalContribuyentePOST |
| - | parameters: | + | |
| - | - name: id | + | |
| - | in: path | + | |
| - | description: id | + | |
| - | required: true | + | |
| - | schema: | + | |
| - | type: string | + | |
| requestBody: | requestBody: | ||
| - | description: sessionLog | + | description: Parámetros de consulta |
| content: | content: | ||
| application/json: | application/json: | ||
| schema: | schema: | ||
| - | $ref: '#/components/schemas/SessionLog' | + | $ref: '#/components/schemas/ConsultaInformacion' |
| - | required: true | + | |
| - | responses: | + | |
| - | 200: | + | |
| - | description: OK | + | |
| - | content: | + | |
| - | '*/*': | + | |
| - | schema: | + | |
| - | $ref: '#/components/schemas/SessionLog' | + | |
| - | 201: | + | |
| - | description: Created | + | |
| - | content: {} | + | |
| - | 401: | + | |
| - | description: Unauthorized | + | |
| - | content: {} | + | |
| - | 403: | + | |
| - | description: Forbidden | + | |
| - | content: {} | + | |
| - | 404: | + | |
| - | description: Not Found | + | |
| - | content: {} | + | |
| - | x-codegen-request-body-name: sessionLog | + | |
| - | /transactional/getRegisters: | + | |
| - | get: | + | |
| - | tags: | + | |
| - | - transactional-log-app | + | |
| - | summary: getRegisters | + | |
| - | operationId: getRegistersUsingGET_3 | + | |
| parameters: | parameters: | ||
| - | - name: codigoUsuario | + | - name: authorization |
| - | in: query | + | in: header |
| - | description: codigoUsuario | + | required: true |
| - | schema: | + | description: Token de aplicacion |
| - | type: integer | + | schema: |
| - | format: int64 | + | type: string |
| - | - name: id | + | |
| - | in: query | + | |
| - | description: id | + | |
| - | schema: | + | |
| - | type: integer | + | |
| - | format: int64 | + | |
| - | - name: logColumn | + | |
| - | in: query | + | |
| - | description: logColumn | + | |
| - | schema: | + | |
| - | type: string | + | |
| - | - name: logTabla | + | |
| - | in: query | + | |
| - | description: logTabla | + | |
| - | schema: | + | |
| - | type: string | + | |
| - | - name: nitEmpresa | + | |
| - | in: query | + | |
| - | description: nitEmpresa | + | |
| - | schema: | + | |
| - | type: integer | + | |
| - | format: int64 | + | |
| - | - name: nombreProceso | + | |
| - | in: query | + | |
| - | description: nombreProceso | + | |
| - | schema: | + | |
| - | type: string | + | |
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| + | headers: | ||
| + | authorization: | ||
| + | description: Token de sesión del usuario | ||
| + | schema: | ||
| + | type: string | ||
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| type: array | type: array | ||
| items: | items: | ||
| - | $ref: '#/components/schemas/TransactionalLog' | + | $ref: '#/components/schemas/TipoNotificacionRespuestas' |
| - | 401: | + | '204': |
| - | description: Unauthorized | + | description: No Content |
| - | content: {} | + | content: |
| - | 403: | + | application/json: |
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | /transactional/save: | + | '500': |
| + | description: Internal Server Error | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /portalws/acuerdos/: | ||
| post: | post: | ||
| tags: | tags: | ||
| - | - transactional-log-app | + | - portal-ws |
| - | summary: saveTransactional | + | summary: consultaAcuerdosPortalContribuyente |
| - | operationId: saveTransactionalUsingPOST | + | operationId: consultaAcuerdosPortalContribuyentePOST |
| requestBody: | requestBody: | ||
| - | description: log | + | description: Parámetros de consulta |
| content: | content: | ||
| application/json: | application/json: | ||
| schema: | schema: | ||
| - | $ref: '#/components/schemas/TransactionalLog' | + | $ref: '#/components/schemas/ConsultaInformacion' |
| - | required: true | + | parameters: |
| + | - name: authorization | ||
| + | in: header | ||
| + | required: true | ||
| + | description: Token de aplicacion | ||
| + | schema: | ||
| + | type: string | ||
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| - | content: | + | headers: |
| - | '*/*': | + | authorization: |
| + | description: Token de sesión del usuario renovado | ||
| schema: | schema: | ||
| type: string | type: string | ||
| - | 201: | + | content: |
| - | description: Created | + | application/json: |
| - | content: {} | + | schema: |
| - | 401: | + | type: array |
| - | description: Unauthorized | + | items: |
| - | content: {} | + | $ref: '#/components/schemas/TipoNotificacionRespuestas' |
| - | 403: | + | '204': |
| + | description: No Content | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | x-codegen-request-body-name: log | + | '500': |
| - | /transactional/{id}/getRegister: | + | description: Internal Server Error |
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /portalws/descargar/{authorization}/{authorization2}/{fuente}/{tipo_doc}: | ||
| get: | get: | ||
| tags: | tags: | ||
| - | - transactional-log-app | + | - portal-ws |
| - | summary: getRegisterById | + | summary: descargarDocumento |
| - | operationId: getRegisterByIdUsingGET_1 | + | operationId: descargarDocumentoGET |
| parameters: | parameters: | ||
| - | - name: id | + | - name: authorization |
| - | in: path | + | in: path |
| - | description: id | + | required: true |
| - | required: true | + | description: token de sesión de usuario |
| - | schema: | + | schema: |
| - | type: integer | + | type: string |
| - | format: int64 | + | - name: authorization2 |
| + | in: path | ||
| + | required: true | ||
| + | description: token de único del documento | ||
| + | schema: | ||
| + | type: string | ||
| + | - name: fuente | ||
| + | in: path | ||
| + | required: true | ||
| + | description: token de único del documento | ||
| + | schema: | ||
| + | type: string | ||
| + | - name: tipo_doc | ||
| + | in: path | ||
| + | required: true | ||
| + | description: >- | ||
| + | Indica si el documento es un paz y salvo (pyz) o un documento de | ||
| + | cobro (fact) | ||
| + | schema: | ||
| + | type: string | ||
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| + | headers: | ||
| + | authorization: | ||
| + | description: Token de sesión del usuario renovado | ||
| + | schema: | ||
| + | type: string | ||
| content: | content: | ||
| - | '*/*': | + | application/pdf: |
| schema: | schema: | ||
| - | $ref: '#/components/schemas/TransactionalLog' | + | type: object |
| - | 401: | + | '204': |
| - | description: Unauthorized | + | description: NoContent |
| - | content: {} | + | content: |
| - | 403: | + | application/json: |
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | /upload/getRegisters: | + | '500': |
| + | description: Internal Server Error | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /portalws/seguridad/cambio/solicitud/: | ||
| get: | get: | ||
| tags: | tags: | ||
| - | - file-upload-log-controller | + | - portal-ws |
| - | summary: getRegisters | + | summary: solicitarCambiarContrasenia |
| - | operationId: getRegistersUsingGET | + | operationId: solicitarCambiarContraseniaGET |
| parameters: | parameters: | ||
| - | - name: id | + | - name: authorization |
| - | in: query | + | in: header |
| - | description: id | + | required: true |
| - | schema: | + | description: token de sesión de usuario |
| - | type: integer | + | schema: |
| - | format: int32 | + | type: string |
| - | default: 0 | + | - name: usuario |
| - | - name: nombreArchivo | + | in: header |
| - | in: query | + | required: true |
| - | description: nombreArchivo | + | description: correo electrónico o nickname |
| - | schema: | + | schema: |
| - | type: integer | + | type: string |
| - | format: int32 | + | |
| - | default: 0 | + | |
| - | - name: nombreProceso | + | |
| - | in: query | + | |
| - | description: nombreProceso | + | |
| - | schema: | + | |
| - | type: string | + | |
| - | default: "0" | + | |
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| + | headers: | ||
| + | authorization: | ||
| + | description: Token de sesión del usuario renovado | ||
| + | schema: | ||
| + | type: string | ||
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| - | type: array | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | items: | + | '204': |
| - | $ref: '#/components/schemas/FileUploadLog' | + | description: NoContent |
| - | 401: | + | content: |
| - | description: Unauthorized | + | application/json: |
| - | content: {} | + | schema: |
| - | 403: | + | $ref: '#/components/schemas/EstadoTransaccion' |
| + | '403': | ||
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | /upload/save: | + | '500': |
| - | post: | + | description: Internal Server Error |
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| + | /portalws/seguridad/cambio/completar/: | ||
| + | get: | ||
| tags: | tags: | ||
| - | - file-upload-log-controller | + | - portal-ws |
| - | summary: saveSessionLog | + | summary: cambiarContrasenia |
| - | operationId: saveSessionLogUsingPOST | + | operationId: cambiarContraseniaGET |
| - | requestBody: | + | parameters: |
| - | description: sessionLog | + | - name: authorization |
| - | content: | + | in: header |
| - | application/json: | + | required: true |
| - | schema: | + | description: token de sesión de usuario |
| - | $ref: '#/components/schemas/FileUploadLog' | + | schema: |
| - | required: true | + | type: string |
| + | - name: password | ||
| + | in: header | ||
| + | required: true | ||
| + | description: nuevo password | ||
| + | schema: | ||
| + | type: string | ||
| responses: | responses: | ||
| - | 200: | + | '200': |
| description: OK | description: OK | ||
| + | headers: | ||
| + | authorization: | ||
| + | description: Token de sesión del usuario renovado | ||
| + | schema: | ||
| + | type: string | ||
| content: | content: | ||
| - | '*/*': | + | application/json: |
| schema: | schema: | ||
| - | type: integer | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | format: int32 | + | '204': |
| - | 201: | + | description: NoContent |
| - | description: Created | + | content: |
| - | content: {} | + | application/json: |
| - | 401: | + | schema: |
| - | description: Unauthorized | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | content: {} | + | '403': |
| - | 403: | + | |
| description: Forbidden | description: Forbidden | ||
| - | content: {} | + | content: |
| - | 404: | + | application/json: |
| - | description: Not Found | + | schema: |
| - | content: {} | + | $ref: '#/components/schemas/EstadoTransaccion' |
| - | x-codegen-request-body-name: sessionLog | + | '500': |
| + | description: Internal Server Error | ||
| + | content: | ||
| + | application/json: | ||
| + | schema: | ||
| + | $ref: '#/components/schemas/EstadoTransaccion' | ||
| components: | components: | ||
| schemas: | schemas: | ||
| - | FileUploadLog: | + | Parametros: |
| - | title: FileUploadLog | + | title: Parametros |
| type: object | type: object | ||
| properties: | properties: | ||
| - | codigoAplicacion: | + | error: |
| - | type: integer | + | type: boolean |
| - | format: int32 | + | codigoMensaje: |
| - | codigoMEmpresa: | + | |
| type: string | type: string | ||
| - | codigoUsuario: | + | mensaje: |
| + | type: string | ||
| + | totalRegistros: | ||
| type: integer | type: integer | ||
| - | format: int32 | + | payload: |
| - | columnaGrupo: | + | type: array |
| + | items: | ||
| + | $ref: '#/components/schemas/Parametro' | ||
| + | Aplicaciones: | ||
| + | title: Aplicaciones | ||
| + | type: object | ||
| + | properties: | ||
| + | error: | ||
| + | type: boolean | ||
| + | codigoMensaje: | ||
| type: string | type: string | ||
| - | fecha: | + | mensaje: |
| type: string | type: string | ||
| - | format: date-time | + | totalRegistros: |
| - | fechaRegistro: | + | type: integer |
| + | payload: | ||
| + | type: array | ||
| + | items: | ||
| + | $ref: '#/components/schemas/Aplicacion' | ||
| + | Usuarios: | ||
| + | title: Usuarios | ||
| + | type: object | ||
| + | properties: | ||
| + | error: | ||
| + | type: boolean | ||
| + | codigoMensaje: | ||
| type: string | type: string | ||
| - | format: date-time | + | mensaje: |
| - | hostCliente: | + | |
| type: string | type: string | ||
| - | id: | + | totalRegistros: |
| type: integer | type: integer | ||
| - | format: int32 | + | payload: |
| - | infoApp: | + | type: array |
| + | items: | ||
| + | $ref: '#/components/schemas/Usuario' | ||
| + | TipoNotificacionRespuestas: | ||
| + | title: TipoNotificacionRespuestas | ||
| + | type: object | ||
| + | properties: | ||
| + | error: | ||
| + | type: boolean | ||
| + | codigoMensaje: | ||
| + | type: string | ||
| + | mensaje: | ||
| type: string | type: string | ||
| - | nitEmpresa: | + | totalRegistros: |
| + | type: integer | ||
| + | payload: | ||
| + | type: array | ||
| + | items: | ||
| + | $ref: '#/components/schemas/TipoNotificacionRespuesta' | ||
| + | Parametro: | ||
| + | title: Parametro | ||
| + | type: object | ||
| + | properties: | ||
| + | id: | ||
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | nombreArchivo: | + | description: Identificador del registro |
| + | nombre: | ||
| type: string | type: string | ||
| - | nombreProceso: | + | description: Nombre del parámetro |
| + | tipo: | ||
| type: string | type: string | ||
| - | notificacion: | + | description: Tipo de parámetro |
| + | valor: | ||
| type: string | type: string | ||
| - | numeroLinea: | + | description: Valor del parámetro |
| - | type: integer | + | descripcion: |
| - | format: int32 | + | |
| - | sessionBrowserVersion: | + | |
| - | type: string | + | |
| - | sessionMac: | + | |
| - | type: string | + | |
| - | sessionOstype: | + | |
| type: string | type: string | ||
| - | MovLogErrores: | + | description: Descripción del parámetro |
| - | title: MovLogErrores | + | idAplicacion: |
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Identificador de la aplicación propietaria del parámetro | ||
| + | Aplicacion: | ||
| + | title: Aplicacion | ||
| type: object | type: object | ||
| properties: | properties: | ||
| - | codRacle: | + | id: |
| type: integer | type: integer | ||
| - | format: int32 | + | format: int64 |
| - | codigoAplicacion: | + | description: Identificador del registro |
| + | nombre: | ||
| type: string | type: string | ||
| - | codigoEmpresa: | + | description: Nombre de la aplicación o cliente |
| + | token: | ||
| type: string | type: string | ||
| - | codigoInterno: | + | fechaVigencia: |
| - | type: integer | + | |
| - | format: int32 | + | |
| - | codigoUsuario: | + | |
| - | type: integer | + | |
| - | format: int64 | + | |
| - | errorLog: | + | |
| type: string | type: string | ||
| - | errorType: | + | format: date |
| + | description: Fecha hasta la que estará vigente el acceso del cliente al portal | ||
| + | esInterna: | ||
| type: string | type: string | ||
| - | fecha: | + | description: Indica si la aplicación es interna o del sistema S o es un cliente N |
| + | estado: | ||
| type: string | type: string | ||
| - | format: date-time | + | description: >- |
| - | fechaRegistro: | + | Indica el estado de la aplicación A, I o S (Activa, Inactiva o |
| + | Suspendida) | ||
| + | Usuario: | ||
| + | title: Usuario | ||
| + | type: object | ||
| + | properties: | ||
| + | id: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Identificador del registro | ||
| + | numeroDocumento: | ||
| type: string | type: string | ||
| - | format: date-time | + | description: Número de documento del usuario |
| - | hostCliente: | + | nombre: |
| type: string | type: string | ||
| - | infoApp: | + | description: Nombre del usuario |
| + | correoElectronico: | ||
| type: string | type: string | ||
| - | msjRacle: | + | description: Correo electrónico del usuario. Nickname de la cuenta de usuario |
| + | direccion: | ||
| type: string | type: string | ||
| - | nitEmpresa: | + | description: Dirección física del usuario |
| - | type: integer | + | telefono: |
| - | format: int64 | + | |
| - | nomProcedimiento: | + | |
| type: string | type: string | ||
| - | observacion: | + | description: Número telefónico principal del usuario |
| + | telefonoAlterno: | ||
| type: string | type: string | ||
| - | sessionBrowserVersion: | + | description: Número telefónico alterno del usuario |
| + | token: | ||
| type: string | type: string | ||
| - | sessionMac: | + | ultimoIngreso: |
| type: string | type: string | ||
| - | sessionOstype: | + | format: date-time |
| + | description: Fecha del último ingreso del usuario al sistema | ||
| + | tokenVigencia: | ||
| type: string | type: string | ||
| - | usuarioBD: | + | format: date-time |
| + | description: Fecha de vigencia del token de sesión | ||
| + | aceptaNotificacionElectronica: | ||
| + | type: boolean | ||
| + | description: Indica si el usuario recibe notificaciones elctrónicas | ||
| + | estado: | ||
| type: string | type: string | ||
| - | SessionLog: | + | description: Indica el estado del usuario P, *, -, M, D, I, A, S, Z, R, V, O, B |
| - | title: SessionLog | + | TipoNotificacionRespuesta: |
| + | title: TipoNotificacionRespuesta | ||
| type: object | type: object | ||
| properties: | properties: | ||
| - | codigoAplicacion: | + | id: |
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | codigoDependencia: | + | description: Identificador del registro |
| + | urlPago: | ||
| + | type: string | ||
| + | format: url | ||
| + | description: URL de la pasarela de pagos en línea | ||
| + | respuestas: | ||
| + | type: array | ||
| + | items: | ||
| + | $ref: '#/components/schemas/ConsultaInformacionRespuesta' | ||
| + | ConsultaInformacionRespuesta: | ||
| + | title: ConsultaInformacionRespuesta | ||
| + | type: object | ||
| + | properties: | ||
| + | id: | ||
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | codigoEmpresa: | + | description: Identificador del registro |
| - | type: number | + | consecutivo: |
| - | format: double | + | |
| - | codigoUsuario: | + | |
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | fechaLogout: | + | description: Consecutivo del documento de cobro |
| + | idDocumento: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Identificador del documento de cobro (id factura) | ||
| + | idTipoNotificacion: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Identificador del tipo de documento | ||
| + | idFormaPago: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Identificador de la forma de pago | ||
| + | formaPago: | ||
| type: string | type: string | ||
| - | format: date-time | + | description: Forma de pago |
| - | fechaRegistro: | + | valor: |
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor del documento de cobro | ||
| + | fechaElaboracion: | ||
| type: string | type: string | ||
| - | format: date-time | + | format: date |
| - | fechaSessionActiva: | + | description: Fecha de elaboración del documento de cobro |
| + | fechaVencimiento: | ||
| type: string | type: string | ||
| - | format: date-time | + | format: date |
| - | id: | + | description: Fecha de vencimiento del documento de cobro |
| + | token: | ||
| type: string | type: string | ||
| - | nitEmpresa: | + | description: Token generado para la identificación segura del documento |
| - | type: integer | + | objeto: |
| - | format: int64 | + | |
| - | sessionBrowserVersion: | + | |
| type: string | type: string | ||
| - | sessionId: | + | description: >- |
| + | Identificador del objeto conocido por el usuario (cédula catastral, | ||
| + | placa, línea teleónica, etc.) | ||
| + | estado: | ||
| type: string | type: string | ||
| - | sessionMac: | + | description: Estado del documento de cobro (cancelado, pendiente de pago, etc.) |
| + | vigencia: | ||
| type: string | type: string | ||
| - | sessionOsType: | + | description: Vigencia del documento de cobro, formato yyyy |
| + | icono: | ||
| type: string | type: string | ||
| - | tipoApp: | + | description: Imagen o ícono que representa el tipo de documento |
| + | tipo: | ||
| type: string | type: string | ||
| - | tipoRegistro: | + | description: >- |
| + | Descripción del tipo de documento (Vehículo particula, Lote, | ||
| + | Discoteca, etc.) | ||
| + | datoAdicional: | ||
| type: string | type: string | ||
| - | usuarioDb: | + | description: Información adicional del objeto. Dirección, referencias, etc |
| + | urlPago: | ||
| type: string | type: string | ||
| - | TransactionalLog: | + | description: URL de pago única para este documento de cobro en referencia. |
| - | title: TransactionalLog | + | urlDocumento: |
| + | type: string | ||
| + | description: URL para descargar el documento de cobro. | ||
| + | urlPazYSalvo: | ||
| + | type: string | ||
| + | description: URL para descargar el documento de paz y salvo. | ||
| + | urlResolucion: | ||
| + | type: string | ||
| + | description: >- | ||
| + | URL para descargar el documento de resolución asociado a la | ||
| + | facturación del periodo. | ||
| + | idPazYSalvo: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Identificador del documento de paz y salvo | ||
| + | deudaTotal: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor de la deuda total (Aplica para acuerdos de pago) | ||
| + | valorPagado: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor total de los pagos anteriores (Aplica para acuerdos de pago) | ||
| + | deudaActual: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Deuda total actual (Aplica para acuerdos de pago) | ||
| + | proximoPago: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor total de los próximos pagos (Aplica para acuerdos de pago) | ||
| + | pagos: | ||
| + | type: array | ||
| + | items: | ||
| + | $ref: '#/components/schemas/ConsultaInformacionRespuestaPagos' | ||
| + | description: Listado de pagos aplicados (Aplica para acuerdos de pago) | ||
| + | pendientes: | ||
| + | type: array | ||
| + | items: | ||
| + | $ref: '#/components/schemas/ConsultaInformacionRespuestaPendiente' | ||
| + | description: Listado de cuotas pendientes (Aplica para acuerdos de pago) | ||
| + | ConsultaInformacionRespuestaPagos: | ||
| + | title: ConsultaInformacionRespuestaPagos | ||
| type: object | type: object | ||
| properties: | properties: | ||
| - | codigoAplicacion: | + | id: |
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | codigoEmpresa: | + | description: Identificador del registro |
| - | type: string | + | idCuota: |
| - | codigoUsuario: | + | type: integer |
| + | format: int64 | ||
| + | description: Número de cuota (1, 2, 3, etc.) | ||
| + | referencia: | ||
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | fecha: | + | description: Referencia de pago (comprobante de ingreso) |
| - | type: string | + | fechaPago: |
| - | format: date-time | + | |
| - | fechaRegistro: | + | |
| - | type: string | + | |
| - | format: date-time | + | |
| - | hostCliente: | + | |
| type: string | type: string | ||
| + | format: date | ||
| + | description: Fecha en que se aplicó el pago | ||
| + | valor: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor pagado | ||
| + | ConsultaInformacionRespuestaPendiente: | ||
| + | title: ConsultaInformacionRespuestaPendiente | ||
| + | type: object | ||
| + | properties: | ||
| id: | id: | ||
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | infoApp: | + | description: Identificador del registro |
| + | idCuota: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Número de cuota (1, 2, 3, etc.) | ||
| + | fechaVencimiento: | ||
| type: string | type: string | ||
| - | logColumna: | + | format: date |
| - | type: string | + | description: Fecha de vencimiento de la cuota |
| - | logPeticion: | + | valor: |
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor por pagar | ||
| + | deudaTotal: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Deuda total al momento de la cuota | ||
| + | valorPagado: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor pagado al momento de la cuota | ||
| + | deudaActual: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Deuda actual al momento de la cuota | ||
| + | proximoPago: | ||
| + | type: integer | ||
| + | format: int64 | ||
| + | description: Valor próximos pagos al momento de la cuota | ||
| + | ConsultaInformacion: | ||
| + | title: ConsultaInformacion | ||
| + | type: object | ||
| + | properties: | ||
| + | estado: | ||
| type: string | type: string | ||
| - | logTabla: | + | description: Estado del documento de cobro. Se aceptan sólo dos estados P o C |
| + | numeroDocumento: | ||
| type: string | type: string | ||
| - | logValorAct: | + | description: Número de documento del usuario |
| - | type: string | + | vigencia: |
| - | logValorAnt: | + | |
| - | type: string | + | |
| - | loginUsuario: | + | |
| - | type: string | + | |
| - | nitEmpresa: | + | |
| type: integer | type: integer | ||
| format: int64 | format: int64 | ||
| - | nombreProceso: | + | description: Vigencia del documento de cobro |
| + | EstadoTransaccion: | ||
| + | title: EstadoTransaccion | ||
| + | type: object | ||
| + | properties: | ||
| + | error: | ||
| + | type: boolean | ||
| + | description: Indica si hubo un error en el procesamiento de la solicitud del usuario | ||
| + | codigoMensaje: | ||
| type: string | type: string | ||
| - | sessionBrowserVersion: | + | description: Código HTML que se generó para la respuesta de la petición |
| + | mensaje: | ||
| type: string | type: string | ||
| - | sessionMac: | + | description: Mensaje generado para informar al usuario la respuesta de su petición |
| - | type: string | + | mensajeTecnico: |
| - | sessionOsType: | + | |
| - | type: string | + | |
| - | tipoTransaccion: | + | |
| type: string | type: string | ||
| + | description: Mensaje técnico con el eventual error presentado generado para informar al cliente consumidor del servicio | ||
| + | totalRegistros: | ||
| + | type: integer | ||
| + | description: Total registros devueltos en el primer arreglo de la respuesta (payload) | ||
| </code> | </code> | ||
ada/howto/sicoferp/factory/integrations/portal.contribuyente/administracionws.1630504910.txt.gz · Última modificación: 2021/09/01 14:01 por 192.168.177.37
Herramientas de la página
