Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite el ingreso al sistemas de clientes (asociados / socios), permitiendo cargar de detalles específicos del cliente (asociado / socio) en la Aplicación SIFCO WEB, permitiendo incluir, agregar o modificar solo las diferentes tipos de direcciones del cliente con sus detalles respectivos, que ya haya sido creado a través de el Web Service (TClClientes). Es importante acotar que para la correcta carga de todos los parámetros de un cliente se deben consumir todos los Web Services de Consulta de Categorías Generales, dado a que ellos les permitan conocer todas las diferentes opciones de parámetros de clientes registrados en la Aplicación SIFCO WEB.
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: "TClDirecciones" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/GQDV" produces: - application/json paths: /TClDirecciones/{ClCliCod}: get: tags: - TClDirecciones operationId: "GetTClDirecciones" summary: "Consultar las Direcciones de un Cliente 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: "ClCliCod" in: "path" description: "Código del Cliente" required: true type: "integer" format: "int64" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TClDirecciones" 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: - TClDirecciones operationId: "InsertTClDirecciones" summary: "Insertar las Direcciones de un Cliente 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: "ClCliCod" in: "path" description: "Código del Cliente" required: true type: "integer" format: "int64" - name: "TClDirecciones" in: "body" description: "SDT of TClDirecciones" required: false schema: $ref: "#/definitions/TClDirecciones" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TClDirecciones" 201: description: "Created" schema: $ref: "#/definitions/TClDirecciones" 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: - TClDirecciones operationId: "UpdateTClDirecciones" summary: "Actualizar las Direcciones de un Cliente 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: "ClCliCod" in: "path" description: "Código del Cliente" required: true type: "integer" format: "int64" - name: "TClDirecciones" in: "body" description: "SDT of TClDirecciones" required: true schema: $ref: "#/definitions/TClDirecciones" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/TClDirecciones" 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: "TClDirecciones was changed" 500: description: "Internal server error" schema: $ref: "#/definitions/GxJsonError" deletesecurity: - OAuth2: [] tags ApiKeyAuth1: [] securityDefinitions: OAuth2: - TClDireccionestype: oauth2 operationIdflow: "DeleteTClDirecciones"password tokenUrl: summary: "Eliminar las Direcciones de un Cliente en el Sistema" parameters: https://test.sifco.org/DemoCoopGT/oauth/access_token scopes: Execute: Permite el método tipo GET - inInsert: headerPermite el método tipo POST nameUpdate: Content-TypePermite el método tipo PUT typeDelete: "string"Permite el método tipo DELETE requiredFullControl: truePermite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre default: application/json el Web Service ApiKeyAuth1: - intype: headerapiKey in: header name: Authorizationgranttype definitions: TClDirecciones: typeproperties: "string" ClCliCod: required description: trueCódigo del Cliente defaulttype: "integer" OAuth <Access Token> format: "int64" - in: header ClNomSocio: namedescription: GENEXUS-AGENTNombre del Cliente type: "string" DirCorreE: required: true description: Correo Electrónico default: SmartDevice Application type: "string" - name: "ClCliCod" DirCorreE2: indescription: "path"Correo Electrónico Alternativo descriptiontype: "string"Código del Cliente" ClExcluirCorreosElectronicos: required: true description: Excluir de Correos Electrónicos type: "integer" format: "int64int32" responsesDirUlt: 200description: Ultimo Correlativo Direcciones descriptiontype: "Successful operationinteger" schemaformat: "int32" gx_md5_hash: $ref: "#/definitions/TClDirecciones" description: gx_md5_hash is an identifier 204:for a specific version of a resource, it is used for description:optimistic "Successful operation" schema: concurrency check. It is required for update and delete operations and ignored on insert. $reftype: "#/definitions/TClDireccionesstring" 400Level1: description$ref: "Bad request#/definitions/TClDirecciones.Level1Item" required: schema: - ClCliCod TClDirecciones.Level1Item: $refproperties: "#/definitions/GxJsonError" 401: DirCor: description: "NotCorrelativo Authenticated"de Dirección schematype: "integer" $refformat: "#/definitions/GxJsonErrorint32" 404DirTipo: description: "NotTipo found"de Dirección schematype: "integer" $refformat: "#/definitions/GxJsonError"int32" DirDireccion: 500description: Dirección descriptiontype: "Internal server error" "string" DirPaiCod: schemadescription: Código País dirección $reftype: "#/definitions/GxJsonError"integer" security: - OAuth2format: [] "int64" ApiKeyAuth1DirPaiNom: [] securityDefinitions: OAuth2description: Nombre País type: oauth2 flowtype: password"string" tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token DirRegCod: scopes: Executedescription: PermiteCódigo elRegión métodoDirección tipo GET Inserttype: Permite"integer" el método tipo POST format: "int64" Update: Permite el método tipo PUT DirRegDes: Delete: Permite el método tipodescription: DELETEDescripción Región FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service ApiKeyAuth1:type: "string" DirDepCod: typedescription: apiKeyCódigo Departamento Dirección in: header nametype: granttype"integer" definitions: TClDirecciones: format: "int64" properties: ClCliCodDirDepDes: description: CódigoDescripción delDepartamento Cliente type: "integerstring" formatDirMunCod: "int64" ClNomSociodescription: Código Municipio Dirección description: Nombre del Clientetype: "integer" typeformat: "stringint64" DirCorreEDirMunDes: description: CorreoDescripción ElectrónicoMunicipio type: "string" DirCorreE2DirCodPostal: description: CorreoCódigo Electrónico AlternativoPostal type: "string" ClExcluirCorreosElectronicosDirGeolocalizacion: description: Excluir deGeolocalización Correos Electrónicos type: "integerstring" DirNombreEmpresa: format: "int32" DirUltdescription: Nombre de la empresa description: Ultimo Correlativo Direccionesdonde labora type: "integerstring" formatDirPuesto: "int32" gx_md5_hashdescription: Puesto en la empresa 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" DirDirDespliegue: description: Despliegue de Dirección type: "string" Level1DirActCodEmpresa: $refdescription: "#/definitions/TClDirecciones.Level1Item" Código actividad económica empresa required: type: "integer" - ClCliCod TClDirecciones.Level1Item: format: "int32" properties: DirCorDirActDesEmpresa: description: Descripción Correlativoactividad deeconómica Direcciónempresa type: "integerstring" formatrequired: "int32" - DirCor DirTipo: x-gx-level: "TClDirecciones" descriptionGxJsonError: Tipo de Dirección properties: typeerror: "integer" format$ref: "int32#/definitions/GxJsonError.error" DirDireccionGxJsonError.error: descriptionproperties: Dirección type: "string" code: DirPaiCod: description: Código Paísde direcciónError type: "integerstring" formatmessage: "int64" DirPaiNomdescription: Mensaje description: Nombre Paísde Error type: "string" DirRegCod: description: Código Región Dirección type: "integer" format: "int64" DirRegDes: description: Descripción Región type: "string" DirDepCod: description: Código Departamento Dirección type: "integer" format: "int64" DirDepDes: description: Descripción Departamento type: "string" DirMunCod: description: Código Municipio Dirección type: "integer" 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 |
---|---|
TClDirecciones >TClDirecciones.Level1Item | |
DirTipo (TipoDirecciones) | Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.. |
DirPaiCod | |
DirRegCod | |
DirDepCod | |
DirActCodEmpresa |
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 la carga de las direcciones de las que dispone el Cliente con sus detalles en la Aplicación SIFCO WEB.
El siguiente ejemplo inserta las direcciones a un Cliente en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
BODY:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
TClClientes
ClTipPersona
Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.
ApTidCod
ClPaiCod
ClRegCod
ClDepCod
ClSexo
Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.
ClEstCivil
Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.
GrAfCodigo
ApPrmCod
ClImpuestos
Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.
ClEstado
Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.
ApActCod
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 la Creación de Clientes en la Aplicación SIFCO WEB.
El siguiente ejemplo inserta un cliente en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | |||||
---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
| |||||
200 (Successful operation) Operación Exitosa |
| |||||
201 (Created)200 (Operación Exitosa(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 tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Clientes, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución. |
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
| ||||||||||||
|