Versions Compared

Old Version 5

changes.mady.by.user Alfredo Lopez

Saved on

compared with

New Version 6

changes.mady.by.user Alfredo Lopez

Saved on

Key

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

Web Services para Registrar o Modificar los Campos Definidos por el administrador o usuario del Sistema, para Grupos de Clientes.

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 Campos Definidos por el usuario del sistema, para 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: "TClCalClientes" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/MYDU" produces: - application/json paths: /TClCalClientes/{ClCliCod}: get: tags: - TClCalClientes operationId: "GetTClCalClientes" summary: "Consultar

DESCRIPCIÓN.

Este Web Service, permite el ingreso al sistemas de clientes (asociados / socios), permitiendo asignar a un Cliente Campos Definidos por el Administrador o también llamados Calificadores Adicionales en la Aplicación SIFCO WEB, 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 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"
  description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Registrar o Modificar los Campos Definidos por el usuario del sistema, depara un Clientecliente en el Sistema"
  la **Aplicación SIFCO WEB** ."
   parameterstermsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    - inemail: header"soporte@sifco.org"
  license:
       name: Content-Type
"Apache 2.0"  
    url:   type"http://www.apache.org/licenses/LICENSE-2.0.html"
host: "string<SERVER>"
schemes:
  - https
  - http
 requiredbasePath: /<APPDIR>/rest
tags:
true- name: "TClCalClientes"
  externalDocs:
     defaultdescription: application/json
"Manual SIFCO"
    url:   - in: header
          name: Authorization"https://sifco.atlassian.net/wiki/x/MYDU"
produces:
  - application/json
paths:
  /TClCalClientes/{ClCliCod}:
    get:
      typetags:
"string"        - TClCalClientes
      operationId: "GetTClCalClientes"
      requiredsummary: true
       "Consultar los Campos Definidos por el usuario del sistema, de un Cliente en el Sistema"
   default: OAuth <Access Token>parameters:
        - in: header
          name: GENEXUSContent-AGENTType
          type: "string"
          required: true
          default: SmartDeviceapplication/json
Application         - namein: "ClCliCod"header
          inname: Authorization
"path"           descriptiontype: "Código del Clientestring"
          required: true
          typedefault: "integer"
OAuth <Access Token>
        - formatin: "int64"header
          name: GENEXUS-AGENT
 responses:         200type: "string"
          descriptionrequired: "Successfultrue
operation"           schemadefault: SmartDevice Application
        -  $refname: "#/definitions/TClCalClientesClCliCod"
         400 in: "path"
          description: "BadCódigo del requestCliente"
          schemarequired: true
          type: "integer"
          $refformat: "#/definitions/GxJsonError"int64"
      
      responses:
        401200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClCalClientes"
        404400:
          description: "Data with the specified key could not be foundBad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        500401:
          description: "InternalNot server errorAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        post404:
      tags:    description: "Data with the specified -key TClCalClientescould not be found"
   operationId: "InsertTClCalClientes"      schema:
summary: "Insertar los Campos Definidos por el usuario del sistema, de un Cliente en el Sistema"$ref: "#/definitions/GxJsonError"
        parameters500:
        -  indescription: header"Internal server error"
         name: Content-Type schema:
            type$ref: "string#/definitions/GxJsonError"

    post:
      requiredtags:
true        - TClCalClientes
 default: application/json    operationId: "InsertTClCalClientes"
   - in: header summary: "Insertar los Campos Definidos por el usuario del sistema, name:de Authorizationun Cliente en el Sistema"
      typeparameters:
"string"        -   requiredin: trueheader
          defaultname: OAuth <Access Token>Content-Type
         - intype: header"string"
          namerequired: GENEXUS-AGENTtrue
          typedefault: "string"application/json
        -  requiredin: trueheader
          defaultname: SmartDeviceAuthorization
