{
  "openapi": "3.0.0",
  "info": {
    "title": "api/catalogs/firm-lists",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "/"
    },
    {
      "url": "https://api.ati.su"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/scrolls/v1/firms": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "FirmLists"
        ],
        "summary": "Метод получения списков фирмы"
      },
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "FirmLists"
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/FirmListElementPublicFirmListPublic"
        },
        "summary": "Метод добавления списка фирм"
      },
      "put": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "FirmLists"
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/FirmListElementPublicFirmListPublic"
        },
        "summary": "Метод изменения списка фирм"
      }
    },
    "/scrolls/v1/firms/ids": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "FirmLists"
        ],
        "requestBody": {
          "content": {
            "application/*+json": {
              "schema": {
                "items": {
                  "format": "uuid",
                  "type": "string"
                },
                "type": "array"
              }
            },
            "application/json": {
              "schema": {
                "items": {
                  "format": "uuid",
                  "type": "string"
                },
                "type": "array"
              }
            },
            "application/json-patch+json": {
              "schema": {
                "items": {
                  "format": "uuid",
                  "type": "string"
                },
                "type": "array"
              }
            },
            "text/json": {
              "schema": {
                "items": {
                  "format": "uuid",
                  "type": "string"
                },
                "type": "array"
              }
            }
          }
        },
        "summary": "Метод получения списков фирмы по идентификаторам списокв"
      }
    },
    "/scrolls/v1/firms/{listId}": {
      "delete": {
        "parameters": [
          {
            "description": "Идентификатор списка",
            "in": "path",
            "name": "listId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "CommonList"
        ],
        "summary": "Метод удаляет список заданной фирмы"
      }
    },
    "/scrolls/v1/firms/elements": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/FirmListElementPublicBatchResultItem"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "ListElementsBatch"
        ],
        "requestBody": {
          "content": {
            "application/*+json": {
              "schema": {
                "description": "\"Элементы списка",
                "items": {
                  "$ref": "#/components/schemas/FirmListElementPublicShort"
                },
                "type": "array"
              }
            },
            "application/json": {
              "schema": {
                "description": "\"Элементы списка",
                "items": {
                  "$ref": "#/components/schemas/FirmListElementPublicShort"
                },
                "type": "array"
              }
            },
            "application/json-patch+json": {
              "schema": {
                "description": "\"Элементы списка",
                "items": {
                  "$ref": "#/components/schemas/FirmListElementPublicShort"
                },
                "type": "array"
              }
            },
            "text/json": {
              "schema": {
                "description": "\"Элементы списка",
                "items": {
                  "$ref": "#/components/schemas/FirmListElementPublicShort"
                },
                "type": "array"
              }
            }
          },
          "description": "\"Элементы списка"
        },
        "summary": "Метод добавления элементов в список фирм"
      },
      "delete": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/GuidBatchResultItem"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Unauthorized"
          },
          "402": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Client Error"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Not Found"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          },
          "504": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Server Error"
          }
        },
        "tags": [
          "ListElementsBatch"
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/Body"
        },
        "summary": "Метод удаления элементов из списков по их идентификаторам"
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "properties": {
          "error": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "FirmListElementPublicShort": {
        "properties": {
          "ati_id": {
            "description": "Идентификатор фирмы",
            "type": "string"
          },
          "firm_name": {
            "description": "Название фирмы",
            "type": "string"
          },
          "id": {
            "description": "Идентификатор элемента списка фирм",
            "format": "uuid",
            "type": "string"
          },
          "list_id": {
            "description": "Идентификатор списка фирм",
            "format": "uuid",
            "type": "string"
          },
          "owner_ati_id": {
            "description": "Идентификатор фирмы владельца списка",
            "type": "string"
          }
        },
        "type": "object"
      },
      "FirmListElementPublicBatchResultItem": {
        "properties": {
          "status": {
            "description": "Статус: \r\n0 - успешно; \r\n2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; \r\n4 - такой список не найден; \r\n6 - такой элемент уже есть в этом списке",
            "format": "int32",
            "type": "integer"
          },
          "value": {
            "$ref": "#/components/schemas/FirmListElementPublicShort"
          }
        },
        "type": "object"
      },
      "FirmListElementPublicFirmListPublicBody": {
        "properties": {
          "ati_id": {
            "description": "Идентификатор фирмы",
            "type": "string"
          },
          "contact_id": {
            "description": "Идентификатор контакта фирмы",
            "format": "int32",
            "type": "integer"
          },
          "description": {
            "description": "Описание списка фирм",
            "type": "string"
          },
          "emoji": {
            "description": "Эмодзи (html-entity)",
            "type": "string"
          },
          "fixed": {
            "type": "boolean"
          },
          "name": {
            "description": "Название списка фирм",
            "type": "string"
          },
          "personal": {
            "description": "Персональный ли список фирм",
            "type": "boolean"
          },
          "type": {
            "$ref": "#/components/schemas/FirmListType"
          }
        },
        "type": "object"
      },
      "FirmListElementPublicFirmListPublicShort": {
        "properties": {
          "ati_id": {
            "description": "Идентификатор фирмы",
            "type": "string"
          },
          "contact_id": {
            "description": "Идентификатор контакта фирмы",
            "format": "int32",
            "type": "integer"
          },
          "description": {
            "description": "Описание списка фирм",
            "type": "string"
          },
          "elements": {
            "description": "Элементы списка",
            "items": {
              "$ref": "#/components/schemas/FirmListElementPublicShort"
            },
            "type": "array"
          },
          "emoji": {
            "description": "Эмодзи (html-entity)",
            "type": "string"
          },
          "fixed": {
            "type": "boolean"
          },
          "id": {
            "description": "Идентификатор списка фирм",
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "description": "Название списка фирм",
            "type": "string"
          },
          "personal": {
            "description": "Персональный ли список фирм",
            "type": "boolean"
          },
          "type": {
            "$ref": "#/components/schemas/FirmListType"
          }
        },
        "type": "object"
      },
      "FirmListType": {
        "description": "Тип списка фирм",
        "enum": [
          0,
          1,
          2
        ],
        "format": "int32",
        "type": "integer"
      },
      "GuidBatchResultItem": {
        "properties": {
          "status": {
            "description": "Статус: \r\n0 - успешно; \r\n2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; \r\n4 - такой список не найден; \r\n6 - такой элемент уже есть в этом списке",
            "format": "int32",
            "type": "integer"
          },
          "value": {
            "description": "Значение",
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "requestBodies": {
      "Body": {
        "content": {
          "application/*+json": {
            "schema": {
              "description": "Идентификаторы элементов",
              "items": {
                "format": "uuid",
                "type": "string"
              },
              "type": "array"
            }
          },
          "application/json": {
            "schema": {
              "description": "Идентификаторы элементов",
              "items": {
                "format": "uuid",
                "type": "string"
              },
              "type": "array"
            }
          },
          "application/json-patch+json": {
            "schema": {
              "description": "Идентификаторы элементов",
              "items": {
                "format": "uuid",
                "type": "string"
              },
              "type": "array"
            }
          },
          "text/json": {
            "schema": {
              "description": "Идентификаторы элементов",
              "items": {
                "format": "uuid",
                "type": "string"
              },
              "type": "array"
            }
          }
        },
        "description": "Идентификаторы элементов"
      },
      "FirmListElementPublicFirmListPublic": {
        "content": {
          "application/*+json": {
            "schema": {
              "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody"
            }
          },
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody"
            }
          },
          "application/json-patch+json": {
            "schema": {
              "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody"
            }
          },
          "text/json": {
            "schema": {
              "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody"
            }
          }
        },
        "description": "Список фирм"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Authorization: Bearer {authorizationToken}"
      }
    }
  }
}