AT AppointmentTrader
Войти
Сейчас онлайн  

/v1/customer_survey/

Seller-private customer surveys with customer-confirmed answer reuse.
GET

/v1/customer_survey/get_catalog

#
List AT and private templates, reusable fields, and optional chat recipient/sales context. Never returns customer answers.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
chatID int Нет 0 Accepted direct or bid chat; zero lists the acting seller's catalog.
Пример запроса (cURL) 
curl --get \
  'https://ru.appointmenttrader.com/v1/customer_survey/get_catalog' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatID={{chatID}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_get_catalog_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.fieldsarray Да
$.oneOf[0].allOf[1].Payload.fields[]object Нет
$.oneOf[0].allOf[1].Payload.fields[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.fields[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.fields[].CreatedDatestring Да
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID Да
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.fields[].FieldKeystring Да
$.oneOf[0].allOf[1].Payload.fields[].Labelstring Да
$.oneOf[0].allOf[1].Payload.fields[].LabelKey Да
$.oneOf[0].allOf[1].Payload.fields[].LabelKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.fields[].LabelKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.fields[].FieldGroupstring Да
$.oneOf[0].allOf[1].Payload.fields[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] Да
$.oneOf[0].allOf[1].Payload.fields[].ValueScopestring ["customer","booking"] Да
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSONstring (application/json) Да
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSONSurveyValidation (декодированный JSON) Да
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxLengthinteger Нет
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].integerboolean Нет
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].minnumber Нет
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxnumber Нет
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[1] = [] Да
$.oneOf[0].allOf[1].Payload.fields[].IsActiveDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].IsActive.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.fields[].IsActive.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.fields[].Optionsarray Да
$.oneOf[0].allOf[1].Payload.fields[].Options[]object Нет
$.oneOf[0].allOf[1].Payload.fields[].Options[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldIDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].OptionKeystring Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].Labelstring Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrderDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrder.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrder.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.templatesarray Да
$.oneOf[0].allOf[1].Payload.templates[]object Нет
$.oneOf[0].allOf[1].Payload.templates[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.templates[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.templates[].CreatedDatestring Да
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID Да
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.templates[].StarterKey Да
$.oneOf[0].allOf[1].Payload.templates[].StarterKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.templates[].StarterKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID Да
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID Да
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate Да
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.templates[].Titlestring Да
$.oneOf[0].allOf[1].Payload.templates[].TitleKey Да
$.oneOf[0].allOf[1].Payload.templates[].TitleKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.templates[].TitleKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.templates[].VersionNumberDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].VersionNumber.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.templates[].VersionNumber.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.context Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0].canSendboolean Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0].writableboolean Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0].customerIDinteger Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0].bidIDinteger Да
$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonCodestring Нет
$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonstring Нет
$.oneOf[0].allOf[1].Payload.context.anyOf[0].otherUserIDinteger Нет
$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenboolean НетTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenUntilinteger | null НетSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.context.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.customer Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].aliasstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarEmojistring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageUrlstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageURLstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].labelstring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileUrlstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileURLstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customColorstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customTextColorstring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarModestring | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].htmlstring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].idinteger | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].userIDinteger | null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].isRichboolean Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].idinteger Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].thumbUrlstring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaUrlstring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaTypestring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].widthinteger Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].heightinteger Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].titlestring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isImageboolean Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frameobject Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].backgroundUrlstring Нет
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medalsarray Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[]object Нет
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].Namestring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].URLstring Да
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenboolean НетAn anonymized author has no profile or follow action.
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenUntilinteger | null НетCurrent response-race closing timestamp in Unix seconds.
$.oneOf[0].allOf[1].Payload.customer.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.salesarray Да
$.oneOf[0].allOf[1].Payload.sales[]object Нет
$.oneOf[0].allOf[1].Payload.sales[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.sales[].BidID Да
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate Да
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.sales[].LocationName Да
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[1]null Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_catalog",
    "RequestUserAlias": "example-user",
    "Payload": {
        "fields": [],
        "templates": [],
        "context": {
            "canSend": false,
            "writable": false,
            "chatID": 0,
            "customerID": 0,
            "bidID": 0
        },
        "customer": {
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "avatarEmoji": "synthetic-example",
            "profileImageUrl": "synthetic-example",
            "profileImageURL": "synthetic-example",
            "label": "synthetic-example",
            "profileUrl": "synthetic-example",
            "profileURL": "synthetic-example",
            "title": "synthetic-example",
            "customColor": "synthetic-example",
            "customTextColor": "synthetic-example",
            "avatarMode": "synthetic-example",
            "html": "synthetic-example",
            "id": 0,
            "userID": 0,
            "isRich": false,
            "profileImage": {
                "id": 0,
                "thumbUrl": "synthetic-example",
                "mediaUrl": "synthetic-example",
                "mediaType": "synthetic-example",
                "width": 0,
                "height": 0,
                "title": "synthetic-example",
                "isImage": false,
                "isEmbedded": false,
                "frame": {
                    "positionXPercent": 0,
                    "positionYPercent": 0,
                    "zoomPercent": 100
                }
            },
            "medals": []
        },
        "sales": []
    }
}
Машиночитаемая документация метода
GET

