Page Comparison

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: "TClGruAfinidad"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/loDe"
produces:
  - application/json
paths:
  /TClGruAfinidad/{GrAfCodigo}:
    get:
      tags:
        - TClGruAfinidad
      operationId: "GetTClGruAfinidad"
      summary: "Consultar los los Grupos de Afinidad 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: "GrAfCodigo"
          in: "path"
          description: "Código del Grupo de Afinidad"
          required: true
          type: "integer"
          format: "int64"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClGruAfinidad"
        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:

  TClGruAfinidad:
    properties:
      GrAfCodigo:
        description: Código del Grupo de Afinidad
        type: "integer"
        format: "int64"

      GrPrmCod:
        description: Código de Promotor
        type: "string"

      GrPrmNombre:
        description: Nombre de promotor
        type: "string"

      GrAfDescripcion:
        description: Descripción del Grupo Afinidad
        type: "string"

      GrAfCiclo:
        description: Ciclo de Grupo
        type: "integer"
        format: "int64"

      GrAfEstado:
        description: Estado de Grupo
        type: "string"

      GrAfPaiCod:
        description: Código de País de Grupo
        type: "integer"
        format: "int64"

      GrAfPaiNom:
        description: Nombre de País de Grupo
        type: "string"

      GrAfRegCod:
        description: Código de RegionRegión de Grupo
        type: "integer"
        format: "int64"

      GrAfRegDes:
        description: Descripción RegionRegión de Grupo
        type: "string"

      GrAfDepCod:
        description: Código Departamento de Grupo
        type: "integer"
        format: "int64"

      GrAfDepDes:
        description: Descripción Departamento de Grupo
        type: "string"

      GrAfMunCod:
        description: Código Municipio de Grupo
        type: "integer"
        format: "int64"

      GrAfMunDes:
        description: Descripción Municipio de Grupo
        type: "string"

      GrAfGeolocalizacion:
        description: Geolocalización
        type: "string"

      GrAfSucCodigo:
        description: Código de Sucursal
        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:
      - GrAfCodigo

  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"

INFORMACIÓN

Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de ErroresMensajes) External Call Out, donde se describe el listado de errores mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.

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.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

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.