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: "TClGruAfinidadTApDepartamento"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/loDefADe"
produces:
  - application/json
paths:
  /TClGruAfinidad/{GrAfCodigoTApDepartamento/{ApPaiCod},{ApRegCod},{ApDepCod}:
    get:
      tags:
        - TClGruAfinidadTApDepartamento
      operationId: "GetTClGruAfinidadGetTApDepartamento"
      summary: "Consultar los los GruposDepartamentos de una Región de Afinidadun País 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: "GrAfCodigoApPaiCod"
          in: "path"
          description: "Código del Grupo de Afinidad"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
  responses:         200:in: "path"
          description: "SuccessfulCódigo División operationGeográfica"
          schemarequired: true
           $reftype: "#/definitions/TClGruAfinidadinteger"
        400  format: "int64"
        - descriptionname: "Bad requestApDepCod"
          schemain: "path"
           $refdescription: "#/definitions/GxJsonError"Código Sub-División Geográfica"
          401required: true
         description type: "integer"Not
Authenticated"          format: "int64"
schema:      
      $refresponses:
"#/definitions/GxJsonError"         404200:
          description: "Data with the specified key could not be foundSuccessful operation"
          schema:
            $ref: "#/definitions/GxJsonErrorTApDepartamento"
        500400:
          description: "InternalBad server errorrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
     post   401:
      tags:    description: "Not Authenticated"
  - TClGruAfinidad       operationIdschema:
"InsertTClGruAfinidad"       summary: "Insertar los los Grupos de Afinidad Registrados en el Sistema"$ref: "#/definitions/GxJsonError"
        404:
 parameters:         - indescription: header"Data with the specified key could not be found"
  name: Content-Type       schema:
   type: "string"           required$ref: true"#/definitions/GxJsonError"
          default500:
application/json         - indescription: header"Internal server error"
          nameschema:
Authorization            type$ref: "string#/definitions/GxJsonError"

    post:
    required  tags:
true        - TApDepartamento
 default: OAuth <Access Token>  operationId: "InsertTApDepartamento"
     - insummary: header"Insertar los Departamentos de una Región de un País Registrados en name: GENEXUS-AGENTel Sistema"
      parameters:
   type: "string"    - in: header
    required      name: trueContent-Type
          defaulttype: SmartDevice"string"
Application         - namerequired: "GrAfCodigo"true
          indefault: "path"application/json
        -  descriptionin: "Códigoheader
del Grupo de Afinidad"           requiredname: trueAuthorization
          type: "integerstring"
          formatrequired: "int64"true
         - namedefault: "TClGruAfinidad"
OAuth <Access Token>
        - in: "body"header
          descriptionname: "SDTGENEXUS-AGENT
of TClGruAfinidad"         type: "string"
required: false         required: true
schema:          default: SmartDevice Application
$ref: "#/definitions/TClGruAfinidad"       - responsesname: "ApPaiCod"
       200   in: "path"
          description: "Successful operationCódigo"
          schemarequired: true
           $reftype: "#/definitions/TClGruAfinidadinteger"
        201:  format: "int64"
        - descriptionname: "CreatedApRegCod"
          schemain: "path"
           $refdescription: "#/definitions/TClGruAfinidadCódigo División Geográfica"
        400  required: true
          descriptiontype: "Bad requestinteger"
          schemaformat: "int64"
        -   $refname: "#/definitions/GxJsonErrorApDepCod"
        401:  in: "path"
          description: "Not AuthenticatedCódigo Sub-División Geográfica"
          schemarequired: true
           $reftype: "#/definitions/GxJsonErrorinteger"
        404  format: "int64"
        - descriptionname: "Data with the specified key could not be foundTApDepartamento"
          schemain: "body"
           $refdescription: "#/definitions/GxJsonErrorSDT of TApDepartamento"
        500  required: false
          descriptionschema:
"Internal server error"           schema$ref:             $ref: "#/definitions/GxJsonErrorTApDepartamento"

    put:  responses:
    tags:    200:
    - TClGruAfinidad       operationIddescription: "UpdateTClGruAfinidadSuccessful operation"
      summary: "Actualizar los los Gruposschema:
de Afinidad Registrados en el Sistema"       parameters$ref: "#/definitions/TApDepartamento"
       - in201: header
          namedescription: Content-Type"Created"
          typeschema:
"string"            required$ref: true"#/definitions/TApDepartamento"
          default400:
application/json         - indescription: header"Bad request"
          nameschema:
Authorization            type$ref: "string#/definitions/GxJsonError"
          required401:
true           defaultdescription: OAuth"Not <AccessAuthenticated"
Token>         - inschema:
header            name$ref: GENEXUS-AGENT"#/definitions/GxJsonError"
        404:
 type: "string"        description: "Data  required: truewith the specified key could not be found"
          defaultschema:
SmartDevice  Application         - name$ref: "GrAfCodigo#/definitions/GxJsonError"
          in500:
"path"           description: "CódigoInternal del Grupo de Afinidadserver error"
          requiredschema:
 true           type$ref: "integer#/definitions/GxJsonError"
    
security:
  -  formatOAuth2: "int64"[]
    ApiKeyAuth1: []
securityDefinitions:
 - nameOAuth2:
"TClGruAfinidad"           intype: "body"oauth2
          descriptionflow: "SDTpassword
of TClGruAfinidad"           required: true
          schema:
            $ref: "#/definitions/TClGruAfinidad"
      
      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: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        409:
          description: "TClGruAfinidad was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - TClGruAfinidad
      operationId: "DeleteTClGruAfinidad"
      summary: "Eliminar 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"
        204:
          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: "Not 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"tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
        formatExecute: "int64"Permite el método tipo GET
   GrAfEstado:         descriptionInsert: EstadoPermite deel Grupométodo tipo POST
      typeUpdate: "string"Permite el método tipo PUT
   GrAfPaiCod:   Delete: Permite el método tipo DELETE
description: Código de País de Grupo FullControl: Permite       type: "integer"
        format: "int64"

 el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    GrAfPaiNomtype: apiKey
    in: header
 description:  Nombre dename: Paísgranttype
de
Grupodefinitions:

  TApDepartamento:
    typeproperties:
"string"        GrAfRegCodApPaiCod:
        description: Código
de Región de Grupo         type: "integer"
        format: "int64"

      GrAfRegDesApPaiNombre:
        description: Descripción Región de GrupoPaí­s
        type: "string"

      GrAfDepCodApRegCod:
        description: Código DepartamentoDivisión deGeográfica
Grupo         type: "integer"
        format: "int64"

      GrAfDepDesApRegDes:
        description: Descripción DepartamentoDivisión deGeográfica
Grupo         type: "string"

      GrAfMunCodApDepCod:
        description: Código MunicipioSub-División deGeográfica
Grupo
        type: "integer"
        format: "int64"

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

      GrAfGeolocalizacion:
        description: GeolocalizaciónSub-División Geográfica
        type: "string"

      GrAfSucCodigoApDepGeo:
        description: CódigoGeo-Ubicación de SucursalSub-División Geográfica
        type: "integerstring"

       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:
      - ApPaiCod
      - GrAfCodigo ApRegCod
      - ApDepCod

  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.