{ "openapi": "3.1.1", "info": { "title": "api/catalogs/firm-search", "version": "1.0.0" }, "servers": [ { "url": "/" }, { "url": "https://api.ati.su" } ], "security": [ { "BearerAuth": [] } ], "paths": { "/v1.0/firms/search/summaries-emails": { "post": { "tags": [ "FirmSummarySearch" ], "summary": "Групповое получение краткой информации о фирмаx по email", "operationId": "post_v1.0_firms_search_summaries-emails", "requestBody": { "description": "Адреса электронной почты", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Элемент результата поиска фирм по ключу.", "$ref": "#/components/schemas/SummaryWithContactsPublicFirmSummarySearchResultElement" }, "example": [ { "key": "string", "value": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] }, "example": [ { "key": "string", "value": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "503": { "description": "Произошла ошибка при получении данных", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "external_service_error", "reason": "Произошла ошибка при получении данных" } } } } } } }, "/v1.0/firms/search/summaries": { "post": { "tags": [ "FirmSummarySearch" ], "summary": "Групповое получение краткой информации о фирмаx по ИНН", "operationId": "post_v1.0_firms_search_summaries", "requestBody": { "description": "Список ИНН", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Элемент результата поиска фирм по ключу.", "$ref": "#/components/schemas/AffiliatedFirmPublicAccountSummaryPublicFirmSummarySearchResultElement" }, "example": [ { "key": "string", "value": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] }, "example": [ { "key": "string", "value": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "503": { "description": "Произошла ошибка при получении данных", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "external_service_error", "reason": "Произошла ошибка при получении данных" } } } } } } }, "/v1.0/firms/search/summary": { "get": { "tags": [ "FirmSummarySearch" ], "summary": "Получение краткой информации о фирме по номеру телефона или ИНН", "operationId": "get_v1.0_firms_search_summary", "parameters": [ { "name": "phone", "in": "query", "description": "Номер телефона", "schema": { "type": "string" }, "example": "+7-495-000-00-00" }, { "name": "inn", "in": "query", "description": "ИНН", "schema": { "type": "string" }, "example": "7707083893" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Краткая информация о фирме с данными по контактам.", "$ref": "#/components/schemas/SummaryWithContactsPublic" }, "example": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] }, "example": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "503": { "description": "Произошла ошибка при получении данных", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "external_service_error", "reason": "Произошла ошибка при получении данных" } } } } } } } }, "components": { "schemas": { "AffiliatedFirmPublicAccountSummaryPublicFirmSummarySearchResultElement": { "type": "object", "properties": { "key": { "type": [ "null", "string" ], "description": "Ключ", "example": "string" }, "value": { "type": [ "null", "array" ], "items": { "description": "Публичная сводная информация по фирме.", "$ref": "#/components/schemas/AffiliatedFirmPublicAccountSummaryPublic" }, "description": "Значение", "example": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "additionalProperties": false, "description": "Элемент результата поиска фирм по ключу.", "example": { "key": "string", "value": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": [ "null", "string" ], "description": "Код ошибки", "example": "invalid_input_data" }, "reason": { "type": [ "null", "string" ], "description": "Описание ошибки", "example": "Неверные входные данные." } }, "additionalProperties": false, "description": "Стандартный ответ с описанием ошибки", "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } }, "SummaryWithContactsPublicFirmSummarySearchResultElement": { "type": "object", "properties": { "key": { "type": [ "null", "string" ], "description": "Ключ", "example": "string" }, "value": { "type": [ "null", "array" ], "items": { "description": "Краткая информация о фирме с данными по контактам.", "$ref": "#/components/schemas/SummaryWithContactsPublic" }, "description": "Значение", "example": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "additionalProperties": false, "description": "Элемент результата поиска фирм по ключу.", "example": { "key": "string", "value": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "SummaryWithContactsPublic": { "type": "object", "properties": { "contact_names": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Имена контактов", "example": [ "string" ] }, "query_first_change_date": { "type": [ "null", "string" ], "description": "Даты первого добавления искомого параметра поиска (email, phone, inn)", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "ati_id": { "type": [ "null", "string" ], "description": "Код в АТИ.", "example": "string" }, "full_name": { "type": [ "null", "string" ], "description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)", "example": "string" }, "firm_type": { "type": [ "null", "string" ], "description": "Профиль деятельности фирмы", "example": "string" }, "firm_type_id": { "type": [ "null", "string" ], "description": "Идентификатор профиля деятельности фирмы", "example": "string" }, "location": { "type": "null", "allOf": [ { "description": "Структура \"Город\"", "$ref": "#/components/schemas/City" } ], "description": "Информация о месторасположении фирмы", "example": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" } }, "address": { "type": [ "null", "string" ], "description": "Адрес фирмы", "example": "string" }, "position_in_city": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по городу", "format": "int32", "example": 0 }, "position_in_country": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по стране", "format": "int32", "example": 0 }, "firm_documents": { "type": [ "null", "array" ], "items": { "description": "Документ, связанный с фирмой.", "$ref": "#/components/schemas/FirmDocument" }, "description": "Документы фирмы", "example": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ] }, "web_site": { "type": [ "null", "string" ], "description": "Сайт фирмы", "example": "string" }, "info_reference": { "type": [ "null", "string" ], "description": "Ссылка на карточку фирмы", "example": "string" }, "passport_reference": { "type": [ "null", "string" ], "description": "Ссылка на паспорт фирмы", "example": "string" }, "city": { "type": [ "null", "string" ], "description": "Город, в котором расположена фирма", "example": "string" }, "score": { "type": "number", "description": "Количество звезд фирмы. Если число отрицательно, то это красные звезды", "format": "double", "example": 0 }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме недобросовестных партнеров", "format": "int32", "example": 0 }, "claims_count": { "type": "integer", "description": "Количество претензий от фирм", "format": "int32", "example": 0 }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций от фирм", "format": "int32", "example": 0 }, "inn": { "type": [ "null", "string" ], "description": "Инн", "example": "string" }, "ogrn": { "type": [ "null", "string" ], "description": "ОГРН", "example": "string" }, "kpp": { "type": [ "null", "string" ], "description": "Код причины постановки на учет фирмы", "example": "string" }, "okpo": { "type": [ "null", "string" ], "description": "Общероссийский классификатор предприятий и организаций", "example": "string" }, "affiliated_firms": { "type": [ "null", "array" ], "items": { "description": "Связанная фирма", "$ref": "#/components/schemas/AffiliatedFirmPublic" }, "description": "Список связанных фирм (Доступно только для платных пользователей)", "example": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ] }, "negative_points_sum": { "type": "number", "description": "Сумма отрицательных баллов", "format": "double", "example": 0 }, "tf_firm_color": { "type": [ "null", "string" ], "description": "Цвет фирмы в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_account_color": { "type": [ "null", "string" ], "description": "Цвет аккаунта в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре", "example": false }, "registration_date": { "type": "string", "description": "Дата регистрации на сайте, которая AddDate из firms.", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "contact_info_changed": { "type": "string", "description": "Дата последних изменений в истории фирмы. (Доступно только для платных пользователей)", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "last_month_active_days": { "type": "integer", "description": "Число дней со входами на сайт за последние 30 дней (Доступно только для платных пользователей).", "format": "int32", "example": 0 }, "verified_trucks": { "type": "integer", "description": "Количество зарегистрированных ТС", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "Краткая информация о фирме с данными по контактам.", "example": { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } }, "AffiliatedFirmPublicAccountSummaryPublic": { "type": "object", "properties": { "ati_id": { "type": [ "null", "string" ], "description": "Код в АТИ.", "example": "string" }, "full_name": { "type": [ "null", "string" ], "description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)", "example": "string" }, "firm_type": { "type": [ "null", "string" ], "description": "Профиль деятельности фирмы", "example": "string" }, "firm_type_id": { "type": [ "null", "string" ], "description": "Идентификатор профиля деятельности фирмы", "example": "string" }, "location": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/City" } ], "description": "Информация о месторасположении фирмы", "example": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" } }, "address": { "type": [ "null", "string" ], "description": "Адрес фирмы", "example": "string" }, "position_in_city": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по городу", "format": "int32", "example": 0 }, "position_in_country": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по стране", "format": "int32", "example": 0 }, "firm_documents": { "type": [ "null", "array" ], "items": { "description": "Документ, связанный с фирмой.", "$ref": "#/components/schemas/FirmDocument" }, "description": "Документы фирмы", "example": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ] }, "web_site": { "type": [ "null", "string" ], "description": "Сайт фирмы", "example": "string" }, "info_reference": { "type": [ "null", "string" ], "description": "Ссылка на карточку фирмы", "example": "string" }, "passport_reference": { "type": [ "null", "string" ], "description": "Ссылка на паспорт фирмы", "example": "string" }, "city": { "type": [ "null", "string" ], "description": "Город, в котором расположена фирма", "example": "string" }, "score": { "type": "number", "description": "Количество звезд фирмы. Если число отрицательно, то это красные звезды", "format": "double", "example": 0 }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме недобросовестных партнеров", "format": "int32", "example": 0 }, "claims_count": { "type": "integer", "description": "Количество претензий от фирм", "format": "int32", "example": 0 }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций от фирм", "format": "int32", "example": 0 }, "inn": { "type": [ "null", "string" ], "description": "Инн", "example": "string" }, "ogrn": { "type": [ "null", "string" ], "description": "ОГРН", "example": "string" }, "kpp": { "type": [ "null", "string" ], "description": "Код причины постановки на учет фирмы", "example": "string" }, "okpo": { "type": [ "null", "string" ], "description": "Общероссийский классификатор предприятий и организаций", "example": "string" }, "affiliated_firms": { "type": [ "null", "array" ], "items": { "description": "Связанная фирма", "$ref": "#/components/schemas/AffiliatedFirmPublic" }, "description": "Список связанных фирм (Доступно только для платных пользователей)", "example": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ] }, "negative_points_sum": { "type": "number", "description": "Сумма отрицательных баллов", "format": "double", "example": 0 }, "tf_firm_color": { "type": [ "null", "string" ], "description": "Цвет фирмы в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_account_color": { "type": [ "null", "string" ], "description": "Цвет аккаунта в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре", "example": false }, "registration_date": { "type": "string", "description": "Дата регистрации на сайте, которая AddDate из firms.", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "contact_info_changed": { "type": "string", "description": "Дата последних изменений в истории фирмы. (Доступно только для платных пользователей)", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "last_month_active_days": { "type": "integer", "description": "Число дней со входами на сайт за последние 30 дней (Доступно только для платных пользователей).", "format": "int32", "example": 0 }, "verified_trucks": { "type": "integer", "description": "Количество зарегистрированных ТС", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "Публичная сводная информация по фирме.", "example": { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } }, "City": { "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор города", "format": "int32", "example": 0 }, "region_id": { "type": [ "null", "integer" ], "description": "Идентификатор региона", "format": "int32", "example": 0 }, "country_id": { "type": [ "null", "integer" ], "description": "Идентификатор страны", "format": "int32", "example": 0 }, "full_name": { "type": [ "null", "string" ], "description": "Составное название состоящее из названий города, региона и страны разделенные через запятую.", "example": "string" }, "short_name": { "type": [ "null", "string" ], "description": "Составное название состоящее из названия города,\nназвания региона (если город не является областным центром)\nи буквенного кода страны (если страна отличается от России).", "example": "string" }, "is_regional_center": { "type": "boolean", "description": "Флаг - является ли город региональным центром", "example": false }, "city_size": { "type": "integer", "description": "Размер города по числу жителей.", "format": "int32", "example": 0 }, "fias_id": { "type": [ "null", "string" ], "description": "Идентификатор населенного пункта", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "attributes": { "enum": [ "0", "4" ], "allOf": [ { "description": "- 0 = None (Отсутствует)\n- 4 = RegionalCenter (Региональный центр)", "$ref": "#/components/schemas/CityAttributes" } ], "description": "Атрибуты города", "example": 0 }, "city_name": { "type": [ "null", "string" ], "description": "Название города", "example": "string" }, "region_name": { "type": [ "null", "string" ], "description": "Название региона", "example": "string" }, "country_name": { "type": [ "null", "string" ], "description": "Название страны", "example": "string" }, "country_code_name": { "type": [ "null", "string" ], "description": "Буквенный код страны (например, RUS)", "example": "string" } }, "additionalProperties": false, "description": "Структура \"Город\"", "example": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" } }, "FirmDocument": { "type": "object", "properties": { "link": { "type": [ "null", "string" ], "description": "Ссылка на документ.", "example": "string" }, "description": { "type": [ "null", "string" ], "description": "Автогенерируемое описание документа.", "example": "string" }, "creation_date": { "type": "string", "description": "Дата создания документа.", "format": "date-time", "example": "1970-01-01T00:00:00Z" } }, "additionalProperties": false, "description": "Документ, связанный с фирмой.", "example": { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } }, "AffiliatedFirmPublic": { "type": "object", "properties": { "firm_name": { "type": [ "null", "string" ], "description": "Название фирмы", "example": "string" }, "inn": { "type": [ "null", "string" ], "description": "ИНН", "example": "string" }, "tf_firm_color": { "type": [ "null", "string" ], "description": "Цвет фирмы в светофоре", "example": "string" }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре", "example": false } }, "additionalProperties": false, "description": "Связанная фирма", "example": { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } }, "CityAttributes": { "enum": [ 0, 4 ], "type": "integer", "oneOf": [ { "const": "0", "title": "None", "description": "Отсутствует" }, { "const": "4", "title": "RegionalCenter", "description": "Региональный центр" } ], "description": "- 0 = None (Отсутствует)\n- 4 = RegionalCenter (Региональный центр)", "x-ms-enum-flags": { "isFlags": false } } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Authorization: Bearer {authorizationToken}" } } } }