Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite consultar los tipos de documentos de Identificación registrados en la Aplicación SIFCO WEB, los mismos
puedespueden aplicar a diferentes tipos de documentos de identificación (DNI, Pasaporte
,Acta de Constitución, etc)
y para diferentes tipos de figuras jurídicas de Clientes (Personales, Jurídicassegún la figura jurídica del Cliente (Natural, Jurídica, Cooperativas, etc.).
Swagger open api macro |
---|
swagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" description: "En esta Documentacion se Describen de forma detallada los metodos asociados al Web Service para Obtener Listado de los Tipos de Documento de Identificacion, creados en la Aplicacion SIFCO WEB" 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: "WSApTiposIdentificacionLista" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/PYCo" produces: - application/json paths: /WSApTiposIdentificacionLista: post: tags: - WSApTiposIdentificacionLista operationId: "WSApTiposIdentificacionLista" summary: "Lista de Tipos de Documento de IdentificacionIdentificación" 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 responses: 200: description: "Successful operation" schema: $ref: "#/definitions/WSApTiposIdentificacionListaOutput" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Not found" schema: $ref: "#/definitions/GxJsonError" 400: description: "Bad request" 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 metodométodo tipo GET Insert: Permite el metodométodo tipo POST Update: Permite el metodométodo tipo PUT Delete: Permite el metodométodo tipo DELETE FullControl: Permite el manejo de los Cuatro MetodosMétodos GET, POST, PUT,DELETE, sobre el Web Service ApiKeyAuth1: type: apiKey in: header name: granttype definitions: WSApTiposIdentificacionListaOutput: properties: TiposIdentificacionLista: description: WSAp Tipos Identificacion SDT type: array items: $ref: "#/definitions/WSApTiposIdentificacionSDT_TipoIdentificacion" WSApTiposIdentificacionSDT_TipoIdentificacion: properties: CodigoTipoIdentificacion: description: Tipo de Identificación type: "integer" format: "int32" Descripcion: description: Nombre de Identificación type: "string" URI: description: URI type: "string" GxJsonError: properties: error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: CodigoCódigo de Error type: "string" message: description: Mensaje de Error type: "string" x-gx-level: "GxJsonError" |
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 Obtenerel Listado de Tipos de Documentos de Identificación registrados en la Aplicación SIFCO WEB
El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | |
---|---|---|
REQUEST | URL:
|
Note |
---|
ADVERTENCIAS |
HEADERS
| |||||||||
200 (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 |
---|
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
| ||||||||||||
|