---
title: /v1/reviews/error-types
slug: beta-developer-docs/v1reviewserror-types
docTags: 
createdAt: 2024-11-18T10:12:21.918Z
---

{
  "id": "XZ0xvqK76kyC0HR5y6XkR",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "/v1/reviews/error-types",
    "servers": [],
    "name": "",
    "description": "Fetch the available error types",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Enveloped_Seq_ReviewErrorTypeDto",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/ReviewErrorTypeDto",
                "customType": "ReviewErrorTypeDto[]",
                "schema": [
                  {
                    "name": "errorTypeId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "example": ""
                  },
                  {
                    "name": "name",
                    "kind": "required",
                    "type": "string",
                    "example": ""
                  },
                  {
                    "name": "pinAllowed",
                    "kind": "required",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "name": "objectAllowed",
                    "kind": "required",
                    "type": "boolean",
                    "example": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/Enveloped_Seq_ReviewErrorTypeDto",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Bad request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "BadRequest",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              },
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/BadRequest",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Unauthorized",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Unauthorized",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/Unauthorized",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "403",
        "description": "Forbidden",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Forbidden",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/Forbidden",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not found",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "NotFound",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/NotFound",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "413",
        "description": "Payload too large",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "PayloadTooLarge",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/PayloadTooLarge",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal server error",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "InternalServerError",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/InternalServerError",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "gZ5Z7WNUtwGaAzY76zfo5",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url /v1/reviews/error-types \\\n     --header 'accept: application/json'"
        },
        {
          "id": "B3QHxO000g6BTYWf87uQJ",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/v1/reviews/error-types\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "kKMWEeoX0xWrGN1ZQAHFb",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/v1/reviews/error-types\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "pc-0VOzmK9cKs7eShmCQ_",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/v1/reviews/error-types\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "gZ5Z7WNUtwGaAzY76zfo5"
    },
    "results": {
      "languages": [
        {
          "id": "NOfCMM2k3ZkuWn6xr0j_b",
          "language": "200",
          "code": "{\n  \"data\": [\n    {\n      \"errorTypeId\": \"\",\n      \"name\": \"\",\n      \"pinAllowed\": false,\n      \"objectAllowed\": false\n    }\n  ]\n}"
        },
        {
          "id": "TwfQsbYmlK9sIQfxBXkst",
          "language": "400",
          "code": "// Bad request\n{\n  \"message\": \"\",\n  \"errorCode\": \"\"\n}"
        },
        {
          "id": "E9Cyd6PtjnsaAWSyge_I_",
          "language": "401",
          "code": "// Unauthorized\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "XGyoeO2rlv8sO3OIlV44C",
          "language": "403",
          "code": "// Forbidden\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "3huVVji527Xt3S1R0_FG1",
          "language": "404",
          "code": "// Not found\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "Lu2iOy58RE3i9cX2lyGxz",
          "language": "413",
          "code": "// Payload too large\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "puKFCTdycPcufaicw4Wd3",
          "language": "500",
          "code": "// Internal server error\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "NOfCMM2k3ZkuWn6xr0j_b"
    }
  },
  "children": [
    {
      "id": "TXARHFK2rL5NOl38hduXF",
      "type": "paragraph",
      "children": [
        {
          "text": "Fetch the available error types"
        }
      ]
    }
  ]
}