AT AppointmentTrader
Giriş yap
Şu an çevrimiçi  

/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.

Parametreler

AdTürGerekliVarsayılanAçıklama
chatID int HAYIR 0 Accepted direct or bid chat; zero lists the acting seller's catalog.
İstek örneği (cURL) 
curl --get \
  'https://tr.appointmenttrader.com/v1/customer_survey/get_catalog' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'chatID={{chatID}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_get_catalog_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.fieldsarray Evet
$.oneOf[0].allOf[1].Payload.fields[]object HAYIR
$.oneOf[0].allOf[1].Payload.fields[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.fields[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.fields[].CreatedDatestring Evet
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID Evet
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.fields[].OwnerUserID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.fields[].FieldKeystring Evet
$.oneOf[0].allOf[1].Payload.fields[].Labelstring Evet
$.oneOf[0].allOf[1].Payload.fields[].LabelKey Evet
$.oneOf[0].allOf[1].Payload.fields[].LabelKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.fields[].LabelKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.fields[].FieldGroupstring Evet
$.oneOf[0].allOf[1].Payload.fields[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] Evet
$.oneOf[0].allOf[1].Payload.fields[].ValueScopestring ["customer","booking"] Evet
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSONstring (application/json) Evet
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSONSurveyValidation (çözümlenmiş JSON) Evet
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxLengthinteger HAYIR
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].integerboolean HAYIR
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].minnumber HAYIR
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxnumber HAYIR
$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[1] = [] Evet
$.oneOf[0].allOf[1].Payload.fields[].IsActiveDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].IsActive.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.fields[].IsActive.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.fields[].Optionsarray Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[]object HAYIR
$.oneOf[0].allOf[1].Payload.fields[].Options[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].FieldID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].OptionKeystring Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].Labelstring Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].LabelKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrderDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrder.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.fields[].Options[].SortOrder.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.templatesarray Evet
$.oneOf[0].allOf[1].Payload.templates[]object HAYIR
$.oneOf[0].allOf[1].Payload.templates[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.templates[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.templates[].CreatedDatestring Evet
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID Evet
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.templates[].OwnerUserID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.templates[].StarterKey Evet
$.oneOf[0].allOf[1].Payload.templates[].StarterKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.templates[].StarterKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID Evet
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.templates[].SourceTemplateID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID Evet
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.templates[].CurrentVersionID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate Evet
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.templates[].ArchivedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.templates[].Titlestring Evet
$.oneOf[0].allOf[1].Payload.templates[].TitleKey Evet
$.oneOf[0].allOf[1].Payload.templates[].TitleKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.templates[].TitleKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.templates[].VersionNumberDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.templates[].VersionNumber.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.templates[].VersionNumber.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.context Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0].canSendboolean Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0].writableboolean Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0].chatIDinteger Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0].customerIDinteger Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0].bidIDinteger Evet
$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonCodestring HAYIR
$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonstring HAYIR
$.oneOf[0].allOf[1].Payload.context.anyOf[0].otherUserIDinteger HAYIR
$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenboolean HAYIRTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenUntilinteger | null HAYIRSaved 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 Evet
$.oneOf[0].allOf[1].Payload.customer Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].aliasstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarEmojistring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageUrlstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageURLstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].labelstring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileUrlstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileURLstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].titlestring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customColorstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customTextColorstring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarModestring | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].htmlstring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].idinteger | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].userIDinteger | null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].isRichboolean Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].idinteger Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].thumbUrlstring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaUrlstring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaTypestring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].widthinteger Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].heightinteger Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].titlestring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isImageboolean Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isEmbeddedboolean Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frameobject Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionXPercentnumber Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionYPercentnumber Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.zoomPercentnumber Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].backgroundUrlstring HAYIR
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medalsarray Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[]object HAYIR
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].Namestring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].URLstring Evet
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenboolean HAYIRAn anonymized author has no profile or follow action.
$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenUntilinteger | null HAYIRCurrent response-race closing timestamp in Unix seconds.
$.oneOf[0].allOf[1].Payload.customer.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.salesarray Evet
$.oneOf[0].allOf[1].Payload.sales[]object HAYIR
$.oneOf[0].allOf[1].Payload.sales[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate Evet
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sales[].LocationName Evet
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[1]null Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
customerID int Evet — Customer user ID.
İstek örneği (cURL) 
curl --get \
  'https://tr.appointmenttrader.com/v1/customer_survey/get_customer_fields' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'customerID={{customerID}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_get_customer_fields_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.canForgetboolean Evet
$.oneOf[0].allOf[1].Payload.itemsarray Evet
$.oneOf[0].allOf[1].Payload.items[]object HAYIR
$.oneOf[0].allOf[1].Payload.items[].fieldIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].labelstring Evet
$.oneOf[0].allOf[1].Payload.items[].typestring ["text","longtext","number","boolean","single_select","multi_select"] Evet
$.oneOf[0].allOf[1].Payload.items[].valueSurveyAnswerValue EvetValue 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 Evet
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[1]string Evet
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[2]number Evet
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[3]boolean Evet
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[4]array Evet
$.oneOf[0].allOf[1].Payload.items[].value.anyOf[4][]string HAYIR
$.oneOf[0].allOf[1].Payload.items[].optionsarray Evet
$.oneOf[0].allOf[1].Payload.items[].options[]object HAYIR
$.oneOf[0].allOf[1].Payload.items[].options[].keystring Evet
$.oneOf[0].allOf[1].Payload.items[].options[].labelstring Evet
$.oneOf[0].allOf[1].Payload.items[].confirmedDate Evet
$.oneOf[0].allOf[1].Payload.items[].confirmedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.items[].confirmedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.items[].requestIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].sourceTitlestring Evet
$.oneOf[0].allOf[1].Payload.items[].revisioninteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_customer_fields",
    "RequestUserAlias": "example-user",
    "Payload": {
        "canForget": false,
        "items": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
GET

/v1/customer_survey/get_request

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

Parametreler

AdTürGerekliVarsayılanAçıklama
requestID int Evet — Sent questionnaire identifier.
adminInspection bool HAYIR false Explicit read-only inspection requiring AccessSpecialFunctions; logged with actor and request.
İstek örneği (cURL) 
curl --get \
  'https://tr.appointmenttrader.com/v1/customer_survey/get_request' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'adminInspection={{adminInspection}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_get_request_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.requestobject Evet
$.oneOf[0].allOf[1].Payload.request.idinteger Evet
$.oneOf[0].allOf[1].Payload.request.revisioninteger Evet
$.oneOf[0].allOf[1].Payload.request.customerIDinteger Evet
$.oneOf[0].allOf[1].Payload.request.sellerIDinteger Evet
$.oneOf[0].allOf[1].Payload.request.chatIDinteger Evet
$.oneOf[0].allOf[1].Payload.request.bidIDinteger Evet
$.oneOf[0].allOf[1].Payload.request.transactionIDinteger Evet
$.oneOf[0].allOf[1].Payload.request.titlestring Evet
$.oneOf[0].allOf[1].Payload.request.statusstring ["sent","in_progress","submitted","cancelled"] Evet
$.oneOf[0].allOf[1].Payload.request.submittedDate Evet
$.oneOf[0].allOf[1].Payload.request.submittedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.request.submittedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.request.urlstring Evet
$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenboolean HAYIRTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenUntilinteger | null HAYIRSaved 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 Evet
$.oneOf[0].allOf[1].Payload.introductionstring Evet
$.oneOf[0].allOf[1].Payload.questionsarray Evet
$.oneOf[0].allOf[1].Payload.questions[]object HAYIR
$.oneOf[0].allOf[1].Payload.questions[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].VersionIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].QuestionKeystring Evet
$.oneOf[0].allOf[1].Payload.questions[].Labelstring Evet
$.oneOf[0].allOf[1].Payload.questions[].LabelKey Evet
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].HelpTextstring Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] Evet
$.oneOf[0].allOf[1].Payload.questions[].RequiredDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].SortOrderDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONstring (application/json) Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONSurveyValidation (çözümlenmiş JSON) Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLengthinteger HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integerboolean HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].minnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[1] = [] Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].ValueScope Evet
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[0]string ["customer","booking"] Evet
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldKey Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].validationSurveyValidation Evet
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLengthinteger HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integerboolean HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].minnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1] = [] Evet
$.oneOf[0].allOf[1].Payload.questions[].Optionsarray Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[]object HAYIR
$.oneOf[0].allOf[1].Payload.questions[].Options[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].OptionKeystring Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].Labelstring Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrderDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.historyarray Evet
$.oneOf[0].allOf[1].Payload.history[]object HAYIR
$.oneOf[0].allOf[1].Payload.history[].idinteger Evet
$.oneOf[0].allOf[1].Payload.history[].revisioninteger Evet
$.oneOf[0].allOf[1].Payload.history[].submittedDate Evet
$.oneOf[0].allOf[1].Payload.history[].submittedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.history[].submittedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.history[].answersobject Evet
$.oneOf[0].allOf[1].Payload.history[].answers.*SurveyAnswerValue HAYIRValue 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 HAYIR
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.history[].answers.*.anyOf[4][]string HAYIR
$.oneOf[0].allOf[1].Payload.draft Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].idinteger Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].revisioninteger Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].submittedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answersobject Evet
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*SurveyAnswerValue HAYIRValue 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 HAYIR
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[1]string HAYIR
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[2]number HAYIR
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[3]boolean HAYIR
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[4]array HAYIR
$.oneOf[0].allOf[1].Payload.draft.anyOf[0].answers.*.anyOf[4][]string HAYIR
$.oneOf[0].allOf[1].Payload.draft.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.prefillobject Evet
$.oneOf[0].allOf[1].Payload.prefill.*object HAYIR
$.oneOf[0].allOf[1].Payload.prefill.*.valueSurveyAnswerValue EvetValue 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 Evet
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[1]string Evet
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[2]number Evet
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[3]boolean Evet
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[4]array Evet
$.oneOf[0].allOf[1].Payload.prefill.*.value.anyOf[4][]string HAYIR
$.oneOf[0].allOf[1].Payload.prefill.*.sourcestring ["saved","booking"] Evet
$.oneOf[0].allOf[1].Payload.memoryRevisionsobject Evet
$.oneOf[0].allOf[1].Payload.memoryRevisions.*integer HAYIR
$.oneOf[0].allOf[1].Payload.canAnswerboolean Evet
$.oneOf[0].allOf[1].Payload.canCancelboolean Evet
$.oneOf[0].allOf[1].Payload.canAttachboolean Evet
$.oneOf[0].allOf[1].Payload.isCustomerboolean Evet
$.oneOf[0].allOf[1].Payload.salesarray Evet
$.oneOf[0].allOf[1].Payload.sales[]object HAYIR
$.oneOf[0].allOf[1].Payload.sales[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.sales[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.sales[].BidID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.sales[].AppointmentID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate Evet
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.sales[].TransactionCompletedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sales[].LocationName Evet
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.sales[].LocationName.anyOf[1]null Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
GET

/v1/customer_survey/get_requests

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

Parametreler

AdTürGerekliVarsayılanAçıklama
customerID int HAYIR 0 Filter recipient.
transactionID int HAYIR 0 Filter a sale, including surveys for its bid and same original pair.
bidID int HAYIR 0 Filter bid.
beforeID int HAYIR 0 Pagination cursor.
sentOnly bool HAYIR false Seller dashboard filter.
completedOnly bool HAYIR false Only requests with a submitted response; excludes unanswered requests and private drafts.
İstek örneği (cURL) 
curl --get \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_get_requests_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.itemsarray Evet
$.oneOf[0].allOf[1].Payload.items[]object HAYIR
$.oneOf[0].allOf[1].Payload.items[].idinteger Evet
$.oneOf[0].allOf[1].Payload.items[].revisioninteger Evet
$.oneOf[0].allOf[1].Payload.items[].customerIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].sellerIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].chatIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].bidIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].transactionIDinteger Evet
$.oneOf[0].allOf[1].Payload.items[].titlestring Evet
$.oneOf[0].allOf[1].Payload.items[].statusstring ["sent","in_progress","submitted","cancelled"] Evet
$.oneOf[0].allOf[1].Payload.items[].submittedDate Evet
$.oneOf[0].allOf[1].Payload.items[].submittedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.items[].submittedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.items[].urlstring Evet
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenboolean HAYIRTrue when the authenticated viewer cannot see the buyer during the current response race.
$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntilinteger | null HAYIRSaved 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 Evet
$.oneOf[0].allOf[1].Payload.beforeIDinteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/get_requests",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "hasMore": false,
        "beforeID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
