Contrato histórico: GET get-business-types

Contrato histórico de API. Esta página describe un contrato anterior. Los métodos, las rutas y las respuestas pueden diferir de la API vigente.

Significado histórico

Obtener lista de tipos de negocio

Este endpoint de la API se utiliza para obtener todos los negocios.

API vigente

Para desarrollar una integración nueva, consulta la referencia o guía vigente enlazada.

Ver la referencia de la API vigente

Parámetros

[
  {
    "name": "language",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "en"
    },
    "required": true
  },
  {
    "name": "project",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "<redacted-personal>"
    },
    "required": true
  },
  {
    "name": "params",
    "in": "query",
    "schema": {
      "type": "string",
      "default": "name"
    }
  },
  {
    "name": "api_version",
    "in": "path",
    "schema": {
      "type": "string",
      "default": "v400"
    },
    "required": true
  }
]

Cuerpo de solicitud

null

Respuestas

{
  "200": {
    "description": "200",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": false,\n  \"result\": [\n    {\n      \"id\": 1,\n      \"name\": \"<redacted-personal>\",\n      \"image\": null,\n      \"description\": null,\n      \"enabled\": true,\n      \"created_at\": \"2021-04-08 14:07:24\",\n      \"updated_at\": \"2021-04-08 14:07:24\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"<redacted-personal>\",\n      \"image\": null,\n      \"description\": null,\n      \"enabled\": true,\n      \"created_at\": \"2021-04-08 14:07:24\",\n      \"updated_at\": \"2021-04-08 14:07:24\"\n    },\n    {\n      \"id\": 3,\n      \"name\": \"<redacted-personal>\",\n      \"image\": null,\n      \"description\": null,\n      \"enabled\": true,\n      \"created_at\": \"2021-04-08 14:07:24\",\n      \"updated_at\": \"2021-04-08 14:07:24\"\n    },\n    {\n      \"id\": 4,\n      \"name\": \"<redacted-personal>\",\n      \"image\": null,\n      \"description\": null,\n      \"enabled\": true,\n      \"created_at\": \"2021-04-08 14:07:24\",\n      \"updated_at\": \"2021-04-08 14:07:24\"\n    }\n  ],\n  \"pagination\": {\n    \"total\": 4,\n    \"from\": 1,\n    \"to\": 4,\n    \"current_page\": 1,\n    \"page_size\": 4,\n    \"total_pages\": 1,\n    \"fisrt_page\": null,\n    \"first_page\": null,\n    \"back_page\": null,\n    \"next_page\": null,\n    \"last_page\": null\n  }\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": false,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer",
                    "example": 1,
                    "default": 0
                  },
                  "name": {
                    "type": "string",
                    "example": "<redacted-personal>"
                  },
                  "image": {},
                  "description": {},
                  "enabled": {
                    "type": "boolean",
                    "example": true,
                    "default": true
                  },
                  "created_at": {
                    "type": "string",
                    "example": "2021-04-08 14:07:24"
                  },
                  "updated_at": {
                    "type": "string",
                    "example": "2021-04-08 14:07:24"
                  }
                }
              }
            },
            "pagination": {
              "type": "object",
              "properties": {
                "total": {
                  "type": "integer",
                  "example": 4,
                  "default": 0
                },
                "from": {
                  "type": "integer",
                  "example": 1,
                  "default": 0
                },
                "to": {
                  "type": "integer",
                  "example": 4,
                  "default": 0
                },
                "current_page": {
                  "type": "integer",
                  "example": 1,
                  "default": 0
                },
                "page_size": {
                  "type": "integer",
                  "example": 4,
                  "default": 0
                },
                "total_pages": {
                  "type": "integer",
                  "example": 1,
                  "default": 0
                },
                "fisrt_page": {},
                "first_page": {},
                "back_page": {},
                "next_page": {},
                "last_page": {}
              }
            }
          }
        }
      }
    }
  },
  "400": {
    "description": "400",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {}
        }
      }
    }
  },
  "401": {
    "description": "401",
    "content": {
      "application/json": {
        "examples": {
          "Result": {
            "value": "{\n  \"error\": true,\n  \"result\": [\n    \"You do not have permission.\"\n  ]\n}"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "boolean",
              "example": true,
              "default": true
            },
            "result": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "You do not have permission."
              }
            }
          }
        }
      }
    }
  }
}