{
  "openapi": "3.0.1",
  "info": {
    "title": "api/dictionaries/ati-docs",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "/"
    },
    {
      "url": "https://api.ati.su"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/gw/dictionaries/v1/ati_docs_contract_types": {
      "get": {
        "tags": [
          "ati_docs_contract_types"
        ],
        "summary": "Получение словаря ati_docs_contract_types",
        "description": "Типы договоров для работы с АТИ-Доками",
        "operationId": "getPublicDictionary_ati_docs_contract_types",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy",
            "schema": {
              "type": "string",
              "example": "ru"
            },
            "example": "ru"
          }
        ],
        "responses": {
          "200": {
            "description": "Элементы словаря ati_docs_contract_types",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ati_docs_contract_typesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/gw/oauth2/dictionaries/v1/ati_docs_contract_types": {
      "get": {
        "tags": [
          "ati_docs_contract_types"
        ],
        "summary": "Получение словаря ati_docs_contract_types",
        "description": "Типы договоров для работы с АТИ-Доками",
        "operationId": "getPublicDictionary_ati_docs_contract_types",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy",
            "schema": {
              "type": "string",
              "example": "ru"
            },
            "example": "ru"
          }
        ],
        "responses": {
          "200": {
            "description": "Элементы словаря ati_docs_contract_types",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ati_docs_contract_typesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/gw/dictionaries/v1/ati_docs_document_types": {
      "get": {
        "tags": [
          "ati_docs_document_types"
        ],
        "summary": "Получение словаря ati_docs_document_types",
        "description": "Типы документов для работы с АТИ-Доками, например заказ, заявка к договору и доверенность. Табличные варианты заказа и заявки выделены в отдельные типы",
        "operationId": "getPublicDictionary_ati_docs_document_types",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy",
            "schema": {
              "type": "string",
              "example": "ru"
            },
            "example": "ru"
          }
        ],
        "responses": {
          "200": {
            "description": "Элементы словаря ati_docs_document_types",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ati_docs_document_typesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/gw/oauth2/dictionaries/v1/ati_docs_document_types": {
      "get": {
        "tags": [
          "ati_docs_document_types"
        ],
        "summary": "Получение словаря ati_docs_document_types",
        "description": "Типы документов для работы с АТИ-Доками, например заказ, заявка к договору и доверенность. Табличные варианты заказа и заявки выделены в отдельные типы",
        "operationId": "getPublicDictionary_ati_docs_document_types",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy",
            "schema": {
              "type": "string",
              "example": "ru"
            },
            "example": "ru"
          }
        ],
        "responses": {
          "200": {
            "description": "Элементы словаря ati_docs_document_types",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ati_docs_document_typesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/gw/dictionaries/v1/etrn_list_statuses": {
      "get": {
        "tags": [
          "etrn_list_statuses"
        ],
        "summary": "Получение словаря etrn_list_statuses",
        "description": "Состояния электронного документооборота транспортной накладной: код состояния, его название и этап маршрута, если он указан",
        "operationId": "getPublicDictionary_etrn_list_statuses",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy",
            "schema": {
              "type": "string",
              "example": "ru"
            },
            "example": "ru"
          }
        ],
        "responses": {
          "200": {
            "description": "Элементы словаря etrn_list_statuses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/etrn_list_statusesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      }
    },
    "/gw/oauth2/dictionaries/v1/etrn_list_statuses": {
      "get": {
        "tags": [
          "etrn_list_statuses"
        ],
        "summary": "Получение словаря etrn_list_statuses",
        "description": "Состояния электронного документооборота транспортной накладной: код состояния, его название и этап маршрута, если он указан",
        "operationId": "getPublicDictionary_etrn_list_statuses",
        "parameters": [
          {
            "name": "locale",
            "in": "query",
            "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy",
            "schema": {
              "type": "string",
              "example": "ru"
            },
            "example": "ru"
          }
        ],
        "responses": {
          "200": {
            "description": "Элементы словаря etrn_list_statuses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/etrn_list_statusesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ati_docs_contract_typesResponse": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ati_docs_contract_typesItem"
        },
        "description": "Типы договоров для работы с АТИ-Доками",
        "example": [
          {
            "dictionary_item_id": 1,
            "attributes": {
              "name": "Договор транспортной экспедиции"
            }
          }
        ]
      },
      "ati_docs_document_typesResponse": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ati_docs_document_typesItem"
        },
        "description": "Типы документов для работы с АТИ-Доками, например заказ, заявка к договору и доверенность. Табличные варианты заказа и заявки выделены в отдельные типы",
        "example": [
          {
            "dictionary_item_id": 1,
            "attributes": {
              "name": "заказ (табличный вид)"
            }
          }
        ]
      },
      "etrn_list_statusesResponse": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/etrn_list_statusesItem"
        },
        "description": "Состояния электронного документооборота транспортной накладной: код состояния, его название и этап маршрута, если он указан",
        "example": [
          {
            "dictionary_item_id": 1,
            "attributes": {
              "code": "title_1_success",
              "docflow_status": "Ожидает подписи перевозчика",
              "route_status": "Титул 2. Перевозчик (прием груза)"
            }
          }
        ]
      },
      "ati_docs_contract_typesItem": {
        "type": "object",
        "properties": {
          "dictionary_item_id": {
            "type": "integer",
            "description": "Идентификатор элемента словаря",
            "example": 1
          },
          "attributes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ati_docs_contract_typesAttributes"
              }
            ],
            "description": "Поля элемента: ключ — имя поля, значение — строка"
          }
        },
        "description": "Элемент словаря ati_docs_contract_types"
      },
      "ati_docs_document_typesItem": {
        "type": "object",
        "properties": {
          "dictionary_item_id": {
            "type": "integer",
            "description": "Идентификатор элемента словаря",
            "example": 1
          },
          "attributes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ati_docs_document_typesAttributes"
              }
            ],
            "description": "Поля элемента: ключ — имя поля, значение — строка"
          }
        },
        "description": "Элемент словаря ati_docs_document_types"
      },
      "etrn_list_statusesItem": {
        "type": "object",
        "properties": {
          "dictionary_item_id": {
            "type": "integer",
            "description": "Идентификатор элемента словаря",
            "example": 1
          },
          "attributes": {
            "allOf": [
              {
                "$ref": "#/components/schemas/etrn_list_statusesAttributes"
              }
            ],
            "description": "Поля элемента: ключ — имя поля, значение — строка"
          }
        },
        "description": "Элемент словаря etrn_list_statuses"
      },
      "ati_docs_contract_typesAttributes": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Название вида договора",
            "example": "Договор транспортной экспедиции"
          }
        },
        "description": "Поля элемента словаря ati_docs_contract_types"
      },
      "ati_docs_document_typesAttributes": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Название типа документа",
            "example": "заказ (табличный вид)"
          }
        },
        "description": "Поля элемента словаря ati_docs_document_types"
      },
      "etrn_list_statusesAttributes": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Код состояния документооборота ЭТрН. Позволяет различать состояния при обработке данных",
            "example": "title_1_success"
          },
          "docflow_status": {
            "type": "string",
            "description": "Название состояния документооборота для отображения пользователю",
            "example": "Ожидает подписи перевозчика"
          },
          "route_status": {
            "type": "string",
            "description": "Название этапа маршрута. Может быть пустой строкой",
            "example": "Титул 2. Перевозчик (прием груза)"
          }
        },
        "description": "Поля элемента словаря etrn_list_statuses"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Authorization: Bearer {authorizationToken}"
      }
    }
  }
}