/v1/customer_survey/get_customer_fields

#
Read own remembered values, or values this customer explicitly shared with the acting seller. Other sellers' responses are never returned.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
customerID int Да — Customer user ID.
Пример запроса (cURL) 
curl --get \
  'https://ru.appointmenttrader.com/v1/customer_survey/get_customer_fields' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'customerID={{customerID}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_get_customer_fields_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.canForgetboolean Да
$.oneOf[0].allOf[1].Payload.itemsarray Да
$.oneOf[0].allOf[1].Payload.items[]object Нет
$.oneOf[0].allOf[1].Payload.items[].fieldIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].labelstring Да
$.oneOf[0].allOf[1].Payload.items[].typestring ["text","longtext","number","boolean","single_select","multi_select"] Да
$.oneOf[0].allOf[1].Payload.items[].valueSurveyAnswerValue ДаValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[0]null Да
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[2]number Да
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[3]boolean Да
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[4]array Да
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[4][]string Нет
$.oneOf[0].allOf[1].Payload.items[].optionsarray Да
$.oneOf[0].allOf[1].Payload.items[].options[]object Нет
$.oneOf[0].allOf[1].Payload.items[].options[].keystring Да
$.oneOf[0].allOf[1].Payload.items[].options[].labelstring Да
$.oneOf[0].allOf[1].Payload.items[].confirmedDate Да
$.oneOf[0].allOf[1].Payload.items[].confirmedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.items[].confirmedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.items[].requestIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].sourceTitlestring Да
$.oneOf[0].allOf[1].Payload.items[].revisioninteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_customer_fields",
    "RequestUserAlias": "example-user",
    "Payload": {
        "canForget": false,
        "items": []
    }
}
Машиночитаемая документация метода
GET

/v1/customer_survey/get_request

#
Read a questionnaire. Only its customer receives drafts, remembered prefills and memory revisions. Sellers receive submitted history only.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
requestID int Да — Sent questionnaire identifier.
adminInspection bool Нет false Explicit read-only inspection requiring AccessSpecialFunctions; logged with actor and request.
Пример запроса (cURL) 
curl --get \
  'https://ru.appointmenttrader.com/v1/customer_survey/get_request' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'adminInspection={{adminInspection}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_get_request_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.requestobject Да
