Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Web Services para Registrar o Modificar Tipos de Actividad Económica.
DESCRIPCIÓN.
Este Web Service, permite Consultar, o Crear Tipos de Actividad Económica en la Aplicación SIFCO WEB, es importante mencionar que en la descripción de los mismos se pueden definir relaciones con Actividades Económicas Padres, para tener una mejor organización de estos tipos de actividad económica.
Swagger open api macro |
---|
swagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" termsOfService: "https://sifco.org/sobre-nosotros/" contact: email: "soporte@sifco.org" license: name: "Apache 2.0" url: "httpshttp://sifcowww.atlassianapache.netorg/wiki/x/MQDflicenses/LICENSE-2.0.html" produceshost: "<SERVER>" schemes: - application/json paths:- https /TApActEconomica/{ApActCod}: - http basePath: /<APPDIR>/rest gettags: - name: "TApActEconomica" tagsexternalDocs: description: "Manual SIFCO" - TApActEconomica operationId: "GetTApActEconomica" url: "https://sifco.atlassian.net/wiki/x/MQDf" produces: - application/json summarypaths: "Consultar los Tipos de Actividad Economica Registrados en el Sistema" /TApActEconomica/{ApActCod}: get: parameterstags: - TApActEconomica in: header operationId: "GetTApActEconomica" summary: "Consultar los Tipos de Actividad Económica Registrados en el Sistema" 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: "ApActCod" in: "path" description: "Código de actividad económica" required: true type: "integer" format: "int32" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TApActEconomica" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Data with the specified key could not be found" schema: $ref: "#/definitions/GxJsonError" 500: description: "Internal server error" schema: $ref: "#/definitions/GxJsonError" post: tags: - TApActEconomica operationId: "InsertTApActEconomica" summary: "Insertar los Tipos de Actividad EconomicaEconómica Registrados en el Sistema" 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: "ApActCod" in: "path" description: "Código de actividad económica" required: true type: "integer" format: "int32" - name: "TApActEconomica" in: "body" description: "SDT of TApActEconomica" required: false schema: $ref: "#/definitions/TApActEconomica" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TApActEconomica" 201: description: "Created" schema: $ref: "#/definitions/TApActEconomica" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Data with the specified key could not be found" schema: $ref: "#/definitions/GxJsonError" 500: description: "Internal server error" schema: $ref: "#/definitions/GxJsonError" putsecurity: - tagsOAuth2: [] ApiKeyAuth1: [] securityDefinitions: - TApActEconomica OAuth2: operationIdtype: "UpdateTApActEconomica"oauth2 flow: password summary: "Actualizar los Tipos de Actividad Economica Registrados en el Sistema"tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token scopes: parametersExecute: Permite el método tipo GET - inInsert: headerPermite el método tipo POST nameUpdate: Content-TypePermite el método tipo PUT typeDelete: "string"Permite el método tipo DELETE requiredFullControl: truePermite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre default: application/json el Web Service ApiKeyAuth1: - type: apiKey in: header name: granttype definitions: nameTApActEconomica: Authorization properties: typeApActCod: "string" description: Código de actividad required:económica true type: "integer" default: OAuth <Access Token> format: "int32" - in: header ApActDes: namedescription: Descripción GENEXUS-AGENTde actividad económica type: "string" ApActPadreCod: required description: trueCódigo de actividad económica padre default: SmartDevice Applicationtype: "integer" - nameformat: "ApActCodint32" in: "path"ApActPadreDes: description: "CódigoDescripción de actividad económica" padre required: truetype: "string" ApActRef: type: "integer" description: Referencia de actividad económica format: "int32" - nametype: "TApActEconomicastring" gx_md5_hash: in: "body" description: gx_md5_hash is an identifier for a description:specific "SDTversion of TApActEconomica"a resource, it is used for optimistic concurrency check. It is required: truefor update and delete operations and ignored on insert. schema: $reftype: "#/definitions/TApActEconomicastring" required: responses:- ApActCod 200GxJsonError: descriptionproperties: "Successful operation" schema: error: $ref: "#/definitions/TApActEconomicaGxJsonError.error" GxJsonError.error: 400properties: descriptioncode: "Bad request" schemadescription: Código de Error $reftype: "#/definitions/GxJsonErrorstring" 401message: description: "NotMensaje Authenticated"de Error schematype: "string" $refx-gx-level: "#/definitions/GxJsonError" 404: description: "Not found" schema: $ref: "#/definitions/GxJsonError" 409: description: "TApActEconomica was changed" 500: description: "Internal server error" schema: $ref: "#/definitions/GxJsonError" delete: tags: - TApActEconomica operationId: "DeleteTApActEconomica" summary: "Eliminar los Tipos de Actividad Economica Registrados en el Sistema" 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: "ApActCod" in: "path" description: "Código de actividad económica" required: true type: "integer" format: "int32" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TApActEconomica" 204: description: "Successful operation" schema: $ref: "#/definitions/TApActEconomica" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Not found" 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 metodo tipo GET Insert: Permite el metodo tipo POST Update: Permite el metodo tipo PUT Delete: Permite el metodo tipo DELETE FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service ApiKeyAuth1: type: apiKey in: header name: granttype definitions: TApActEconomica: properties: ApActCod: description: Código de actividad económica type: "integer" format: "int32" ApActDes: description: Descripción de actividad económica type: "string" ApActPadreCod: description: Código de actividad económica padre type: "integer" format: "int32" ApActPadreDes: description: Descripción de actividad económica padre type: "string" ApActRef: description: Referencia de actividad económica type: "string" gx_md5_hash: description: gx_md5_hash is an identifier for a specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and ignored on insert. type: "string" required: - ApActCod GxJsonError: properties: error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Codigo de Error type: "string" message: description: Mensaje de Error type: "string" x-gx-level: "GxJsonError"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 |
---|---|
TApActEconomica | |
ApActCod |
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 crear Tipos de Actividad Económica en la Aplicación SIFCO WEB.
El siguiente ejemplo crea un Tipo de Actividad Económica en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
BODY:
| |||||||||||||||
201 (Created) (Registro Creado con Éxito) |
| |||||||||||||||
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 que este Web Service, NO REQUIERE seguir algún Flujo de Trabajo especifico por ende se puede utilizar de forma independiente al Flujo de Trabajo descrito en el Web Services de Clientes. |
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
| ||||||||||||
|