Page Comparison

DESCRIPCIÓN.

Este Web Service, permite Consultar, Crear o Modificar Municipios o Localidades de una Región y de un 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 (TApRegion) 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: "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: 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: "ApDepCod"
          in: "path"
          description: "Código Sub-División Geográfica"
          required: true
          type: "integer"
          format: "int64"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApDepartamento"
        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:
        - TApDepartamento
      operationId: "InsertTApDepartamento"
      summary: "Insertar los Departamentos de una Región 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: "ApDepCod"
          in: "path"
          description: "Código Sub-División Geográfica"
          required: true
          type: "integer"
          format: "int64"
        - name: "TApDepartamento"
          in: "body"
          description: "SDT of TApDepartamento"
          required: false
          schema:
            $ref: "#/definitions/TApDepartamento"

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

    put:
      tags:
        - TApDepartamento
      operationId: "UpdateTApDepartamento"
      summary: "Actualizar los Departamentos de una Región 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: "ApDepCod"
          in: "path"
          description: "Código Sub-División Geográfica"
          required: true
          type: "integer"
          format: "int64"
        - name: "TApDepartamento"
          in: "body"
          description: "SDT of TApDepartamento"
          required: true
          schema:
            $ref: "#/definitions/TApDepartamento"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/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"
        409:
          description: "TApDepartamento was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - TApDepartamento
      operationId: "DeleteTApDepartamento"
      summary: "Eliminar los Departamentos de una Región 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: "ApDepCod"
          in: "path"
          description: "Código Sub-División Geográfica"
          required: true
          type: "integer"
          format: "int64"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApDepartamento"
        204:
          description: "Successful operation"
          schema:
            $ref: "#/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
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  TApDepartamento:
    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"

      ApDepCod:
        description: Código Sub-División Geográfica
        type: "integer"
        format: "int64"

      ApDepDes:
        description: Descripción Sub-División Geográfica
        type: "string"

      ApDepGeo:
        description: Geo-Ubicación de Sub-División Geográfica
        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
      - 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"

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
TApDepartamento
ApPaiCod	WSApPaisLista
ApRegCod	WSApDepartamentoLista
ApDepCod	WSApMunicipioLista

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 Municipios o Localidades de una Región y de un País registrados en la Aplicación SIFCO WEB.

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

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/TApDepartamento/593,1,1

HEADERS:

Code Block

language	json

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

BODY:

Code Block

language	json

{
  "ApPaiCod": 593,
  "ApPaiNombre": "Ecuador",
  "ApRegCod": 1,
  "ApRegDes": "Pichincha",
  "ApDepCod": 1,
  "ApDepDes": "Pichincha",
  "ApDepGeo": "Ecuador, Pichincha, Pichincha",
  "gx_md5_hash": "A10DEE1CBB329B5952C1181C999CB025"
}

201 (Created)

(Registro Creado con Éxito)

Code Block

language	json

{
  "ApPaiCod": 593,
  "ApPaiNombre": "Ecuador",
  "ApRegCod": 1,
  "ApRegDes": "Pichincha",
  "ApDepCod": 1,
  "ApDepDes": "Pichincha",
  "ApDepGeo": "Ecuador, Pichincha, Pichincha",
  "gx_md5_hash": "E2FA9D63AECE8D81E0DB881282936E87"
}

400 (Bad Request).

Solicitud Errada

Code Block
{ "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
{ "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 Errores) External Call Out, donde se describe el listado de errores 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

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 6

New Version 7

Key

DESCRIPCIÓN.

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

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente