Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite Consultar o Crear Tipos de Documentos de Identificación en la Aplicación SIFCO WEB, es importante mencionar que en la descripción de los mismos se pueden definir una expresión regular cuyo objetivo es la validación de un formato específico en una cadena de caracteres dentro del Campo de Tipos de Documentos de Identificación dentro de la Aplicación SIFCO WEB.
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: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
- https
- http
basePath: /<APPDIR>/rest
tags:
- name: "TApTipIdentificacion"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/cgDd"
produces:
- application/json
paths:
/TApTipIdentificacion/{ApTidCod}:
get:
tags:
- TApTipIdentificacion
operationId: "GetTApTipIdentificacion"
summary: "Consultar los Tipos de Documento de Identificación 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: "ApTidCod"
in: "path"
description: "Tipo de Identificación"
required: true
type: "integer"
format: "int32"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TApTipIdentificacion"
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:
- TApTipIdentificacion
operationId: "InsertTApTipIdentificacion"
summary: "Insertar los Tipos de Documento de Identificación 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: "ApTidCod"
in: "path"
description: "Tipo de Identificación"
required: true
type: "integer"
format: "int32"
- name: "TApTipIdentificacion"
in: "body"
description: "SDT of TApTipIdentificacion"
required: false
schema:
$ref: "#/definitions/TApTipIdentificacion"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TApTipIdentificacion"
201:
description: "Created"
schema:
$ref: "#/definitions/TApTipIdentificacion"
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"
security:
- OAuth2: []
ApiKeyAuth1: []
securityDefinitions:
OAuth2:
type: oauth2
flow: password
tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
scopes:
Execute: Permite el método tipo GET
Insert: Permite el método tipo POST
Update: Permite el método tipo PUT
Delete: Permite el método tipo DELETE
FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
TApTipIdentificacion:
properties:
ApTidCod:
description: Tipo de Identificación
type: "integer"
format: "int32"
ApTidDes:
description: Nombre de Identificación
type: "string"
ApTidForma:
description: Formato de Identificación
type: "string"
ApTipExpReg:
description: Expresión Regular
type: "string"
ApTidValidacion:
description: Tipo de Validación a Realizar
type: "integer"
format: "int32"
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:
- ApTidCod
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 |
---|---|
TApTipIdentificacion | |
ApTidCod |
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 Documentos de Identificación en la Aplicación SIFCO WEB.
El siguiente ejemplo crea un Tipo de Documento de Identificación 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
| ||||||||||||
|