Application         - nametype: "ClCliCodstring"
          inrequired: "path"true
          descriptiondefault: "CódigoOAuth del<Access Cliente"Token>
        -  requiredin: trueheader
          typename: "integer"GENEXUS-AGENT
          formattype: "int64string"
        -  namerequired: "TClCalClientes"true
          indefault: "body"SmartDevice Application
        - descriptionname: "SDT of TClCalClientesClCliCod"
          requiredin: false"path"
          schemadescription: "Código del Cliente"
          $refrequired: "#/definitions/TClCalClientes"true
       responses:   type:  "integer"
   200:           descriptionformat: "Successful operationint64"
        -  schemaname: "TClCalClientes"
           $refin: "#/definitions/TClCalClientesbody"
        201:  description: "SDT of TClCalClientes"
          descriptionrequired: "Created"false
          schema:
            $ref: "#/definitions/TClCalClientes"

       400responses:
        200:
          description: "BadSuccessful requestoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClCalClientes"
        401201:
          description: "Not AuthenticatedCreated"
          schema:
            $ref: "#/definitions/GxJsonErrorTClCalClientes"
        404400:
          description: "Data with the specified key could not be foundBad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        500401:
          description: "InternalNot server errorAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
      put  404:
      tags:    description: "Data with the specified -key TClCalClientescould not be found"
   operationId: "UpdateTClCalClientes"      schema:
summary: "Actualizar los Campos Definidos por el usuario del sistema, de un Cliente en el Sistema"$ref: "#/definitions/GxJsonError"
        parameters500:
        -  indescription: header
"Internal server error"
         name schema:
Content-Type            type$ref: "string#/definitions/GxJsonError"

    put:
      requiredtags:
true        - TClCalClientes
 default: application/json    operationId: "UpdateTClCalClientes"
   - in: header summary: "Actualizar los Campos Definidos por el usuario del sistema, name:de Authorizationun Cliente en el Sistema"
      typeparameters:
"string"        -   requiredin: trueheader
          defaultname: OAuth <Access Token>Content-Type
         - intype: header"string"
          namerequired: GENEXUS-AGENTtrue
          typedefault: "string"application/json
        -  requiredin: trueheader
          defaultname: SmartDeviceAuthorization
Application         - nametype: "ClCliCodstring"
          inrequired: "path"true
          descriptiondefault: "CódigoOAuth del<Access Cliente"Token>
        -  requiredin: trueheader
          typename: "integer"GENEXUS-AGENT
          formattype: "int64string"
        -  namerequired: "TClCalClientes"true
          indefault: "body"SmartDevice Application
        - descriptionname: "SDT of TClCalClientesClCliCod"
          requiredin: true"path"
          schemadescription: "Código del Cliente"
          $refrequired: "#/definitions/TClCalClientes"true
          type: "integer"
 responses:         200format: "int64"
        - descriptionname: "Successful operationTClCalClientes"
          schemain: "body"
           $refdescription: "#/definitions/SDT of TClCalClientes"
        400  required: true
         description schema:
"Bad request"           schema$ref: "#/definitions/TClCalClientes"
      
    $ref: "#/definitions/GxJsonError"  responses:
        401200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClCalClientes"
        404400:
          description: "NotBad foundrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
        409401:
          description: "TClCalClientesNot Authenticated"
was changed"         500schema:
          description: "Internal server$ref: error"
"#/definitions/GxJsonError"
         schema404:
            $refdescription: "#/definitions/GxJsonErrorNot found"
     delete:       tagsschema:
        - TClCalClientes       operationId$ref: "DeleteTClCalClientes"#/definitions/GxJsonError"
        summary409:
"Eliminar  los Campos Definidos por el usuario del sistema, dedescription: un"TClCalClientes Clientewas enchanged"
el Sistema"       parameters500:
        - in: header description: "Internal server error"
          nameschema:
Content-Type            type$ref: "string#/definitions/GxJsonError"

    delete:
    required  tags:
true        - TClCalClientes
 default: application/json    operationId: "DeleteTClCalClientes"
   - in: header summary: "Eliminar los Campos Definidos por el usuario del sistema, name:de Authorizationun Cliente en el Sistema"
      typeparameters:
"string"           required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUSContent-AGENTType
          type: "string"
          required: true
          default: SmartDevice Applicationapplication/json
        - namein: "ClCliCod"header
          inname: "path"Authorization
          descriptiontype: "Código del Clientestring"
          required: true
          typedefault: "integer"OAuth <Access Token>
        format: "int64"- in: header
          responsesname: GENEXUS-AGENT
       200:   type: "string"
          descriptionrequired: "Successfultrue
operation"           schemadefault: SmartDevice Application
        -  $refname: "#/definitions/TClCalClientesClCliCod"
        204  in: "path"
          description: "SuccessfulCódigo del operationCliente"
          schemarequired: true
           $reftype: "#/definitions/TClCalClientesinteger"
        400:  format: "int64"

      responses:
        200:
          description: "BadSuccessful requestoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClCalClientes"
        401204:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTClCalClientes"
        404400:
          description: "NotBad foundrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
        500401:
          description: "InternalNot server errorAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
    security:   - OAuth2404:
[]     ApiKeyAuth1: [] securityDefinitions:   OAuth2description: "Not found"
  type: oauth2
    flow: password     tokenUrlschema:
https://test.sifco.org/DemoCoopGT/oauth/access_token     scopes:       Execute$ref: Permite el método tipo GET"#/definitions/GxJsonError"
        500:
 Insert: Permite el método tipo POST    description: "Internal server Update:error"
Permite el método tipo PUT       Deleteschema:
Permite el método tipo DELETE       FullControl $ref: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service"#/definitions/GxJsonError"


security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  typeOAuth2:
apiKey     intype: headeroauth2
    nameflow: granttypepassword
 definitions:   tokenUrl: TClCalClientes:https://test.sifco.org/DemoCoopGT/oauth/access_token
    propertiesscopes:
      ClCliCodExecute: Permite el método tipo GET
    description  Insert: CódigoPermite delel Clientemétodo tipo POST
      typeUpdate: "integer"
  Permite el método tipo PUT
      formatDelete: "int64"
 Permite el método tipo DELETE
      ClNomSocioFullControl: Permite el manejo de los Cuatro Métodos GET,  description: Nombre del Cliente
POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: "string"apiKey
       gx_md5_hashin: header
    name: granttype

descriptiondefinitions:
gx_md5_hash
is an identifierTClCalClientes:
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.properties:
      ClCliCod:
        description: Código del Cliente
        type: "stringinteger"
       Level1 format: "int64"

      $refClNomSocio: "#/definitions/TClCalClientes.Level1Item"
        requireddescription: Nombre del Cliente
   - ClCliCod    TClCalClientes.Level1Itemtype: "string"

  properties:       ApCalCodgx_md5_hash:
        description: Códigogx_md5_hash is an identifier for a specific version of type: "integer"
        format: "int32"

      ApCalDes:a resource, it is used for optimistic concurrency check. It is required for update and delete operations and  ignored on insert.
        descriptiontype: Descripción"string"

       typeLevel1:
"string"        ApCalEti$ref: "#/definitions/TClCalClientes.Level1Item"

    required:
 description: Etiqueta    - ClCliCod

  typeTClCalClientes.Level1Item:
"string"
    properties:
      ApCalTipoApCalCod:
        description: TipoCódigo
de Calificador         type: "integer"
        format: "int32"

      ApCalObligatorioApCalDes:
        description: IndicaDescripción
si es Obligatorio
        type: "integer"string"

      ApCalEti:
        description: Etiqueta
        formattype: "int32string"

      ClCalVNumApCalTipo:
        description: ValorTipo Numérico de Calificador
        type: "numberinteger"
        format: "doubleint32"

      ClCalVAlfaApCalObligatorio:
        description: Indica si es Obligatorio
        type: "integer"
Valor Alfanumérico de Calificador
        type: "string"

      ClCalVFecha:
        description: Valor Fecha de Calificador
        type: "string"
        format: "date"

      ClCalVCarter:
        description: Valor Carácter Calificador
        type: "string"


    required:
      - ApCalCod
    x-gx-level: "TClCalClientes"

  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"        format: "int32"

      ClCalVNum:
        description: Valor Numérico de Calificador
        type: "number"
        format: "double"

      ClCalVAlfa:
        description: Valor Alfanumérico de Calificador
        type: "string"

      ClCalVFecha:
        description: Valor Fecha de Calificador
        type: "string"
        format: "date"

      ClCalVCarter:
        description: Valor Carácter Calificador
        type: "string"


    required:
      - ApCalCod
    x-gx-level: "TClCalClientes"

  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 una Calificador Adicional a un Cliente en la Aplicación SIFCO WEB.

El siguiente ejemplo se agrega un Calificador Adicional o Campo Definidos por el Administrador a un cliente en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS

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

BODY:

Code Block
200 (Successful operation)
Operación Exitosa
 Code Block
201 (Created)
(Registro Creado con Éxito)
 Code Block
400 (Bad Request).
Solicitud Errada
 Code Block
languagejson
{
  "error": {
    "code": "string",
    "message": "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 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" , "campos" , "definidos" , "usuarios" , "grupos" , "afinidad" ) and type = "page" and space = "DOC"
Artículos Actualizados Recientemente
 Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
 Change History