$.oneOf[0].allOf[1].Payload.request.idinteger Да
$.oneOf[0].allOf[1].Payload.request.revisioninteger Да
$.oneOf[0].allOf[1].Payload.request.customerIDinteger Да
$.oneOf[0].allOf[1].Payload.request.sellerIDinteger Да
$.oneOf[0].allOf[1].Payload.request.chatIDinteger Да
$.oneOf[0].allOf[1].Payload.request.bidIDinteger Да
$.oneOf[0].allOf[1].Payload.request.transactionIDinteger Да
$.oneOf[0].allOf[1].Payload.request.titlestring Да
$.oneOf[0].allOf[1].Payload.request.statusstring ["sent","in_progress","submitted","cancelled"] Да
$.oneOf[0].allOf[1].Payload.request.submittedDate Да
$.oneOf[0].allOf[1].Payload.request.submittedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.request.submittedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.request.urlstring Да
$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenboolean НетTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenUntilinteger | null НетSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.titlestring Да
$.oneOf[0].allOf[1].Payload.introductionstring Да
$.oneOf[0].allOf[1].Payload.questionsarray Да
$.oneOf[0].allOf[1].Payload.questions[]object Нет
$.oneOf[0].allOf[1].Payload.questions[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].VersionIDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].QuestionKeystring Да
$.oneOf[0].allOf[1].Payload.questions[].Labelstring Да
$.oneOf[0].allOf[1].Payload.questions[].LabelKey Да
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].HelpTextstring Да
$.oneOf[0].allOf[1].Payload.questions[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] Да
$.oneOf[0].allOf[1].Payload.questions[].RequiredDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].SortOrderDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONstring (application/json) Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONSurveyValidation (декодированный JSON) Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLengthinteger Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integerboolean Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].minnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[1] = [] Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].ValueScope Да
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[0]string ["customer","booking"] Да
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].FieldKey Да
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].validationSurveyValidation Да
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLengthinteger Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integerboolean Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].minnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1] = [] Да
$.oneOf[0].allOf[1].Payload.questions[].Optionsarray Да
$.oneOf[0].allOf[1].Payload.questions[].Options[]object Нет
$.oneOf[0].allOf[1].Payload.questions[].Options[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionIDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].OptionKeystring Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].Labelstring Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrderDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.historyarray Да
$.oneOf[0].allOf[1].Payload.history[]object Нет
$.oneOf[0].allOf[1].Payload.history[].idinteger Да
$.oneOf[0].allOf[1].Payload.history[].revisioninteger Да
$.oneOf[0].allOf[1].Payload.history[].submittedDate Да
$.oneOf[0].allOf[1].Payload.history[].submittedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.history[].submittedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.history[].answersobject Да
$.oneOf[0].allOf[1].Payload.history[].answers.*SurveyAnswerValue НетValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[4][]string Нет
$.oneOf[0].allOf[1].Payload.draft Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].idinteger Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].revisioninteger Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answersobject Да
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*SurveyAnswerValue НетValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[0]null Нет
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[1]string Нет
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[2]number Нет
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[3]boolean Нет
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[4]array Нет
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[4][]string Нет
$.oneOf[0].allOf[1].Payload.draft.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.prefillobject Да
$.oneOf[0].allOf[1].Payload.prefill.*object Нет
$.oneOf[0].allOf[1].Payload.prefill.*.valueSurveyAnswerValue ДаValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[0]null Да
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[1]string Да
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[2]number Да
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[3]boolean Да
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[4]array Да
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[4][]string Нет
$.oneOf[0].allOf[1].Payload.prefill.*.sourcestring ["saved","booking"] Да
$.oneOf[0].allOf[1].Payload.memoryRevisionsobject Да
$.oneOf[0].allOf[1].Payload.memoryRevisions.*integer Нет
$.oneOf[0].allOf[1].Payload.canAnswerboolean Да
$.oneOf[0].allOf[1].Payload.canCancelboolean Да
$.oneOf[0].allOf[1].Payload.canAttachboolean Да
$.oneOf[0].allOf[1].Payload.isCustomerboolean Да
$.oneOf[0].allOf[1].Payload.salesarray Да
$.oneOf[0].allOf[1].Payload.sales[]object Нет
$.oneOf[0].allOf[1].Payload.sales[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.sales[].BidID Да
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate Да
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.sales[].LocationName Да
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[1]null Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_request",
    "RequestUserAlias": "example-user",
    "Payload": {
        "request": {
            "id": 0,
            "revision": 0,
            "customerID": 0,
            "sellerID": 0,
            "chatID": 0,
            "bidID": 0,
            "transactionID": 0,
            "title": "synthetic-example",
            "status": "sent",
            "submittedDate": "synthetic-example",
            "url": "synthetic-example"
        },
        "title": "synthetic-example",
        "introduction": "synthetic-example",
        "questions": [],
        "history": [],
        "draft": {
            "id": 0,
            "revision": 0,
            "submittedDate": "synthetic-example",
            "answers": []
        },
        "prefill": [],
        "memoryRevisions": [],
        "canAnswer": false,
        "canCancel": false,
        "canAttach": false,
        "isCustomer": false,
        "sales": []
    }
}
Машиночитаемая документация метода
GET

