Page Comparison

Web Services para Consultar Listado de Clientes Registrados en el Sistema

DESCRIPCIÓN.

Este Web Service, permite consultar el listado de Grupos de Clientes registrados en la Aplicación SIFCO WEB, tal que permite categorizar los clientes registrados o a registrar y asociarlos a una grupo especifico, los mismo están también asociados a un código de promotor especifico existente en la Aplicación SIFCO WEB.

Swagger open api macro

swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  description: "La presente
documentación busca detallar los métodos que permite ejecutar este **Web Services**, el cual permite consultar el Listado de Clientes registrados en la **Aplicación 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: "WSClGruposLista"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/PYCorAWp"
produces:
  - application/json
paths:
  /WSClGruposLista:
    post:
      tags:
        - WSClGruposLista
      operationId: "WSClGruposLista"
      summary: "Listado de Grupos de Clientes del 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

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/WSClGruposListaOutput"
        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:

  WSClGruposListaOutput:
    properties:
      GruposLista:
        description: WSCl Grupo Afinidad SDT
        type: array
        items:
          $ref: "#/definitions/WSClGrupoAfinidadSDT_Grupo"
  
  WSClGrupoAfinidadSDT_Grupo:
    properties:
      CodigoGrupo:
        description: Código del Grupo de Afinidad
        type: "integer"
        format: "int64"

      CodigoPromotor:
        description: CodigoCódigo de Promotor
        type: "string"

      Descripcion:
        description: Descripción del Grupo Afinidad
        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 Grupos de Clientes 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:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/WSClGruposLista

HEADERS

Code Block

language	json

content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

200 (Operación Exitosa)

Code Block

language	json

{
  "GruposLista": [
      {
        "CodigoGrupo": 1,
        "CodigoPromotor": "admin",
        "Descripcion": "GRUPO ZONA 1",
        "URI": ""
      },
      {
        "CodigoGrupo": 2,
        "CodigoPromotor": "admin",
        "Descripcion": "GRUPO LAS MARAVILLOSAS",
        "URI": ""
      },
      {
        "CodigoGrupo": 3,
        "CodigoPromotor": "admin",
        "Descripcion": "PRUEBAS CREDITOS",
        "URI": ""
      },
      {
        "CodigoGrupo": 4,
        "CodigoPromotor": "agomez",
        "Descripcion": "GRUPO ZONA 7",
        "URI": ""
      },
      {
        "CodigoGrupo": 5,
        "CodigoPromotor": "lrarchila",
        "Descripcion": "SERVICIOS UNIDOS DE SEGURIDAD",
        "URI": ""
      },
      {
        "CodigoGrupo": 6,
        "CodigoPromotor": "admin",
        "Descripcion": "GRUPO ÓPTIMO",
        "URI": ""
      },
      {
        "CodigoGrupo": 8,
        "CodigoPromotor": "admin",
        "Descripcion": "GRUPO DE BRYAN Y DE PANCHO",
        "URI": ""
      },
      {
        "CodigoGrupo": 9,
        "CodigoPromotor": "admin",
        "Descripcion": "NUEVO MUNDO",
        "URI": ""
    }
  ],
}

400 (Bad Request).

Solicitud Errada

Code Block

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

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) ).

Code Block

language	json

{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "GruposLista": []
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

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

language	json

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.

Live Search

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 1

New Version Current

Key

DESCRIPCIÓN.

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente