Versions Compared

Old Version 4

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

compared with

New Version 5

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Web Services para Registrar o Modificar los Teléfonos de un Cliente.

Swagger open api macroswagger: '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**, como es Registrar o Modificar los teléfonos de un cliente 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: - https - http basePath: /<APPDIR>/rest tags: - name: "TClTelefonos" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/JADT" produces: - application/json paths: /TClTelefonos/{ClCliCod}: get: tags: - TClTelefonos operationId: "GetTClTelefonos

DESCRIPCIÓN.

Este Web Service, permite el ingreso al sistemas de clientes (asociados / socios), permitiendo cargar solo los números telefónicos de que dispone el 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 los parámetros de un cliente respectivo a este Web Service, se deben revisar las Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB, dado a que ellos les permitan conocer todas las constantes preestablecidas 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"  
    summaryurl: "Consultar los Telefonos de un Cliente en el Sistema"
      parameters:
        - in: header
     http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "TClTelefonos"
  externalDocs:
    description: "Manual SIFCO"
    name: Content-Type
url: "https://sifco.atlassian.net/wiki/x/JADT"
produces:
  - application/json
paths:
  /TClTelefonos/{ClCliCod}:
 type: "string"  get:
      tags:
 required: true      - TClTelefonos
   default: application/json  operationId: "GetTClTelefonos"
     - insummary: header"Consultar los Telefonos de un Cliente en el Sistema"
  name:  Authorization  parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: OAuthapplication/json
<Access Token>         - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: SmartDeviceOAuth <Access ApplicationToken>
        - namein: "ClCliCod"header
          inname: "path"GENEXUS-AGENT
          descriptiontype: "Código del Clientestring"
          required: true
          typedefault: "integerSmartDevice Application
        - name: "ClCliCod"
          formatin: "int64path"
          description: "Código del Cliente"
responses:          200required: true
          descriptiontype: "Successful operationinteger"
          schemaformat: "int64"
      
    $ref: "#/definitions/TClTelefonos"  responses:
        400200:
          description: "BadSuccessful requestoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClTelefonos"
        401400:
          description: "NotBad Authenticatedrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
        404401:
          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:
        - TClTelefonos
      operationId: "InsertTClTelefonos"
      summary: "Insertar los Telefonos 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: "TClTelefonos"
          in: "body"
          description: "SDT of TClTelefonos"
          required: false
          schema:
            $ref: "#/definitions/TClTelefonos"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClTelefonos"
        201:
          description: "Created"
          schema:
            $ref: "#/definitions/TClTelefonos"
        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:
        - TClTelefonos
      operationId: "UpdateTClTelefonos"
      summary: "Actualizar los Telefonos 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: "TClTelefonos"
          in: "body"
          description: "SDT of TClTelefonos"
          required: true
          schema:
            $ref: "#/definitions/TClTelefonos"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClTelefonos"
        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: "TClTelefonos was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - TClTelefonos
      operationId: "DeleteTClTelefonos"
      summary: "Eliminar los Telefonos 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/TClTelefonos"
        204:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClTelefonos"
        400:
          description: "Bad request"
          schema:
schema:
            $ref: "#/definitions/TClTelefonos"
        204:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClTelefonos"
        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:

  TClTelefonos:
    properties:
      ClCliCod:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClNomSocio:
        description: Nombre del Cliente
        type: "string"

      TelUlt:
        description: Ultimo correlativo de teléfono
        type: "integer"
        format: "int32"

      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"

      Level1:
        $ref: "#/definitions/TClTelefonos.Level1"

    required:
      - ClCliCod

  TClTelefonos.Level1:
    properties:
      TelCor:
        description: Correlativo por cliente
        type: "integer"
        format: "int32"

      TelTipo:
        description: Tipo de teléfono
        type: "integer"
        format: "int32"

      TelNumero:
        description: Número telefónico
        type: "string"

      TelObservacion:
        description: Observaciones
        type: "string"


    required:
      - TelCor
    x-gx-level: "TClTelefonos"

  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

TClClientes

ClTipPersona

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ApTidCod

WSApTiposIdentificacionLista

ClPaiCod

WSApPaisLista

ClRegCod

WSApDepartamentoLista

ClDepCod

WSApMunicipioLista

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