/v1/customer_survey/get_requests

#
List only questionnaires sent or received by the acting user. Context filters never widen that access.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
customerID int Нет 0 Filter recipient.
transactionID int Нет 0 Filter a sale, including surveys for its bid and same original pair.
bidID int Нет 0 Filter bid.
beforeID int Нет 0 Pagination cursor.
sentOnly bool Нет false Seller dashboard filter.
completedOnly bool Нет false Only requests with a submitted response; excludes unanswered requests and private drafts.
Пример запроса (cURL) 
curl --get \
  'https://ru.appointmenttrader.com/v1/customer_survey/get_requests' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'customerID={{customerID}}' \
  --data-urlencode 'transactionID={{transactionID}}' \
  --data-urlencode 'bidID={{bidID}}' \
  --data-urlencode 'beforeID={{beforeID}}' \
  --data-urlencode 'sentOnly={{sentOnly}}' \
  --data-urlencode 'completedOnly={{completedOnly}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_get_requests_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.itemsarray Да
$.oneOf[0].allOf[1].Payload.items[]object Нет
$.oneOf[0].allOf[1].Payload.items[].idinteger Да
$.oneOf[0].allOf[1].Payload.items[].revisioninteger Да
$.oneOf[0].allOf[1].Payload.items[].customerIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].sellerIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].chatIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].bidIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].transactionIDinteger Да
$.oneOf[0].allOf[1].Payload.items[].titlestring Да
$.oneOf[0].allOf[1].Payload.items[].statusstring ["sent","in_progress","submitted","cancelled"] Да
$.oneOf[0].allOf[1].Payload.items[].submittedDate Да
$.oneOf[0].allOf[1].Payload.items[].submittedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.items[].submittedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.items[].urlstring Да
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenboolean НетTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntilinteger | null НетSaved current-round ClosesAt as Unix seconds; null when identity is visible. Reveal is authoritative only on a new response.
$.oneOf[0].allOf[1].Payload.hasMoreboolean Да
$.oneOf[0].allOf[1].Payload.beforeIDinteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_requests",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "hasMore": false,
        "beforeID": 0
    }
}
Машиночитаемая документация метода
GET

/v1/customer_survey/get_template

