Page Comparison

DESCRIPCIÓN.

Este Web Service, permite consultar el listado de Departamentos o Regiones registrados en la Aplicación SIFCO WEB, es importante tomar en cuenta que cada Región, Estado o Departamento, según sea el caso, esta asociado a un País. Y a su vez cada Región, Estado o Departamento tienen asociados Municipios, Alcaldías o Departamentos locales según sea necesario. Por ello es importante consumir este Web Service, previo a ingresar un cliente en la Aplicación SIFCO WEB, junto a los correspondientes a Países (WSApPaisLista) y Municipios (WSApMunicipioLista), y poder definir la ubicación exacta del cliente.

Swagger open api macro

Note
ADVERTENCIAS

Warning

ERRORES COMUNES

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: "WSApDepartamentoLista"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/hICo"
produces:
  - application/json
paths:
  /WSApDepartamentoLista:
    post:
      tags:
        - WSApDepartamentoLista
      operationId: "WSApDepartamentoLista"
      summary: "Lista de Departamentos"
      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

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/WSApDepartamentoListaOutput"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        400:
          description: "Bad request"
          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:

  WSApDepartamentoListaOutput:
    properties:
      DepartamentoLista:
        description: WSAp Región SDT
        type: array
        items:
          $ref: "#/definitions/WSApRegionSDT_Departamento"

  WSApRegionSDT_Departamento:
    properties:
      CodigoPais:
        description: Código de País
        type: "integer"
        format: "int64"

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

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

      URI:
        description: URI
        type: "string"

  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"

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 Obtenerel Listado de Departamentos o Regiones registrados en la Aplicación SIFCO WEB

El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/WSApDepartamentoLista

HEADERS

Code Block

language	json

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

200 (Operación Exitosa)

Code Block

language	json

{
  "DepartamentoLista": [
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 1,
        "Descripcion": "Guatemala",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 4,
        "Descripcion": "Chimaltenango",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 5,
        "Descripcion": "Chiquimula",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 6,
        "Descripcion": "Petén",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 7,
        "Descripcion": "Quiché",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 8,
        "Descripcion": "Escuintla",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 9,
        "Descripcion": "Huehuetenango",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 10,
        "Descripcion": "Izabal",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 11,
        "Descripcion": "Jalapa",
        "URI": ""
      },
      {
        "CodigoPais": 320,
        "CodigoDepartamento": 12,
        "Descripcion": "Jutiapa",
        "URI": ""
      },
      {
        "CodigoPais": 593,
        "CodigoDepartamento": 1,
        "Descripcion": "Pichincha",
        "URI": ""
      }
    ],
}

400 (Bad Request).

Solicitud Errada

Code Block

language	json

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

language	json

{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "DepartamentoLista":  []
}

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

language	json

{
  "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
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Code Block

language	json

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 1

New Version Current

Key

DESCRIPCIÓN.

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