WSClGruposLista

ApPrmCod

WSApUsuariosSistemaLista

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

WSActividadEconomicaLista

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:

Code Block
https://test.sifco.org/democoopgt/rest/tcldirecciones/3

HEADERS

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

BODY:

Code Block
{
    "ClCliCod": "3",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "TelUlt": 2,
    "Level1": [
          {
$ref:
"#/definitions/GxJsonError"
401:
    "TelCor": 1,
description:
"Not
Authenticated"
       "TelTipo": 1,
schema:
$ref
"TelNumero": "
#/definitions/GxJsonError
25124597",
404:
description
"TelObservacion": "
Not found
"
schema:
},
          {
$ref:
"#/definitions/GxJsonError"
500:
   "TelCor": 2,
description:
"Internal
server
error"
     "TelTipo": 3,
schema:
$ref
"TelNumero": "
#/definitions/GxJsonError" security:
58947846",
-
OAuth2:
[]
ApiKeyAuth1:
[]
securityDefinitions:
OAuth2
"TelObservacion": 
""
type:
oauth2
flow:
password
 }
tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
 ],
scopes
"ClExcluirCorreosElectronicos": 0,
Execute: Permite el método tipo GET 
"gx_md5_hash": "39A53705754A6415A5C94C1B46388896"
}

200 (Successful operation)

Operación Exitosa

Code Block
{
    "ClCliCod": "3",
Insert
"ClNomSocio":
Permite
"ANA
el
MARIA
método
DEL
tipo
CARMEN
POST
MUJER CIFUENTES GONZALEZ",
Update
"TelUlt":
Permite
2,
el
método
tipo
PUT
 "Level1": [
Delete:
Permite
el
método
tipo
DELETE
 {
FullControl:
Permite
el
manejo
de
los
Cuatro
Métodos
GET, POST, PUT,DELETE, sobre el Web Service
 "TelCor": 1,
ApiKeyAuth1:
type:
apiKey
in
"TelTipo":
header 
1,
name:
granttype
definitions:
TClTelefonos:
properties
"TelNumero": "25124597",
ClCliCod:
description
"TelObservacion":
Código
""
del
Cliente
        },
type:
"integer"
format:
{
"int64"
ClNomSocio:
      "TelCor": 2,
description:
Nombre
del
Cliente
type:
 "
string
TelTipo": 3,
TelUlt:
        "TelNumero": "58947846",
description:
Ultimo
correlativo
de
teléfono
type
"TelObservacion": "
integer
"
format:
"int32"
 }
    ],
gx_md5_hash:
   "ClExcluirCorreosElectronicos": 0,
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. 
"39A53705754A6415A5C94C1B46388896"
}

201 (Created)

(Registro Creado con Éxito)

Code Block
languagejson
{
    "ClCliCod": "3",
    "ClNomSocio": "ANA MARIA DEL CARMEN MUJER CIFUENTES GONZALEZ",
    "TelUlt": 2,
    "Level1": [
type:
"string"
   {
Level1:
$ref:
 "
#/definitions/TClTelefonos.Level1" required:
TelCor": 1,
-
ClCliCod
TClTelefonos.Level1
"TelTipo": 1,
properties:
TelCor:
    "TelNumero": "25124597",
description:
Correlativo
por
cliente
type
"TelObservacion": "
integer
"
format:
"int32"
 },
TelTipo:
    {
description:
Tipo
de
teléfono
type: 
"
integer
TelCor": 2,
format: "int32"
TelNumero
"TelTipo": 3,
description:
Número
telefónico
type
"TelNumero": "
string
58947846",
TelObservacion:
       "TelObservacion": ""
description:
Observaciones
type:
}
"string"
    ],
required:
  "ClExcluirCorreosElectronicos": 0,
- TelCor x-gx-level: "TClTelefonos"
 "gx_md5_hash": "39A53705754A6415A5C94C1B46388896"
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "error": {
GxJsonError:
"code": "string",
properties
"message": "string"
error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Código de Error type: "string" message: description: Mensaje de Error type
}
}

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
languagejson
{
  "error": {
    "code":"0",
    "message":"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
languagejson
{
  "error": {
    "code": "string",
    "message": "string"
x-gx-level: "GxJsonError"
}
}
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 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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" , "telefonos" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History