Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Web Services para Registrar o Modificar Departamentos de una Región.

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**, como es Registrar o Modificar los Departamentos o MunicipiosGrupos de una Region de un País Afinidad 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: "TApDepartamentoTClGruAfinidad"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/fADeloDe"
produces:
  - application/json
paths:
  /TApDepartamentoTClGruAfinidad/{ApPaiCod},{ApRegCod},{ApDepCod}GrAfCodigo}:
    get:
      tags:
        - TApDepartamentoTClGruAfinidad
      operationId: "GetTApDepartamentoGetTClGruAfinidad"
      summary: "Consultar los Departamentos de una Regionlos Grupos de unAfinidad 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: "ApPaiCodGrAfCodigo"
          in: "path"
          description: "Código del Grupo de Afinidad"
          required: true
          type: "integer"
          format: "int64"
      
 -  name: "ApRegCod"  responses:
        in200:
"path"
          description: "CódigoSuccessful División Geográficaoperation"
          requiredschema:
true            type$ref: "integer#/definitions/TClGruAfinidad"
          format400:
"int64"         - namedescription: "ApDepCodBad request"
          inschema:
"path"            description$ref: "Código Sub-División Geográfica#/definitions/GxJsonError"
          required401: true
          typedescription: "integerNot Authenticated"
          formatschema: "int64"
             responses$ref:   "#/definitions/GxJsonError"
      200  404:
          description: "Successful operationData with the specified key could not be found"
          schema:
            $ref: "#/definitions/TApDepartamentoGxJsonError"
        400500:
          description: "BadInternal server requesterror"
          schema:
            $ref: "#/definitions/GxJsonError"

    post:
      401tags:
        - TClGruAfinidad
description: "Not Authenticated"    operationId: "InsertTClGruAfinidad"
     schema summary: "Insertar los los Grupos de Afinidad Registrados en el Sistema"
  $ref    parameters:
"#/definitions/GxJsonError"        - 404in: header
          description: "Data with the specified key could not be foundname: Content-Type
          type: "string"
          schemarequired: true
           $refdefault: "#/definitions/GxJsonError"application/json
        - 500in: header
         description name: "Internal server error"Authorization
           schematype: "string"
           $refrequired: "#/definitions/GxJsonError"true
     post:       tagsdefault: OAuth <Access Token>
     - TApDepartamento  - in: header
  operationId: "InsertTApDepartamento"       summaryname: "InsertarGENEXUS-AGENT
los Departamentos de una Region de un País Registrados en eltype: Sistema"string"
      parameters:         - inrequired: headertrue
          namedefault: Content-TypeSmartDevice Application
        - typename: "stringGrAfCodigo"
          requiredin: true"path"
          defaultdescription: application/json"Código del Grupo de   Afinidad"
  - in: header           namerequired: Authorizationtrue
          type: "stringinteger"
          requiredformat: true"int64"
        -  defaultname: OAuth <Access Token>"TClGruAfinidad"
         - in: header"body"
          namedescription: GENEXUS-AGENT "SDT of TClGruAfinidad"
          typerequired: "string"false
          requiredschema:
true            default$ref: SmartDevice Application"#/definitions/TClGruAfinidad"

       - nameresponses:
"ApPaiCod"           in200:
"path"
          description: "CódigoSuccessful operation"
          requiredschema:
 true           type$ref: "integer#/definitions/TClGruAfinidad"
          format201:
"int64"         - namedescription: "ApRegCodCreated"
          inschema:
"path"            description$ref: "Código División Geográfica#/definitions/TClGruAfinidad"
          required400:
true           typedescription: "integerBad request"
          formatschema:
  "int64"         - name$ref: "ApDepCod#/definitions/GxJsonError"
          in: "path"401:
          description: "Código Sub-División GeográficaNot Authenticated"
          requiredschema:
 true           type$ref: "integer#/definitions/GxJsonError"
          format404:
