Versions Compared

Old Version 3

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

Saved on

compared with

New Version Current

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 telefonos 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" summary: "Consultar los Telefonos de un Cliente en el Sistema" parameters: - in: header name: Content-Type type: "string" required: true default: application/json

DESCRIPCIÓN.

Este Web Service, permite el ingreso de detalles específicos del cliente (asociado / socio) en la Aplicación SIFCO WEB, permitiendo incluir, agregar o modificar solo lo números telefónicos suministrados por el cliente con sus detalles respectivos. Es importante acotar que para la correcta carga de los parámetros de un cliente en este Web Service, se deben revisar las Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB., dado a que ellos les permitan conocer todos los valores y convenciones preestablecidos 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: "TClTelefonos"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/JADT"
produces:
  - application/json
paths:
  /TClTelefonos/{ClCliCod}:
    get:
      tags:
        - TClTelefonos
      operationId: "GetTClTelefonos"
      summary: "Consultar los Telefonos de un Cliente en el Sistema"
      parameters:
        - in: header
          name: AuthorizationContent-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: "integer"SmartDevice Application
        - formatname: "int64ClCliCod"
          in: "path"
 responses:         200description: "Código del Cliente"
         description required: "Successfultrue
operation"           schematype: "integer"
           $refformat: "#/definitions/TClTelefonosint64"
      
 400:     responses:
     description: "Bad request" 200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClTelefonos"
        401400:
          description: "NotBad Authenticatedrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
        404401:
          description: "Data with the specified key could not be foundNot Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        500404:
          description: "Internal server errorData with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
     post:   500:
   tags:       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"

   
deletesecurity:
  - OAuth2: []
 tags:   ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
- TClTelefonos   type: oauth2
  operationId: "DeleteTClTelefonos" flow: password
    summarytokenUrl: "Eliminar los Telefonos de un Cliente en el Sistema"https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el parameters: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:

  TClTelefonos:
    typeproperties:
"string"      ClCliCod:
    required    description: trueCódigo del Cliente
        defaulttype: OAuth <Access Token>"integer"
        format: "int64"

  - in: header  ClNomSocio:
        namedescription: GENEXUS-AGENTNombre del Cliente
        type: "string"

         requiredTelUlt:
true        description: Ultimo correlativo default:de SmartDeviceteléfono
Application         - nametype: "ClCliCodinteger"
          informat: "pathint32"

         description: "Código del Cliente"
          required: true
          type: "integer"
 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.
        formattype: "int64string"

      responsesLevel1:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClTelefonos"
        204:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TClTelefonos"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:$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

TClTelefonos

>TClTelefonos.Level1

TelTipo

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

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 agregar números de teléfono a un Cliente en la Aplicación SIFCO WEB.

El siguiente ejemplo inserta un numero de teléfono a un cliente en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS

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

BODY:

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

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
scopes
"ClCliCod": "3",
Execute
"ClNomSocio":
Permite
"ANA
el
MARIA
metodo
DEL
tipo
CARMEN
GET
MUJER CIFUENTES GONZALEZ",
Insert
"TelUlt":
Permite
2,
el
metodo
tipo
POST Update: Permite el metodo tipo PUT Delete: Permite el metodo tipo DELETE
 "Level1": [
          {
FullControl:
Permite
el
manejo
de
los
Cuatro
Metodos
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: Código del Cliente
"TelObservacion": ""
          },
type:
"integer"
format:
{
"int64"
ClNomSocio:
      "TelCor": 2,
description:
Nombre
del
Cliente
type:
 "
string
TelTipo": 3,
TelUlt:
       "TelNumero":
description: Ultimo correlativo de telefono
"58947846",
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. type: "string" 
"39A53705754A6415A5C94C1B46388896"
}

201 (Created)

(Registro Creado con Éxito)

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

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
GxJsonError
"error": {
properties
 "code":
 "string",
error
"message":
$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"
"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
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"
  }
}
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

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
languagejson
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