Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite consultar el listado de E-mail de los Clientes de registrados en la Aplicación SIFCO WEB, obteniendo un listado con los códigos y Nombre Completos de código de cliente, nombres y código de referencia de todos los clientes registrados en la Aplicación SIFCO WEB y a partir de esto realizar búsquedas refinadas con dicha información, junto a sus respectivos correos electrónicos principal y secundarios.
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: "WSClientesEmailConsulta" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/_QWp" produces: - application/json paths: /WSClientesEmailConsulta: post: tags: - WSClientesEmailConsulta operationId: "WSClientesEmailConsulta" summary: "Consulta de Email de Clientes" 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/WSClientesEmailConsultaOutput" 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 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: WSClientesEmailConsultaOutput: properties: Clientes: description: WSClientes EMail Consulta_SDT type: array items: $ref: "#/definitions/WSClientesEMailConsulta_SDT_Cliente" WSClientesEMailConsulta_SDT_Cliente: properties: CodigoCliente: description: Código del Cliente type: "integer" format: "int64" NombreCompleto: description: Nombre del Cliente type: "string" CodigoReferencia: description: Referencia type: "string" DireccionEMailPrincipal: description: Correo Electrónico type: "string" DireccionEMailSecundario: description: Correo Electrónico Alternativo type: "string" ExcluirDeMensajesDeCorreo: description: Excluir de Correos Electrónicos type: "integer" format: "int32" 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" |
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 el listado de E-mail de Clientes Registrados en la Aplicación SIFCO WEB.
El siguiente ejemplo permite obtener el Listado listado de E-mail Registrados en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS:
| ||||||||||
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 Clientes, 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
| ||||||||||||
|