"int64"         - namedescription: "TApDepartamentoData with the specified key could not be found"
          inschema:
 "body"           description$ref: "SDT of TApDepartamento"#/definitions/GxJsonError"
        500:
          requireddescription: false"Internal server error"
          schema:
            $ref: "#/definitions/TApDepartamentoGxJsonError"

    put:
 responses:     tags:
   200:     - TClGruAfinidad
      descriptionoperationId: "Successful operationUpdateTClGruAfinidad"
      summary: "Actualizar los los schema:Grupos de Afinidad Registrados en el Sistema"
      $refparameters:
"#/definitions/TApDepartamento"        - 201in: header
         description name: "Created"Content-Type
          schematype: "string"
          required: true
$ref: "#/definitions/TApDepartamento"         400default: application/json
        - descriptionin: "Badheader
request"           schemaname: Authorization
           $reftype: "#/definitions/GxJsonErrorstring"
        401  required: true
         description default: "NotOAuth Authenticated"<Access Token>
        - schemain: header
           $ref: "#/definitions/GxJsonError"name: GENEXUS-AGENT
          404type: "string"
          descriptionrequired: "Datatrue
 with the specified key could not be found"  default: SmartDevice Application
      schema:  - name: "GrAfCodigo"
        $ref: "#/definitions/GxJsonError in: "path"
        500:
   description: "Código del Grupo de Afinidad"
        description: "Internal serverrequired: error"true
          schematype: "integer"
           $refformat: "#/definitions/GxJsonErrorint64"
     put   - name: "TClGruAfinidad"
     tags:     in: "body"
  - TApDepartamento       operationIddescription: "UpdateTApDepartamentoSDT of TClGruAfinidad"
      summary: "Actualizar los Departamentos derequired: unatrue
Region de un País Registrados en el Sistema"    schema:
  parameters:         - in$ref: header"#/definitions/TClGruAfinidad"
      
   name: Content-Type  responses:
        type200:
"string"          description: required: true"Successful operation"
          defaultschema:
application/json         - in: header $ref: "#/definitions/TClGruAfinidad"
        name400:
Authorization           typedescription: "stringBad request"
          requiredschema:
true            default$ref: OAuth <Access Token>"#/definitions/GxJsonError"
          - in401:
header          description: name: GENEXUS-AGENT"Not Authenticated"
          typeschema:
"string"            required$ref: true"#/definitions/GxJsonError"
          default404: SmartDevice
Application         - namedescription: "ApPaiCodNot found"
          inschema:
"path"            description$ref: "Código#/definitions/GxJsonError"
          required409:
true           typedescription: "integer"TClGruAfinidad was changed"
        format500:
"int64"         - namedescription: "ApRegCodInternal server error"
          inschema:
 "path"           description$ref: "Código División Geográfica"#/definitions/GxJsonError"

    delete:
      requiredtags:
   true     - TClGruAfinidad
    type  operationId: "integerDeleteTClGruAfinidad"
      summary: "Eliminar los los format: "int64"
    Grupos de Afinidad Registrados en el Sistema"
   - name: "ApDepCod" parameters:
        - in: "path"header
          descriptionname: "Código Sub-División Geográfica"Content-Type
          requiredtype: true"string"
          typerequired: "integer"true
          formatdefault: "int64"application/json
        - namein: "TApDepartamento"header
          inname: Authorization
"body"           descriptiontype: "SDT of TApDepartamentostring"
          required: true
          schemadefault: OAuth <Access Token>
        - $refin: "#/definitions/TApDepartamento"header
          name: GENEXUS-AGENT
 responses:         200type: "string"
         description required: "Successfultrue
operation"           schemadefault: SmartDevice Application
        -  $refname: "#/definitions/TApDepartamentoGrAfCodigo"
        400  in: "path"
          description: "BadCódigo request"
del Grupo de Afinidad"
         schema:
  required: true
          type: "integer"
          $refformat: "#/definitions/GxJsonErrorint64"

       401responses:
        200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClGruAfinidad"
        404204:
          description: "NotSuccessful foundoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClGruAfinidad"
        409400:
          description: "Bad request"TApDepartamento
