swagger/base.json

{
  "swagger": "2.0",
  "info": {
    "description": "API REST para Flowdat Base.",
    "version": "1.0.0",
    "title": "Base Flowdat"
  },
  "host": "flowdatHost",
  "basePath": "/api",
  "schemes": [
    "https"
  ],
  "paths": {
    "/tenancies.json": {
      "get": {
        "tags": [
          "Tenancy"
        ],
        "summary": "Lista las tenencias",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "description": "Cantidad de registros por página.",
            "default": 20,
            "type": "integer"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Número de página a buscar.",
            "default": 0,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tenancy"
              }
            }
          },
          "400": {
            "description": "Valor incorrecto."
          }
        }
      }
    },
    "/tenancies/{id}.json": {
      "get": {
        "tags": [
          "Tenancy"
        ],
        "summary": "Obtiene los datos de la tenencia",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id de la tenencia.",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "$ref": "#/definitions/Tenancy"
            }
          },
          "400": {
            "description": "Valor incorrecto."
          }
        }
      }
    },
    "/clients.json": {
      "get": {
        "tags": [
          "Client"
        ],
        "summary": "Encuentra Clientes por Id, externalID, nombre, companía, email, dirección, estado o tenencia.",
        "operationId": "getList",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "filters[id]",
            "in": "query",
            "description": "Id del cliente.",
            "required": false,
            "type": "integer"
          },
          {
            "name": "filters[name]",
            "in": "query",
            "description": "Nombre del cliente.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[externalId]",
            "in": "query",
            "description": "ExternalID del cliente.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[company]",
            "in": "query",
            "description": "Companía del cliente.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[address]",
            "in": "query",
            "description": "Dirección del cliente.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[email]",
            "in": "query",
            "description": "Email del cliente.",
            "required": false,
            "type": "string"
          },
          {
            "name": "filters[currentState]",
            "in": "query",
            "description": "Estado del cliente.",
            "required": false,
            "type": "string",
            "enum": [
              "active",
              "suspend"
            ]
          },
          {
            "name": "filters[tenancyId]",
            "in": "query",
            "description": "Id de la tenencia donde se encuentra cargado el cliente. Por defecto se utiliza la tenencia base.",
            "required": false,
            "type": "integer",
            "default": 2
          },
          {
            "name": "filters[qb-criteria]",
            "in": "query",
            "description": "Criteria = 1 > Permite filtrar por parte del nombre al momento de buscar por este campo.",
            "required": false,
            "type": "integer",
            "default": 1
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Cantidad de registros por página.",
            "default": 20,
            "type": "integer"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Número de página a buscar.",
            "default": 0,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación existosa.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Client"
              }
            }
          },
          "400": {
            "description": "Valor incorrecto."
          }
        }
      },
      "post": {
        "tags": [
          "Client"
        ],
        "summary": "Crear Cliente",
        "description": "Creación de un cliente. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "create",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Crea un cliente a partir del objeto.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ClientCRUD"
            }
          }
        ],
        "responses": {
          "default": {
            "description": "Operación exitosa."
          }
        }
      }
    },
    "/clients/{id}.json": {
      "put": {
        "tags": [
          "Client"
        ],
        "summary": "Actualiza un cliente.",
        "description": "Modificación de un cliente. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "update",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Ingresar el Id del cliente que va a editar.",
            "type": "string",
            "required": true
          },
          {
            "in": "body",
            "name": "body",
            "description": "Objeto cliente que necesita ser modificado.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ClientCRUD"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa."
          },
          "400": {
            "description": "Se produjo un error al ejecutar la acción."
          },
          "404": {
            "description": "Cliente no encontrado."
          },
          "405": {
            "description": "Validation exception."
          }
        }
      },
      "delete": {
        "tags": [
          "Client"
        ],
        "summary": "Eliminar Cliente",
        "description": "Elimina un cliente. Dentro del objeto tenency solo se debe pasar el id.",
        "operationId": "delete",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del cliente que necesita eliminar.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa."
          },
          "400": {
            "description": "Cliente no válido."
          },
          "404": {
            "description": "Cliente no encontrado."
          }
        }
      },
      "get": {
        "tags": [
          "Client"
        ],
        "summary": "Obtener Clientes por Id",
        "description": "",
        "operationId": "getById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del cliente a consultar.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Client"
            }
          },
          "400": {
            "description": "Id de cliente inválido."
          },
          "404": {
            "description": "Cliente no encontrado."
          }
        }
      }
    },
    "/clients/{id}/apply/{workflow}/{transition}": {
      "get": {
        "tags": [
          "Client"
        ],
        "summary": "Aplicar acción sobre Cliente.",
        "description": "",
        "operationId": "apply",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id del Cliente",
            "required": true,
            "type": "integer"
          },
          {
            "name": "workflow",
            "in": "path",
            "description": "Workflow del cliente",
            "required": true,
            "type": "string",
            "enum": [
              "administrative_state"
            ]
          },
          {
            "name": "transition",
            "in": "path",
            "description": "Acción del Workflow",
            "required": true,
            "type": "string",
            "enum": [
              "suspend_to_active",
              "active_to_suspend",
              "active_to_pre_notice",
              "pre_notice_to_suspend",
              "delete"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Operación exitosa.",
            "schema": {
              "$ref": "#/definitions/Client"
            }
          },
          "400": {
            "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
          },
          "404": {
            "description": "Error al aplicar la transición."
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "securityDefinitions": {
    "basicAuth": {
      "type": "basic"
    }
  },
  "definitions": {
    "Client": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del cliente."
        },
        "externalId": {
          "type": "string",
          "description": "Permite identificar un cliente en un sistema externo."
        },
        "name": {
          "type": "string",
          "description": "Nombre del cliente."
        },
        "address": {
          "type": "string",
          "description": "Dirección del cliente."
        },
        "company": {
          "type": "string",
          "description": "Compañia del cliente."
        },
        "email": {
          "type": "string",
          "description": "Email del cliente."
        },
        "phoneNumber": {
          "type": "string",
          "description": "Teléfono del cliente."
        },
        "currentState": {
          "type": "string",
          "enum": [
            "active",
            "suspend"
          ],
          "description": "Estado del cliente al momento de crearlo."
        },
        "tenancy": {
          "$ref": "#/definitions/Tenancy"
        }
      },
      "xml": {
        "name": "Client"
      }
    },
    "ClientCRUD": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id del cliente."
        },
        "externalId": {
          "type": "string",
          "description": "Permite identificar un cliente en un sistema externo."
        },
        "name": {
          "type": "string",
          "description": "Nombre del cliente."
        },
        "address": {
          "type": "string",
          "description": "Dirección del cliente."
        },
        "company": {
          "type": "string",
          "description": "Compañia del cliente."
        },
        "email": {
          "type": "string",
          "description": "Email del cliente."
        },
        "phoneNumber": {
          "type": "string",
          "description": "Teléfono del cliente."
        },
        "currentState": {
          "type": "string",
          "enum": [
            "active",
            "suspend"
          ],
          "description": "Estado del cliente al momento de crearlo."
        },
        "tenancy": {
          "type": "integer",
          "description": "Id de tenencia del cliente.",
          "default": 2
        }
      },
      "xml": {
        "name": "Client"
      }
    },
    "Tenancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Id de la tenencia.",
          "default": 2
        },
        "name": {
          "type": "string",
          "description": "Nombre de la tenencia."
        },
        "enabled": {
          "type": "string",
          "description": "Me dice si la tenencia esta activa."
        }
      },
      "xml": {
        "name": "Tenancy"
      }
    }
  }
}