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: "TApDepartamento"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/fADe"
produces:
  - application/json
paths:
  /TApDepartamento/{ApPaiCod},{ApRegCod},{ApDepCod}:
    get:
      tags:
        - TApDepartamento
      operationId: "GetTApDepartamento"
      summary: "Consultar los Departamentos de una Región de un País Registrados en el Sistema"
      parameters:
        - in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuth <Access Token>application/json
        - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: SmartDeviceOAuth <Access ApplicationToken>
        - namein: "GrAfCodigo"header
          inname: "path"GENEXUS-AGENT
          descriptiontype: "Código del Grupo de Afinidadstring"
          required: true
          typedefault: "integer"SmartDevice Application
        - formatname: "int64ApPaiCod"
             responsesin: "path"
       200:
          description: "Successful operationCódigo"
          schemarequired: true
           $reftype: "#/definitions/TClGruAfinidadinteger"
        400  format: "int64"
        - descriptionname: "Bad requestApRegCod"
          schemain: "path"
           $refdescription: "#/definitions/GxJsonError"Código División Geográfica"
         401 required: true
         description type: "Not Authenticatedinteger"
          schemaformat: "int64"
        -   $refname: "#/definitions/GxJsonErrorApDepCod"
        404  in: "path"
          description: "DataCódigo with the specified key could not be found"Sub-División Geográfica"
          required: true
    schema      type: "integer"
           $refformat: "#/definitions/GxJsonError"int64"
      
      500responses:
        200:
          description: "InternalSuccessful server erroroperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTApDepartamento"
     post   400:
      tags:    description: "Bad request"
  - TClGruAfinidad       operationIdschema:
 "InsertTClGruAfinidad"       summary: "Insertar los los Grupos de Afinidad Registrados en el Sistema"$ref: "#/definitions/GxJsonError"
        401:
  parameters:        description: - in: header"Not Authenticated"
          schema:
name: Content-Type           type$ref: "string#/definitions/GxJsonError"
          required404:
true           defaultdescription: application/json"Data with the specified key could not be found"
- in: header          schema:
name: Authorization           type$ref: "string#/definitions/GxJsonError"
          required500:
true          description: default:"Internal OAuthserver <Accesserror"
Token>         - inschema:
header            name$ref: GENEXUS-AGENT"#/definitions/GxJsonError"

    post:
    type: "string" tags:
        - required:TApDepartamento
true      operationId:  "InsertTApDepartamento"
  default: SmartDevice Application  summary: "Insertar los Departamentos de una Región -de name: "GrAfCodigo"
   un País Registrados en el Sistema"
      inparameters:
"path"        -   descriptionin: "Código delheader
Grupo de Afinidad"           requiredname: trueContent-Type
          type: "integerstring"
          formatrequired: "int64"true
         - namedefault: "TClGruAfinidad"application/json
         - in: "body"header
          descriptionname: "SDT of TClGruAfinidad"Authorization
           requiredtype: false"string"
          schemarequired: true
           $ref: "#/definitions/TClGruAfinidad"default: OAuth <Access Token>
        - responsesin: header
         200 name: GENEXUS-AGENT
         description type: "Successful operationstring"
          schemarequired: true
           $ref: "#/definitions/TClGruAfinidad"default: SmartDevice Application
        - 201name: "ApPaiCod"
          descriptionin: "Createdpath"
          schemadescription: "Código"
          required: true
$ref: "#/definitions/TClGruAfinidad"         400type: "integer"
          descriptionformat: "Bad requestint64"
        -  schemaname: "ApRegCod"
           $refin: "#/definitions/GxJsonErrorpath"
        401:  description: "Código División Geográfica"
        description  required: "Not Authenticated"true
          schematype: "integer"
           $refformat: "#/definitions/GxJsonErrorint64"
        - 404name: "ApDepCod"
         description in: "path"Data
 with the specified key could not be found"  description: "Código Sub-División Geográfica"
     schema:     required: true
      $ref    type: "#/definitions/GxJsonErrorinteger"
        500  format: "int64"
        - descriptionname: "Internal server errorTApDepartamento"
          schemain: "body"
           $refdescription: "#/definitions/GxJsonError"