was changed"         500schema:
           description: "Internal server error$ref: "#/definitions/GxJsonError"
          schema401:
            $refdescription: "#/definitions/GxJsonErrorNot Authenticated"
     delete:       tagsschema:
        - TApDepartamento       operationId$ref: "DeleteTApDepartamento#/definitions/GxJsonError"
      summary  404:
"Eliminar los Departamentos de una Region de un País Registrados endescription: el"Not Sistemafound"
      parameters:    schema:
        - in: header  $ref: "#/definitions/GxJsonError"
        name500: Content-Type
          typedescription: "stringInternal server error"
          requiredschema:
 true           default$ref: application/json"#/definitions/GxJsonError"


security:
  - OAuth2: []
 - in: header ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    nametype: Authorizationoauth2
    flow: password
    type: "string"tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      requiredExecute: truePermite el método tipo GET
      defaultInsert: OAuthPermite <Accessel Token>método tipo POST
      - inUpdate: headerPermite el método tipo PUT
      nameDelete: GENEXUS-AGENTPermite el método tipo DELETE
      typeFullControl: "string"Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre required:el trueWeb Service
  ApiKeyAuth1:
      defaulttype: SmartDeviceapiKey
Application    in: header
   - name: "ApPaiCod"granttype

definitions:

  TClGruAfinidad:
    inproperties:
"path"           descriptionGrAfCodigo:
"Código"        description: Código del required:Grupo truede Afinidad
         type: "integer"
          format: "int64"

       - nameGrPrmCod:
"ApRegCod"        description: Código de in:Promotor
"path"        type: "string"

description:  "Código División Geográfica"  GrPrmNombre:
        requireddescription: trueNombre de promotor
        type: "integerstring"

         formatGrAfDescripcion:
"int64"        description: -Descripción name: "ApDepCod"
del Grupo Afinidad
         intype: "pathstring"

         descriptionGrAfCiclo:
"Código Sub-División Geográfica"      description: Ciclo de Grupo
 required: true           typetype: "integer"
          format: "int64"

      responsesGrAfEstado:
        200description: Estado de Grupo
       description type: "Successful operationstring"

         schemaGrAfPaiCod:
        description: Código de País $ref: "#/definitions/TApDepartamento"de Grupo
        204type: "integer"
         descriptionformat: "Successful operationint64"

         schemaGrAfPaiNom:
            $refdescription: "#/definitions/TApDepartamento"
        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
  ApiKeyAuth1Nombre de País de Grupo
        type: "string"

      GrAfRegCod:
    type: apiKey   description: Código in:de headerRegión de Grupo
  name: granttype  definitions:    TApDepartamentotype: "integer"
   properties:     format: "int64"
ApPaiCod:
      GrAfRegDes:
 description: Código      description: Descripción Región type: "integer"de Grupo
        formattype: "int64string"

      ApPaiNombreGrAfDepCod:
        description: Paí­sCódigo Departamento de Grupo
        type: "stringinteger"
       ApRegCod format: "int64"

      descriptionGrAfDepDes:
Código División Geográfica      description: Descripción Departamento type: "integer"de Grupo
        formattype: "int64string"

      ApRegDesGrAfMunCod:
        description: DescripciónCódigo Municipio Divisiónde GeográficaGrupo
        type: "stringinteger"
       ApDepCod format: "int64"

      descriptionGrAfMunDes:
Código  Sub-División Geográfica     description: Descripción Municipio de type:Grupo
"integer"         formattype: "int64string"

      ApDepDesGrAfGeolocalizacion:
        description: Descripción Sub-División GeográficaGeolocalización
        type: "string"

      ApDepGeoGrAfSucCodigo:
        description: Geo-UbicaciónCódigo de Sub-División GeográficaSucursal
        type: "integer"
        typeformat: "stringint32"

      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
      - ApRegCod
      - ApDepCodGrAfCodigo

  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"

Note

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.

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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" , "parametros" , "generales" , "departamento" , "municipio" , "region" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History