#
Read a versioned AT or seller-owned template for preview/edit/copy.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
templateID int Да — Template identifier.
Пример запроса (cURL) 
curl --get \
  'https://ru.appointmenttrader.com/v1/customer_survey/get_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'templateID={{templateID}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_get_template_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.CreatedDatestring Да
$.oneOf[0].allOf[1].Payload.OwnerUserID Да
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.StarterKey Да
$.oneOf[0].allOf[1].Payload.StarterKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.StarterKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.SourceTemplateID Да
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.CurrentVersionID Да
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.ArchivedDate Да
$.oneOf[0].allOf[1].Payload.ArchivedDate.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.ArchivedDate.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Titlestring Да
$.oneOf[0].allOf[1].Payload.TitleKey Да
$.oneOf[0].allOf[1].Payload.TitleKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.TitleKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.VersionNumber Да
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.Introduction Да
$.oneOf[0].allOf[1].Payload.Introduction.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.Introduction.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questionsarray Да
$.oneOf[0].allOf[1].Payload.questions[]object Нет
$.oneOf[0].allOf[1].Payload.questions[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].VersionIDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].QuestionKeystring Да
$.oneOf[0].allOf[1].Payload.questions[].Labelstring Да
$.oneOf[0].allOf[1].Payload.questions[].LabelKey Да
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].HelpTextstring Да
$.oneOf[0].allOf[1].Payload.questions[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] Да
$.oneOf[0].allOf[1].Payload.questions[].RequiredDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].SortOrderDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONstring (application/json) Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONSurveyValidation (декодированный JSON) Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLengthinteger Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integerboolean Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].minnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[1] = [] Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].ValueScope Да
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[0]string ["customer","booking"] Да
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].FieldKey Да
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].validationSurveyValidation Да
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]object Да
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLengthinteger Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integerboolean Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].minnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxnumber Нет
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1] = [] Да
$.oneOf[0].allOf[1].Payload.questions[].Optionsarray Да
$.oneOf[0].allOf[1].Payload.questions[].Options[]object Нет
$.oneOf[0].allOf[1].Payload.questions[].Options[].IDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionIDDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0]DatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[1]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].OptionKeystring Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].Labelstring Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[0]string Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[1]null Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrderDatabaseInteger ДаInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[0]integer Да
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[1]string Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_template",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ID": 0,
        "CreatedDate": "synthetic-example",
        "OwnerUserID": 0,
        "StarterKey": "synthetic-example",
        "SourceTemplateID": 0,
        "CurrentVersionID": 0,
        "ArchivedDate": "synthetic-example",
        "Title": "synthetic-example",
        "TitleKey": "synthetic-example",
        "VersionNumber": 0,
        "Introduction": "synthetic-example",
        "questions": []
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_attach

