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**, el cual permite consultar el Listado de Municipios de un Departamento Asociado a un Pais registrados 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:
- http
basePath: /<APPDIR>/rest
tags:
- name: "WSApMunicipioLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/"
produces:
- application/json
paths:
/WSApMunicipioLista:
post:
tags:
- WSApMunicipioLista
operationId: "WSApMunicipioLista"
summary: "Lista de Municipios"
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/WSApMunicipioListaOutput"
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 metodo tipo GET
Insert: Permite el metodo tipo POST
Update: Permite el metodo tipo PUT
Delete: Permite el metodo tipo DELETE
FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
WSApMunicipioListaOutput:
properties:
MunicipioLista:
description: WSAp Departamento SDT
type: array
items:
$ref: "#/definitions/WSApDepartamentoSDT_Municipio"
WSApDepartamentoSDT_Municipio:
properties:
CodigoPais:
description: Código
type: "integer"
format: "int64"
CodigoDepartamento:
description: Código División Geográfica
type: "integer"
format: "int64"
CodigoMunicipio:
description: Código Sub-División Geográfica
type: "integer"
format: "int64"
Descripcion:
description: Descripción Sub-División Geográfica
type: "string"
URI:
description: URI
type: "string"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
description: Codigo de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError"
DESCRIPCIÓN.
Este Web Service, permite consultar el listado de Municipios, Alcaldías o Localidades registrados en la Aplicación SIFCO WEB, es importante tomar en cuenta que cada Municipio, Alcaldía o Localidad, según sea el caso, esta asociado a un Región de una País. 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 Regiones o Departamentos (WSApDepartamentoLista), y poder definir la ubicación exacta del cliente.
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: "WSApMunicipioLista"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/0YCn"
produces:
- application/json
paths:
/WSApMunicipioLista:
post:
tags:
- WSApMunicipioLista
operationId: "WSApMunicipioLista"
summary: "Lista de Municipios"
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/WSApMunicipioListaOutput"
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:
WSApMunicipioListaOutput:
properties:
MunicipioLista:
description: WSAp Departamento SDT
type: array
items:
$ref: "#/definitions/WSApDepartamentoSDT_Municipio"
WSApDepartamentoSDT_Municipio:
properties:
CodigoPais:
description: Código
type: "integer"
format: "int64"
CodigoDepartamento:
description: Código División Geográfica
type: "integer"
format: "int64"
CodigoMunicipio:
description: Código Sub-División Geográfica
type: "integer"
format: "int64"
Descripcion:
description: Descripción Sub-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 Municipios o Alcaldías registrados en la Aplicación SIFCO WEB
El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.
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.