SDT of TApDepartamento"
   put:       tagsrequired: false
       - TClGruAfinidad  schema:
    operationId: "UpdateTClGruAfinidad"       summary$ref: "Actualizar los los Grupos de Afinidad Registrados en el Sistema"#/definitions/TApDepartamento"

      responses:
        parameters200:
        -  indescription: "Successful headeroperation"
          nameschema:
 Content-Type           type$ref: "string#/definitions/TApDepartamento"
          required201:
true           default: application/jsondescription: "Created"
         - inschema:
header            name$ref: Authorization"#/definitions/TApDepartamento"
        400:
 type: "string"        description: "Bad request"
required: true           defaultschema:
OAuth <Access Token>         - in$ref: header"#/definitions/GxJsonError"
          name401:
GENEXUS-AGENT           typedescription: "stringNot Authenticated"
          requiredschema:
true            default$ref: SmartDevice Application"#/definitions/GxJsonError"
         - name: "GrAfCodigo"404:
          indescription: "path"
     Data with the specified key could not be found"
    description: "Código del Grupo de Afinidad" schema:
         required: true  $ref: "#/definitions/GxJsonError"
       type 500:
"integer"           formatdescription: "int64Internal server error"
         - nameschema:
"TClGruAfinidad"            in$ref: "body#/definitions/GxJsonError"
    
security:
  -  description: "SDT of TClGruAfinidad"
  OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    requiredtype: trueoauth2
    flow: password
    schematokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      $refExecute: "#/definitions/TClGruAfinidad"
   Permite el método tipo GET
      Insert: Permite el responses:método tipo POST
      200Update: Permite el método tipo PUT
      descriptionDelete: "SuccessfulPermite operation"el método tipo DELETE
       schemaFullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el $ref: "#/definitions/TClGruAfinidad"Web Service
  ApiKeyAuth1:
    type: 400:apiKey
    in: header
    descriptionname: "Badgranttype
request"
definitions:

  TApDepartamento:
     schemaproperties:
      ApPaiCod:
     $ref   description: "#/definitions/GxJsonError"Código
        401type: "integer"
         descriptionformat: "Not Authenticatedint64"

      ApPaiNombre:
  schema:      description: Paí­s
     $ref   type: "#/definitions/GxJsonErrorstring"

       404ApRegCod:
          description: "NotCódigo found"División Geográfica
         schematype: "integer"
        format: "int64"

$ref      ApRegDes:
"#/definitions/GxJsonError"        description: 409:Descripción División Geográfica
        descriptiontype: "TClGruAfinidad was changedstring"

       500ApDepCod:
          description: "Internal server error"Código Sub-División Geográfica
          schematype: "integer"
           $refformat: "#/definitions/GxJsonErrorint64"

    delete:  ApDepDes:
    tags:    description: Descripción Sub-División Geográfica
 - TClGruAfinidad       operationIdtype: "DeleteTClGruAfinidadstring"

     summary ApDepGeo:
"Eliminar los los Grupos de Afinidad Registrados en el Sistema"
  description: Geo-Ubicación de Sub-División Geográfica
   parameters:     type: "string"

  - in: header  gx_md5_hash:
        namedescription: Content-Type
          type: "string"
          required: true
    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.
     default: application/json  type: "string"


   - inrequired:
header      - ApPaiCod
   name: Authorization  - ApRegCod
      - type:ApDepCod
"string"
  GxJsonError:
    properties:
  required: true   error:
       default: OAuth <Access Token>
 $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
  - in: header  code:
        namedescription: GENEXUS-AGENTCódigo de Error
        type: "string"

         requiredmessage:
true           defaultdescription: SmartDeviceMensaje Applicationde Error
       - nametype: "GrAfCodigostring"


        inx-gx-level: "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"
        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 Región de Grupo
        type: "integer"
        format: "int64"

      GrAfRegDes:
        description: Descripción Regió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"GxJsonError"

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.