GET

/v1/customer_survey/get_template

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

Parametreler

AdTürGerekliVarsayılanAçıklama
templateID int Evet — Template identifier.
İstek örneği (cURL) 
curl --get \
  'https://tr.appointmenttrader.com/v1/customer_survey/get_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'templateID={{templateID}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_get_template_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.CreatedDatestring Evet
$.oneOf[0].allOf[1].Payload.OwnerUserID Evet
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.OwnerUserID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.StarterKey Evet
$.oneOf[0].allOf[1].Payload.StarterKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.StarterKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.SourceTemplateID Evet
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.SourceTemplateID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.CurrentVersionID Evet
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.CurrentVersionID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.ArchivedDate Evet
$.oneOf[0].allOf[1].Payload.ArchivedDate.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.ArchivedDate.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Titlestring Evet
$.oneOf[0].allOf[1].Payload.TitleKey Evet
$.oneOf[0].allOf[1].Payload.TitleKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.TitleKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.VersionNumber Evet
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.VersionNumber.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.Introduction Evet
$.oneOf[0].allOf[1].Payload.Introduction.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.Introduction.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questionsarray Evet
$.oneOf[0].allOf[1].Payload.questions[]object HAYIR
$.oneOf[0].allOf[1].Payload.questions[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].VersionIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].VersionID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].QuestionKeystring Evet
$.oneOf[0].allOf[1].Payload.questions[].Labelstring Evet
$.oneOf[0].allOf[1].Payload.questions[].LabelKey Evet
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.questions[].LabelKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].HelpTextstring Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldTypestring ["text","number","boolean","single_select","multi_select","longtext"] Evet
$.oneOf[0].allOf[1].Payload.questions[].RequiredDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Required.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].SortOrderDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].SortOrder.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONstring (application/json) Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSONSurveyValidation (çözümlenmiş JSON) Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLengthinteger HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integerboolean HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].minnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[1] = [] Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldOwnerUserID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].ValueScope Evet
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[0]string ["customer","booking"] Evet
$.oneOf[0].allOf[1].Payload.questions[].ValueScope.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldKey Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.questions[].FieldKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].validationSurveyValidation Evet
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLengthinteger HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integerboolean HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].minnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxnumber HAYIR
$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1] = [] Evet
$.oneOf[0].allOf[1].Payload.questions[].Optionsarray Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[]object HAYIR
$.oneOf[0].allOf[1].Payload.questions[].Options[].IDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].ID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].QuestionID.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0]DatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[0].oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].FieldOptionID.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].OptionKeystring Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].Labelstring Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].LabelKey.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrderDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.questions[].Options[].SortOrder.oneOf[1]string Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "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": []
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
requestID int Evet — Questionnaire identifier.
transactionID int Evet — Completed sale identifier.
expectedRevision int Evet — Last observed request revision.
isWritingRequest bool HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_attach_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.requestIDinteger Evet
$.oneOf[0].allOf[1].Payload.chatIDinteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_attach",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "chatID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
POST

