Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Web Services para Registrar o Modificar Regiones de un País.
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: - TApRegion operationId: "UpdateTApRegionGetTApRegion" summary: "ActualizarConsultar 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" responses: in200: "body" description: "SDTSuccessful of TApRegion" required: trueoperation" schema: $ref: "#/definitions/TApRegion" responses: 200400: description: "SuccessfulBad operationrequest" schema: $ref: "#/definitions/TApRegionGxJsonError" 400401: description: "BadNot requestAuthenticated" schema: $ref: "#/definitions/GxJsonError" 401404: description: "Not AuthenticatedData with the specified key could not be found" schema: $ref: "#/definitions/GxJsonError" 404500: description: "NotInternal server founderror" schema: $ref: "#/definitions/GxJsonError" post: 409: tags: description: "TApRegion was changed" - TApRegion 500operationId: "InsertTApRegion" descriptionsummary: "Internal server error" schema: Insertar las Regiones de un País Registrados en el Sistema" parameters: $ref: "#/definitions/GxJsonError" - deletein: header tags: name: Content-Type - TApRegion operationIdtype: "DeleteTApRegionstring" summary: "Eliminar las Regiones de unrequired: Paístrue Registrados en el Sistema" parametersdefault: application/json - in: header name: Content-TypeAuthorization type: "string" required: true default: application/jsonOAuth <Access Token> - in: header name: AuthorizationGENEXUS-AGENT type: "string" required: true default: OAuthSmartDevice <AccessApplication Token> - inname: header"ApPaiCod" namein: GENEXUS-AGENT"path" typedescription: "stringCódigo" required: true default: SmartDevice Applicationtype: "integer" format: "int64" - name: "ApPaiCodApRegCod" in: "path" description: "Código División Geográfica" required: true type: "integer" format: "int64" - name: "ApRegCodTApRegion" in: "pathbody" description: "CódigoSDT Divisiónof GeográficaTApRegion" required: truefalse typeschema: "integer" format$ref: "int64#/definitions/TApRegion" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TApRegion" 204201: description: "Successful operationCreated" schema: $ref: "#/definitions/TApRegion" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "NotData with the specified key could not be 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 Región 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" |
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 | ||
---|---|---|---|
TApActEconomica | ApActCod | WSActividadEconomicaListaTApRegion | |
ApPaiCod | |||
ApRegCod |
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 Países una Región de un País registrado en la Aplicación SIFCO WEB.
El siguiente ejemplo crea un una Región de una País en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS:
BODY:
| |||||||||||||||
201 (Created) (Registro Creado con Éxito) |
| |||||||||||||||
400 (Bad Request). Solicitud Errada |
| |||||||||||||||
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) ). |
| |||||||||||||||
404 (Not Found). | Respuesta Vacía (Web Service, no encontrado) | |||||||||||||||
500 (Internal Server Error) (Error Interno del Servidor de las API’s REST). |
|
Info |
---|
INFORMACIÓN Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de ErroresMensajes) External Call Out, donde se describe el listado de errores 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. |
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Enlaces Relevantes | ||||||||||||
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
| ||||||||||||
|