Versions Compared

Version Old Version 2 New Version Current
Changes made by

Alfredo Lopez (Unlicensed)

Alfredo Lopez (Unlicensed)

Saved on

Key

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

Web Services para Registrar o Modificar Regiones de un País.

Swagger open api macroswagger: '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 un País 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: "TApRegion" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/cgDe" produces: - application/json paths: /TApRegion/{ApPaiCod},{ApRegCod}: get: tags: - TApRegion operationId: "GetTApRegion" summary: "Consultar las Regiones de un País Registrados en el Sistema" parameters

DESCRIPCIÓN.

Este Web Service, permite Consultar o Crear Regiones o Departamentos de País registrado en la Aplicación SIFCO WEB, es importante acotar que se pueden incluir o modificar detalles como Nombre y Ubicación Geográfica, el cual permitirá junto con los Web Service (TApPais) y Web Service (TApDepartamento) establecer ubicaciones precisas de las direcciones, documentos de identificación o demás parámetros del cliente donde la ubicación geográfica es relevante.

Swagger open api macro
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: "TApRegion"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/cgDe"
produces:
  - application/json
paths:
  /TApRegion/{ApPaiCod},{ApRegCod}:
    get:
      tags:
        - in:TApRegion
header      operationId: "GetTApRegion"
      summary: "Consultar las Regiones de un 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        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"

    post:
      tags:
        - TApRegion
      operationId: "InsertTApRegion"
      summary: "Insertar las Regiones de un 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"
        - name: "TApRegion"
          in: "body"
          description: "SDT of TApRegion"
          required: false
          schema:
            $ref: "#/definitions/TApRegion"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        201:
          description: "Created"
          schema:
            $ref: "#/definitions/TApRegion"
        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:
  - putOAuth2: []
     tagsApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: -oauth2
TApRegion    flow: password
 operationId: "UpdateTApRegion"  tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    summaryscopes:
"Actualizar las Regiones de un País RegistradosExecute: enPermite el Sistema"método tipo GET
    parameters:  Insert: Permite el método tipo POST
 - in: header   Update: Permite el método tipo PUT
  name: Content-Type   Delete: Permite el método tipo DELETE
  type: "string"   FullControl: Permite el manejo de los Cuatro Métodos required: true
          default: application/jsonGET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
   - in: header
    name: granttype

definitions:

 name TApRegion:
Authorization    properties:
      typeApPaiCod:
"string"        description: Código
  required: true     type: "integer"
    default: OAuth <Access Token> format: "int64"

     - inApPaiNombre:
header           namedescription: GENEXUS-AGENT
 Paí­s
        type: "string"

      ApRegCod:
  required: true     description: Código División Geográfica
  default: SmartDevice Application    type: "integer"
   - name: "ApPaiCod"           informat: "pathint64"

         descriptionApRegDes:
"Código"           requireddescription: trueDescripción División Geográfica
        type: "integerstring"

         formatApRegGeo:
"int64"        description: Geo-Ubicación name: "ApRegCod"de Región
          intype: "pathstring"

      gx_md5_hash:
  description: "Código División Geográfica"   description: gx_md5_hash is an identifier for a specific required:version trueof a resource, it is used for optimistic concurrency check. It type: "integer"
          format: "int64"is required for update and delete operations and  ignored on insert.
          - nametype: "TApRegionstring"


    required:
   in: "body"  - ApPaiCod
      - description:ApRegCod
"SDT
of TApRegion" GxJsonError:
         requiredproperties:
true           schema:
  error:
         $ref: "#/definitions/TApRegionGxJsonError.error"

  GxJsonError.error:
    properties:
      responsescode:
        200description: Código de Error
        descriptiontype: "Successful operationstring"

      message:
  schema:      description: Mensaje      $ref: "#/definitions/TApRegion"de Error
        400type:           description: "Bad request"string"


        schema:
            $refx-gx-level: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        409:
          description: "TApRegion was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - TApRegion
      operationId: "DeleteTApRegion"
      summary: "Eliminar las Regiones de un 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"

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

  TApRegion:
    properties:
      ApPaiCod:
        description: Código
        type: "integer"
        format: "int64"

      ApPaiNombre:
        description: Paí­s
        type: "string"

      ApRegCod:
        description: Código División Geográfica
        type: "integer"
        format: "int64"

      ApRegDes:
        description: Descripción División Geográfica
        type: "string"

      ApRegGeo:
        description: Geo-Ubicación de region
        type: "string"

      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

  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"

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.

Modelo de Datos de este Web Service

Web Service a Constantes del Sistema Relacionados

TApRegion

ApPaiCod

WSApPaisLista

ApRegCod

WSApDepartamentoLista

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 crear una Región de un País registrado en la Aplicación SIFCO WEB.

El siguiente ejemplo crea una Región de una País en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/TApRegion/593,2

HEADERS:

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

BODY:

Code Block
languagejson
{
  "ApPaiCod": 593,
  "ApPaiNombre": "Ecuador",
  "ApRegCod": 2,
  "ApRegDes": "Quito",
  "ApRegGeo": "Ecuador, Quito",
  "gx_md5_hash": "187A23F10E1D215B3086B4CF8C54D35F"
}

201 (Created)

(Registro Creado con Éxito)

Code Block
languagejson
{
  "ApPaiCod": 593,
  "ApPaiNombre": "Ecuador",
  "ApRegCod": 2,
  "ApRegDes": "Quito",
  "ApRegGeo": "Ecuador, Quito",
  "gx_md5_hash": "C72816549823E038BBF6D05560DBB5D1"
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "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
languagejson
{
  "error": {
    "code":"0",
    "msage":"This service needs an Authorization Header"
  }
}

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
{
  "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

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" , "region" , "departamento" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History