/v1/customer_survey/set_cancel

#
Cancel an unanswered questionnaire as its sending seller.

Parametreler

AdTürGerekliVarsayılanAçıklama
requestID int Evet — Questionnaire identifier.
expectedRevision int Evet — Last observed request revision.
isWritingRequest bool HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.appointmenttrader.com/v1/customer_survey/set_cancel' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'requestID={{requestID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_cancel_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.requestIDinteger Evet
$.oneOf[0].allOf[1].Payload.chatIDinteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_cancel",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "chatID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
POST

/v1/customer_survey/set_draft

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

Parametreler

AdTürGerekliVarsayılanAçıklama
dataJSON string Evet — 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 HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.appointmenttrader.com/v1/customer_survey/set_draft' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Parametreler: dataJSON
AlanTürGerekliAçıklama
dataJSONstring (application/json) Evet
dataJSONobject (çözümlenmiş JSON) Evet
dataJSON.requestIDinteger Evet
dataJSON.operationKeystring Evet
dataJSON.expectedRevisioninteger Evet
dataJSON.answersobject Evet
dataJSON.answers.*SurveyAnswerValue HAYIRValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
dataJSON.answers.*.anyOf[0]null HAYIR
dataJSON.answers.*.anyOf[1]string HAYIR
dataJSON.answers.*.anyOf[2]number HAYIR
dataJSON.answers.*.anyOf[3]boolean HAYIR
dataJSON.answers.*.anyOf[4]array HAYIR
dataJSON.answers.*.anyOf[4][]string HAYIR
dataJSON.memoryRevisionsobject Evet
dataJSON.memoryRevisions.*integer HAYIR
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_draft_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.requestIDinteger Evet
$.oneOf[0].allOf[1].Payload.revisioninteger Evet
$.oneOf[0].allOf[1].Payload.chatIDinteger HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_draft",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "revision": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
POST

/v1/customer_survey/set_forget

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

Parametreler

AdTürGerekliVarsayılanAçıklama
fieldID int Evet — Remembered field identifier.
expectedRevision int Evet — Memory revision returned by get_customer_fields.
isWritingRequest bool HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.appointmenttrader.com/v1/customer_survey/set_forget' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'fieldID={{fieldID}}' \
  --data-urlencode 'expectedRevision={{expectedRevision}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_forget_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.fieldIDinteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_forget",
    "RequestUserAlias": "example-user",
    "Payload": {
        "fieldID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
dataJSON string Evet — 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 HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.appointmenttrader.com/v1/customer_survey/set_send' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Parametreler: dataJSON
AlanTürGerekliAçıklama
dataJSONstring (application/json) Evet
dataJSONobject (çözümlenmiş JSON) Evet
dataJSON.chatIDinteger Evet
dataJSON.templateIDinteger Evet
dataJSON.versionIDinteger Evet
dataJSON.transactionIDinteger HAYIR
dataJSON.operationKeystring Evet
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_send_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.requestIDinteger Evet
$.oneOf[0].allOf[1].Payload.chatIDinteger HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_send",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
dataJSON string Evet — 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 HAYIR false Confirm customer sharing.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.appointmenttrader.com/v1/customer_survey/set_submit' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Parametreler: dataJSON
AlanTürGerekliAçıklama
dataJSONstring (application/json) Evet
dataJSONobject (çözümlenmiş JSON) Evet
dataJSON.requestIDinteger Evet
dataJSON.operationKeystring Evet
dataJSON.expectedRevisioninteger Evet
dataJSON.answersobject Evet
dataJSON.answers.*SurveyAnswerValue HAYIRValue follows the question type: text or selected key, decimal numeric string, boolean, selected-key list, or null when unanswered.
dataJSON.answers.*.anyOf[0]null HAYIR
dataJSON.answers.*.anyOf[1]string HAYIR
dataJSON.answers.*.anyOf[2]number HAYIR
dataJSON.answers.*.anyOf[3]boolean HAYIR
dataJSON.answers.*.anyOf[4]array HAYIR
dataJSON.answers.*.anyOf[4][]string HAYIR
dataJSON.memoryRevisionsobject Evet
dataJSON.memoryRevisions.*integer HAYIR
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_submit_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.requestIDinteger Evet
$.oneOf[0].allOf[1].Payload.revisioninteger Evet
$.oneOf[0].allOf[1].Payload.chatIDinteger HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_submit",
    "RequestUserAlias": "example-user",
    "Payload": {
        "requestID": 0,
        "revision": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
dataJSON string Evet — 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 HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.appointmenttrader.com/v1/customer_survey/set_template' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'dataJSON={{dataJSON}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Parametreler: dataJSON
AlanTürGerekliAçıklama
dataJSONstring (application/json) Evet
dataJSONobject (çözümlenmiş JSON) Evet
dataJSON.titlestring Evet
dataJSON.introductionstring HAYIR
dataJSON.templateIDinteger HAYIR
dataJSON.sourceTemplateIDinteger HAYIR
dataJSON.expectedVersionIDinteger HAYIR
dataJSON.questionsarray Evet
dataJSON.questions[] HAYIR
dataJSON.questions[].anyOf[0]object HAYIR
dataJSON.questions[].anyOf[0].fieldIDinteger Evet
dataJSON.questions[].anyOf[0].labelstring HAYIR
dataJSON.questions[].anyOf[0].typestring ["text","longtext","number","boolean","single_select","multi_select"] HAYIR
dataJSON.questions[].anyOf[0].helpstring HAYIR
dataJSON.questions[].anyOf[0].requiredboolean HAYIR
dataJSON.questions[].anyOf[0].rememberboolean HAYIR
dataJSON.questions[].anyOf[0].integerboolean HAYIR
dataJSON.questions[].anyOf[0].minDatabaseNumber HAYIRNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[0].min.oneOf[0]number HAYIR
dataJSON.questions[].anyOf[0].min.oneOf[1]string HAYIR
dataJSON.questions[].anyOf[0].maxDatabaseNumber HAYIRNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[0].max.oneOf[0]number HAYIR
dataJSON.questions[].anyOf[0].max.oneOf[1]string HAYIR
dataJSON.questions[].anyOf[0].optionsarray HAYIR
dataJSON.questions[].anyOf[0].options[]object HAYIR
dataJSON.questions[].anyOf[0].options[].keystring HAYIR
dataJSON.questions[].anyOf[0].options[].labelstring Evet
dataJSON.questions[].anyOf[1]object HAYIR
dataJSON.questions[].anyOf[1].fieldIDinteger HAYIR
dataJSON.questions[].anyOf[1].labelstring Evet
dataJSON.questions[].anyOf[1].typestring ["text","longtext","number","boolean","single_select","multi_select"] Evet
dataJSON.questions[].anyOf[1].helpstring HAYIR
dataJSON.questions[].anyOf[1].requiredboolean HAYIR
dataJSON.questions[].anyOf[1].rememberboolean HAYIR
dataJSON.questions[].anyOf[1].integerboolean HAYIR
dataJSON.questions[].anyOf[1].minDatabaseNumber HAYIRNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[1].min.oneOf[0]number HAYIR
dataJSON.questions[].anyOf[1].min.oneOf[1]string HAYIR
dataJSON.questions[].anyOf[1].maxDatabaseNumber HAYIRNumeric value; MySQL reads can serialize numbers as numeric strings.
dataJSON.questions[].anyOf[1].max.oneOf[0]number HAYIR
dataJSON.questions[].anyOf[1].max.oneOf[1]string HAYIR
dataJSON.questions[].anyOf[1].optionsarray HAYIR
dataJSON.questions[].anyOf[1].options[]object HAYIR
dataJSON.questions[].anyOf[1].options[].keystring HAYIR
dataJSON.questions[].anyOf[1].options[].labelstring Evet
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_template_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.templateIDinteger Evet
$.oneOf[0].allOf[1].Payload.versionIDinteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_template",
    "RequestUserAlias": "example-user",
    "Payload": {
        "templateID": 0,
        "versionID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri
POST

/v1/customer_survey/set_template_archive

#
Archive an owned template without changing sent questionnaires.

Parametreler

AdTürGerekliVarsayılanAçıklama
templateID int Evet — Template identifier.
expectedVersionID int Evet — Last observed current version ID.
isWritingRequest bool HAYIR false Confirm write.
İstek örneği (cURL) 
curl --request POST \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$customer_survey_set_template_archive_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.templateIDinteger Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[1].ErrorReasonstring ["active_bid_selection","chat_permission_unavailable"] HAYIR
Yanıt örneği 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/customer_survey/set_template_archive",
    "RequestUserAlias": "example-user",
    "Payload": {
        "templateID": 0
    }
}
Makine tarafından okunabilir uç nokta belgeleri