#
Attach a customer/bid questionnaire to a completed sale between its original seller and customer. Existing sale links cannot be moved.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
requestID int Да — Questionnaire identifier.
transactionID int Да — Completed sale identifier.
expectedRevision int Да — Last observed request revision.
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_attach' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'transactionID={{transactionID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_attach_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.requestIDinteger Да
$.oneOf[0].allOf[1].Payload.chatIDinteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_attach",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "chatID": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_cancel

#
Cancel an unanswered questionnaire as its sending seller.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
requestID int Да — Questionnaire identifier.
expectedRevision int Да — Last observed request revision.
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_cancel_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.requestIDinteger Да
$.oneOf[0].allOf[1].Payload.chatIDinteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "chatID": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_draft

#
Save a customer-only draft. Drafts never update seller CRM or remembered values.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
dataJSON string Да — UTF-8 JSON object, preferably encoded as base64url: followed by unpadded URL-safe base64 to preserve authored text. Object: requestID, expectedRevision, operationKey, answers keyed by question ID, memoryRevisions keyed by field ID. Null means unanswered; false and zero are answers.
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_draft' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: dataJSON
ПолеТипОбязательноОписание
dataJSONstring (application/json) Да
dataJSONobject (декодированный JSON) Да
dataJSON.requestIDinteger Да
dataJSON.operationKeystring Да
dataJSON.expectedRevisioninteger Да
dataJSON.answersobject Да
dataJSON.answers.*SurveyAnswerValue НетValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
dataJSON.answers.*.anyOf[0]null Нет
dataJSON.answers.*.anyOf[1]string Нет
dataJSON.answers.*.anyOf[2]number Нет
dataJSON.answers.*.anyOf[3]boolean Нет
dataJSON.answers.*.anyOf[4]array Нет
dataJSON.answers.*.anyOf[4][]string Нет
dataJSON.memoryRevisionsobject Да
dataJSON.memoryRevisions.*integer Нет
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_draft_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.requestIDinteger Да
$.oneOf[0].allOf[1].Payload.revisioninteger Да
$.oneOf[0].allOf[1].Payload.chatIDinteger Нет
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_draft",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "revision": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_forget

#
Forget an own remembered value for future prefills. Existing seller-shared submissions remain unchanged.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
fieldID int Да — Remembered field identifier.
expectedRevision int Да — Memory revision returned by get_customer_fields.
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_forget' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fieldID={{fieldID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_forget_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.fieldIDinteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_forget",
    "RequestUserAlias": "example-user",
    "Payload": {
        "fieldID": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_send

#
Send one questionnaire to the server-resolved customer in an accepted chat. Reuse operationKey for retries only. Active bid selection pauses incoming questionnaires unless the sender has GlobalCommunityAdministration; ErrorReason=active_bid_selection.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
dataJSON string Да — UTF-8 JSON object, preferably encoded as base64url: followed by unpadded URL-safe base64 to preserve authored text. Object: chatID, templateID, versionID, transactionID (optional), operationKey (16-80 ASCII letters/digits/hyphens/underscores).
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_send' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: dataJSON
ПолеТипОбязательноОписание
dataJSONstring (application/json) Да
dataJSONobject (декодированный JSON) Да
dataJSON.chatIDinteger Да
dataJSON.templateIDinteger Да
dataJSON.versionIDinteger Да
dataJSON.transactionIDinteger Нет
dataJSON.operationKeystring Да
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_send_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.requestIDinteger Да
$.oneOf[0].allOf[1].Payload.chatIDinteger Нет
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_send",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_submit

#
Confirm and share a new immutable response revision with this seller. Also updates customer memory and this seller's CRM pointers atomically.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
dataJSON string Да — UTF-8 JSON object, preferably encoded with the base64url: prefix. Same object as /v1/customer_survey/set_draft; required answers and memory revisions are enforced.
isWritingRequest bool Нет false Confirm customer sharing.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_submit' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: dataJSON
ПолеТипОбязательноОписание
dataJSONstring (application/json) Да
dataJSONobject (декодированный JSON) Да
dataJSON.requestIDinteger Да
dataJSON.operationKeystring Да
dataJSON.expectedRevisioninteger Да
dataJSON.answersobject Да
dataJSON.answers.*SurveyAnswerValue НетValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
dataJSON.answers.*.anyOf[0]null Нет
dataJSON.answers.*.anyOf[1]string Нет
dataJSON.answers.*.anyOf[2]number Нет
dataJSON.answers.*.anyOf[3]boolean Нет
dataJSON.answers.*.anyOf[4]array Нет
dataJSON.answers.*.anyOf[4][]string Нет
dataJSON.memoryRevisionsobject Да
dataJSON.memoryRevisions.*integer Нет
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_submit_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.requestIDinteger Да
$.oneOf[0].allOf[1].Payload.revisioninteger Да
$.oneOf[0].allOf[1].Payload.chatIDinteger Нет
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_submit",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "revision": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_template

#
Create or append an immutable template version. A system-field ID owns type, label and options; clients cannot redefine them. Answer types: text (single-line input), longtext (multiline textarea), number, boolean, single_select, multi_select. Both text types preserve nonblank string values up to 4000 characters by default; empty or whitespace-only text is unanswered.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
dataJSON string Да — UTF-8 JSON object, preferably encoded as base64url: followed by unpadded URL-safe base64 to preserve authored text. Object: templateID (zero creates), expectedVersionID, sourceTemplateID, title, introduction, questions [{fieldID, label, help, type, required, remember, integer, min, max, options:[{key,label}]}].
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Параметры: dataJSON
ПолеТипОбязательноОписание
dataJSONstring (application/json) Да
dataJSONobject (декодированный JSON) Да
dataJSON.titlestring Да
dataJSON.introductionstring Нет
dataJSON.templateIDinteger Нет
dataJSON.sourceTemplateIDinteger Нет
dataJSON.expectedVersionIDinteger Нет
dataJSON.questionsarray Да
dataJSON.questions[] Нет
dataJSON.questions[].anyOf[0]object Нет
dataJSON.questions[].anyOf[0].fieldIDinteger Да
dataJSON.questions[].anyOf[0].labelstring Нет
dataJSON.questions[].anyOf[0].typestring ["text","longtext","number","boolean","single_select","multi_select"] Нет
dataJSON.questions[].anyOf[0].helpstring Нет
dataJSON.questions[].anyOf[0].requiredboolean Нет
dataJSON.questions[].anyOf[0].rememberboolean Нет
dataJSON.questions[].anyOf[0].integerboolean Нет
dataJSON.questions[].anyOf[0].minDatabaseNumber НетNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[0].min.oneOf[0]number Нет
dataJSON.questions[].anyOf[0].min.oneOf[1]string Нет
dataJSON.questions[].anyOf[0].maxDatabaseNumber НетNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[0].max.oneOf[0]number Нет
dataJSON.questions[].anyOf[0].max.oneOf[1]string Нет
dataJSON.questions[].anyOf[0].optionsarray Нет
dataJSON.questions[].anyOf[0].options[]object Нет
dataJSON.questions[].anyOf[0].options[].keystring Нет
dataJSON.questions[].anyOf[0].options[].labelstring Да
dataJSON.questions[].anyOf[1]object Нет
dataJSON.questions[].anyOf[1].fieldIDinteger Нет
dataJSON.questions[].anyOf[1].labelstring Да
dataJSON.questions[].anyOf[1].typestring ["text","longtext","number","boolean","single_select","multi_select"] Да
dataJSON.questions[].anyOf[1].helpstring Нет
dataJSON.questions[].anyOf[1].requiredboolean Нет
dataJSON.questions[].anyOf[1].rememberboolean Нет
dataJSON.questions[].anyOf[1].integerboolean Нет
dataJSON.questions[].anyOf[1].minDatabaseNumber НетNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[1].min.oneOf[0]number Нет
dataJSON.questions[].anyOf[1].min.oneOf[1]string Нет
dataJSON.questions[].anyOf[1].maxDatabaseNumber НетNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[1].max.oneOf[0]number Нет
dataJSON.questions[].anyOf[1].max.oneOf[1]string Нет
dataJSON.questions[].anyOf[1].optionsarray Нет
dataJSON.questions[].anyOf[1].options[]object Нет
dataJSON.questions[].anyOf[1].options[].keystring Нет
dataJSON.questions[].anyOf[1].options[].labelstring Да
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_template_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.templateIDinteger Да
$.oneOf[0].allOf[1].Payload.versionIDinteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_template",
    "RequestUserAlias": "example-user",
    "Payload": {
        "templateID": 0,
        "versionID": 0
    }
}
Машиночитаемая документация метода
POST

/v1/customer_survey/set_template_archive

#
Archive an owned template without changing sent questionnaires.

Параметры

ИмяТипОбязательноПо умолчаниюОписание
templateID int Да — Template identifier.
expectedVersionID int Да — Last observed current version ID.
isWritingRequest bool Нет false Confirm write.
Пример запроса (cURL) 
curl --request POST \
  'https://ru.appointmenttrader.com/v1/customer_survey/set_template_archive' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'templateID={{templateID}}' \
  --data-urlencode 'expectedVersionID={{expectedVersionID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON
See the shared response schema and synthetic example.
Поля ответа
ПолеТипОбязательноОписание
$customer_survey_set_template_archive_Response Да
$.oneOf[0] Да
$.oneOf[0].allOf[0]object Да
$.oneOf[0].allOf[0].RequestUserAliasstring Да
$.oneOf[0].allOf[0].RequestPathstring | null Да
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Да
$.oneOf[0].allOf[0].ResponseCodeinteger Да
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Да
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Нет
$.oneOf[0].allOf[1]object Да
$.oneOf[0].allOf[1].Payloadobject Да
$.oneOf[0].allOf[1].Payload.templateIDinteger Да
$.oneOf[1]object Да
$.oneOf[1].RequestUserAliasstring Да
$.oneOf[1].RequestPathstring | null Да
$.oneOf[1].RequestStatus = "Failed" Да
$.oneOf[1].ResponseCodeinteger Да
$.oneOf[1].ResponseMessageAPIResponseMessage Да
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Да
$.oneOf[1].ResponseMessage.oneOf[1]array Да
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Нет
$.oneOf[1].ResponseMessage.oneOf[2]object Да
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Нет
$.oneOf[1].RequestImpersonatedByUserAliasstring Нет
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] Нет
Пример ответа 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_template_archive",
    "RequestUserAlias": "example-user",
    "Payload": {
        "templateID": 0
    }
}
Машиночитаемая документация метода