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 direcciones 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: "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"

    delete:
      tags:
        - TClDirecciones
      operationId: "DeleteTClDirecciones"
      summary: "Eliminar 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"
        204:
          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"
        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 metodo tipo GET
      Insert: Permite el metodo tipo POST
      Update: Permite el metodo tipo PUT
      Delete: Permite el metodo tipo DELETE
      FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

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

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

      DirCorreE:
        description: Correo Electrónico
        type: "string"

      DirCorreE2:
        description: Correo Electrónico Alternativo
        type: "string"

      ClExcluirCorreosElectronicos:
        description: Excluir de Correos Electronicos
        type: "integer"
        format: "int32"

      DirUlt:
        description: Ultimo Correlativo Direcciones
        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/TClDirecciones.Level1Item"

    required:
      - ClCliCod

  TClDirecciones.Level1Item:
    properties:
      DirCor:
        description: Correlativo de Dirección
        type: "integer"
        format: "int32"

      DirTipo:
        description: Tipo de Dirección
        type: "integer"
        format: "int32"

      DirDireccion:
        description: Dirección
        type: "string"

      DirPaiCod:
        description: Código pais dirección
        type: "integer"
        format: "int64"

      DirPaiNom:
        description: Nombre Pais
        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"
        format: "int64"

      DirMunDes:
        description: Descripción Municipio
        type: "string"

      DirCodPostal:
        description: Código Postal
        type: "string"

      DirGeolocalizacion:
        description: Geolocalización
        type: "string"

      DirNombreEmpresa:
        description: Nombre de la empresa donde labora
        type: "string"

      DirPuesto:
        description: Puesto en la empresa
        type: "string"

      DirDirDespliegue:
        description: Despliegue de Dirección
        type: "string"

      DirActCodEmpresa:
        description: Código actividad economica empresa
        type: "integer"
        format: "int32"

      DirActDesEmpresa:
        description: Descripción actividad economica empresa
        type: "string"


    required:
      - DirCor
    x-gx-level: "TClDirecciones"

  GxJsonError:
    properties:
      error:
        $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"

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.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

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.