Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite Ajustar y confirmar los Montos (incrementarlos o reducirlos) en las Planillas de Transacciones Masivas de Descuentos, para luego sean actualizados y aplicados en la Aplicación SIFCO WEB.
Swagger open api macro |
---|
swagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" descriptiontermsOfService: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Ajustar los Montos (incrementados o reducidos) en las Planillas de Transacciones Masivas de Descuentos Obtenidos en el WS TransaccionesMasivas_PlanillasPendientes, y Actualizarlos en la **Aplicación SIFCO WEB** ." termsOfService: "https://sifco.org/sobre-nosotros/" contacthttps://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: "TransaccionesMasivas_PlanillasAplicar" externalDocs: emaildescription: "soporte@sifco.orgManual SIFCO" license: nameurl: "Apache 2.0" https://sifco.atlassian.net/wiki/x/SoDQ" produces: - application/json paths: url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "<SERVER>" schemes: - https - http basePath: /<APPDIR>/rest tags: - name: "TransaccionesMasivas_PlanillasAplicar" externalDocs: description: "Manual SIFCO /TransaccionesMasivas_PlanillasAplicar: post: tags: - TransaccionesMasivas_PlanillasAplicar operationId: "TransaccionesMasivas_PlanillasAplicar" url: "https://sifco.atlassian.net/wiki/x/SoDQ" produces: - application/json paths: /TransaccionesMasivas_PlanillasAplicar: post: tags: summary: "Web Service para Aplicar Planillas de Transacciones Masivas de Descuentos cargados y confirmados en la Aplicación SIFCO" parameters: - TransaccionesMasivas_PlanillasAplicar - in: header operationId: "TransaccionesMasivas_PlanillasAplicar" summaryname: "WebContent-Type Service para para Aplicar Planillas de Transacciones Masivas de Descuentos cargados y confirmados en la Aplicación SIFCO"type: "string" parametersrequired: true - in: header default: application/json - in: header name: Content-TypeAuthorization type: "string" required: true default: application/json OAuth <Access Token> - in: header name: AuthorizationGENEXUS-AGENT type: "string" required: true default: OAuthSmartDevice <Access Token>Application - inname: header"TransaccionesMasivas_PlanillasAplicarInput" namein: GENEXUS-AGENT"body" typerequired: "string"false requiredschema: true default$ref: SmartDevice Application"#/definitions/TransaccionesMasivas_PlanillasAplicarInput" - nameresponses: "TransaccionesMasivas_PlanillasAplicarInput" in200: "body" description: required: false"Successful operation" schema: $ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarInputPlanillasAplicarOutput" responses: 200401: description: "SuccessfulNot operationAuthenticated" schema: $ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarOutputGxJsonError" 401404: description: "Not Authenticatedfound" schema: $ref: "#/definitions/GxJsonError" 404400: description: "NotBad foundrequest" schema: $ref: "#/definitions/GxJsonError" 400500: description: "BadInternal server requesterror" schema: $ref: "#/definitions/GxJsonError" security: - 500OAuth2: [] ApiKeyAuth1: [] securityDefinitions: descriptionOAuth2: "Internal server error" type: oauth2 schemaflow: password tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token $refscopes: "#/definitions/GxJsonError" security: - OAuth2Execute: []Permite el método tipo GET ApiKeyAuth1: [] securityDefinitions: OAuth2Insert: Permite el método tipo POST type: oauth2 flowUpdate: passwordPermite el método tipo PUT tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token scopesDelete: Execute: Permite el método tipo GETDELETE InsertFullControl: Permite el métodomanejo tipode POSTlos Cuatro Métodos GET, POST, PUT,DELETE, sobre Update:el PermiteWeb elService método tipo PUTApiKeyAuth1: Deletetype: PermiteapiKey el método tipo DELETE in: header FullControlname: Permitegranttype el manejodefinitions: de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web ServiceTransaccionesMasivas_PlanillasAplicarInput: properties: ApiKeyAuth1: Planillas: type: apiKey indescription: headerTransacciones name: granttype definitions: TransaccionesMasivas_PlanillasAplicarInput: properties: Planillas: description: Transacciones Masivas_Planilla Masivas_Planilla Entrada $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada" TransaccionesMasivas_PlanillaEntrada: properties: Planillas: type: array items: description: Planilla $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada.Planillas" TransaccionesMasivas_PlanillaEntrada.Planillas: properties: ID: description: ID de la Planilla type: "string" Detalles: type: array items: description: Detalle $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada.Planillas.Detalles" x-gx-level: "TransaccionesMasivas_PlanillaEntrada" TransaccionesMasivas_PlanillaEntrada.Planillas.Detalles: properties: ID: description: ID del Cargo type: "string" Valor format: uuid descriptionValor: Valor a description: Valor a Descontar o Descontado type: "number" format: "double" x-gx-level: "TransaccionesMasivas_PlanillaEntrada.Planillas" TransaccionesMasivas_PlanillasAplicarOutput: properties: error: type: "integer" format: "int32" mensajes: type: "string" 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" |
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
TransaccionesMasivas_PlanillaSalida
>TransaccionesMasivas_PlanillaSalida.Planillas
Frecuencia
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.
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 Obtener los Descuentos de un vez ajustar y confirmar los Montos (incrementarlos o reducirlos) en las Planillas de Transacciones Pendientes generados por un Sistema Externo o directamente desde Masivas de Descuentos, para que luego sean actualizados y aplicados en la Aplicación SIFCO WEB.
El siguiente ejemplo permite Obtener los Descuentos de Ajustar los Montos (incrementarlos o reducirlos) en las Planillas de Transacciones Pendientes Masivas de Descuentos, para que luego sean actualizados y aplicados en la Aplicación SIFCO WEB, en un rango de fechas especifico..
Tipo de Mensaje HTTP | Ejemplo | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
BODY:
| ||||||||||||||||||
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 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 Planillas de Transacciones Masivas, 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
| ||||||||||||
|