מדריך API של customer_survey

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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.fields`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.fields[].ID`	`DatabaseInteger`	`כן`	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[].CreatedDate`	`string`	`כן`
`$.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[].FieldKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].Label`	`string`	`כן`
`$.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[].FieldGroup`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].FieldType`	`string ["text","number","boolean","single_select","multi_select","longtext"]`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].ValueScope`	`string ["customer","booking"]`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON`	`string (application/json)`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON`	`SurveyValidation (JSON מפוענח)`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].maxLength`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].integer`	`boolean`	`לא`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].min`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[0].max`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.fields[].ValidationJSON.anyOf[1]`	`= []`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].IsActive`	`DatabaseInteger`	`כן`	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[].Options`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].Options[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.fields[].Options[].ID`	`DatabaseInteger`	`כן`	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[].FieldID`	`DatabaseInteger`	`כן`	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[].OptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.fields[].Options[].Label`	`string`	`כן`
`$.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[].SortOrder`	`DatabaseInteger`	`כן`	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.templates`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.templates[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.templates[].ID`	`DatabaseInteger`	`כן`	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[].CreatedDate`	`string`	`כן`
`$.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[].Title`	`string`	`כן`
`$.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[].VersionNumber`	`DatabaseInteger`	`כן`	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].canSend`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].writable`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].chatID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].customerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].bidID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].reasonCode`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].reason`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].otherUserID`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHidden`	`boolean`	`לא`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.context.anyOf[0].buyerIdentityHiddenUntil`	`integer \| 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].alias`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatar`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarEmoji`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageUrl`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImageURL`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileUrl`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileURL`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customColor`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].customTextColor`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].avatarMode`	`string \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].html`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].id`	`integer \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].userID`	`integer \| null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].isRich`	`boolean`	`כן`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].profileImage.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].medals[].URL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHidden`	`boolean`	`לא`	An anonymized author has no profile or follow action.
`$.oneOf[0].allOf[1].Payload.customer.anyOf[0].identityHiddenUntil`	`integer \| null`	`לא`	Current response-race closing timestamp in Unix seconds.
`$.oneOf[0].allOf[1].Payload.customer.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.sales`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.sales[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.sales[].ID`	`DatabaseInteger`	`כן`	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].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.canForget`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].fieldID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].type`	`string ["text","longtext","number","boolean","single_select","multi_select"]`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].value`	`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.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[].options`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].options[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].options[].key`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].options[].label`	`string`	`כן`
`$.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[].requestID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].sourceTitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].revision`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.request`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.request.id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.revision`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.customerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.sellerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.chatID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.bidID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.transactionID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.request.title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.request.status`	`string ["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.url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.request.buyerIdentityHidden`	`boolean`	`לא`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.request.buyerIdentityHiddenUntil`	`integer \| 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.title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.introduction`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ID`	`DatabaseInteger`	`כן`	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[].VersionID`	`DatabaseInteger`	`כן`	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[].QuestionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Label`	`string`	`כן`
`$.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[].HelpText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].FieldType`	`string ["text","number","boolean","single_select","multi_select","longtext"]`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Required`	`DatabaseInteger`	`כן`	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[].SortOrder`	`DatabaseInteger`	`כן`	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[].ValidationJSON`	`string (application/json)`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON`	`SurveyValidation (JSON מפוענח)`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLength`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integer`	`boolean`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].min`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].max`	`number`	`לא`
`$.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[].validation`	`SurveyValidation`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLength`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integer`	`boolean`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].min`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].max`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1]`	`= []`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Options`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Options[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].Options[].ID`	`DatabaseInteger`	`כן`	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[].QuestionID`	`DatabaseInteger`	`כן`	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[].OptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Options[].Label`	`string`	`כן`
`$.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[].SortOrder`	`DatabaseInteger`	`כן`	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.history`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.history[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.history[].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.history[].revision`	`integer`	`כן`
`$.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[].answers`	`object`	`כן`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.draft.anyOf[0].revision`	`integer`	`כן`
`$.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].answers`	`object`	`כן`
`$.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.prefill`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.prefill.*`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.prefill.*.value`	`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.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.*.source`	`string ["saved","booking"]`	`כן`
`$.oneOf[0].allOf[1].Payload.memoryRevisions`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.memoryRevisions.*`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.canAnswer`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canCancel`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.canAttach`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.isCustomer`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.sales`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.sales[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.sales[].ID`	`DatabaseInteger`	`כן`	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].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].revision`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].customerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].sellerID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].chatID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].bidID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].transactionID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].status`	`string ["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[].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHidden`	`boolean`	`לא`	True when the authenticated viewer cannot see the buyer during the current response race.
`$.oneOf[0].allOf[1].Payload.items[].buyerIdentityHiddenUntil`	`integer \| 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.hasMore`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.beforeID`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ID`	`DatabaseInteger`	`כן`	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.CreatedDate`	`string`	`כן`
`$.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.Title`	`string`	`כן`
`$.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.questions`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ID`	`DatabaseInteger`	`כן`	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[].VersionID`	`DatabaseInteger`	`כן`	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[].QuestionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Label`	`string`	`כן`
`$.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[].HelpText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].FieldType`	`string ["text","number","boolean","single_select","multi_select","longtext"]`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Required`	`DatabaseInteger`	`כן`	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[].SortOrder`	`DatabaseInteger`	`כן`	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[].ValidationJSON`	`string (application/json)`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON`	`SurveyValidation (JSON מפוענח)`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].maxLength`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].integer`	`boolean`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].min`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].ValidationJSON.anyOf[0].max`	`number`	`לא`
`$.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[].validation`	`SurveyValidation`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].maxLength`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].integer`	`boolean`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].min`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[0].max`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].validation.anyOf[1]`	`= []`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Options`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Options[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.questions[].Options[].ID`	`DatabaseInteger`	`כן`	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[].QuestionID`	`DatabaseInteger`	`כן`	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[].OptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.questions[].Options[].Label`	`string`	`כן`
`$.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[].SortOrder`	`DatabaseInteger`	`כן`	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].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.requestID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.chatID`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.requestID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.chatID`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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

שדה	סוג	חובה	תיאור
`dataJSON`	`string (application/json)`	`כן`
`dataJSON`	`object (JSON מפוענח)`	`כן`
`dataJSON.requestID`	`integer`	`כן`
`dataJSON.operationKey`	`string`	`כן`
`dataJSON.expectedRevision`	`integer`	`כן`
`dataJSON.answers`	`object`	`כן`
`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.memoryRevisions`	`object`	`כן`
`dataJSON.memoryRevisions.*`	`integer`	`לא`

שדות התגובה

שדה	סוג	חובה
`$`	`customer_survey_set_draft_Response`	`כן`
`$.oneOf[0]`		`כן`
`$.oneOf[0].allOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.requestID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.revision`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.chatID`	`integer`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.fieldID`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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

שדה	סוג	חובה
`dataJSON`	`string (application/json)`	`כן`
`dataJSON`	`object (JSON מפוענח)`	`כן`
`dataJSON.chatID`	`integer`	`כן`
`dataJSON.templateID`	`integer`	`כן`
`dataJSON.versionID`	`integer`	`כן`
`dataJSON.transactionID`	`integer`	`לא`
`dataJSON.operationKey`	`string`	`כן`

שדות התגובה

שדה	סוג	חובה
`$`	`customer_survey_set_send_Response`	`כן`
`$.oneOf[0]`		`כן`
`$.oneOf[0].allOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.requestID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.chatID`	`integer`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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

שדה	סוג	חובה	תיאור
`dataJSON`	`string (application/json)`	`כן`
`dataJSON`	`object (JSON מפוענח)`	`כן`
`dataJSON.requestID`	`integer`	`כן`
`dataJSON.operationKey`	`string`	`כן`
`dataJSON.expectedRevision`	`integer`	`כן`
`dataJSON.answers`	`object`	`כן`
`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.memoryRevisions`	`object`	`כן`
`dataJSON.memoryRevisions.*`	`integer`	`לא`

שדות התגובה

שדה	סוג	חובה
`$`	`customer_survey_set_submit_Response`	`כן`
`$.oneOf[0]`		`כן`
`$.oneOf[0].allOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.requestID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.revision`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.chatID`	`integer`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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

שדה	סוג	חובה	תיאור
`dataJSON`	`string (application/json)`	`כן`
`dataJSON`	`object (JSON מפוענח)`	`כן`
`dataJSON.title`	`string`	`כן`
`dataJSON.introduction`	`string`	`לא`
`dataJSON.templateID`	`integer`	`לא`
`dataJSON.sourceTemplateID`	`integer`	`לא`
`dataJSON.expectedVersionID`	`integer`	`לא`
`dataJSON.questions`	`array`	`כן`
`dataJSON.questions[]`		`לא`
`dataJSON.questions[].anyOf[0]`	`object`	`לא`
`dataJSON.questions[].anyOf[0].fieldID`	`integer`	`כן`
`dataJSON.questions[].anyOf[0].label`	`string`	`לא`
`dataJSON.questions[].anyOf[0].type`	`string ["text","longtext","number","boolean","single_select","multi_select"]`	`לא`
`dataJSON.questions[].anyOf[0].help`	`string`	`לא`
`dataJSON.questions[].anyOf[0].required`	`boolean`	`לא`
`dataJSON.questions[].anyOf[0].remember`	`boolean`	`לא`
`dataJSON.questions[].anyOf[0].integer`	`boolean`	`לא`
`dataJSON.questions[].anyOf[0].min`	`DatabaseNumber`	`לא`	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].max`	`DatabaseNumber`	`לא`	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].options`	`array`	`לא`
`dataJSON.questions[].anyOf[0].options[]`	`object`	`לא`
`dataJSON.questions[].anyOf[0].options[].key`	`string`	`לא`
`dataJSON.questions[].anyOf[0].options[].label`	`string`	`כן`
`dataJSON.questions[].anyOf[1]`	`object`	`לא`
`dataJSON.questions[].anyOf[1].fieldID`	`integer`	`לא`
`dataJSON.questions[].anyOf[1].label`	`string`	`כן`
`dataJSON.questions[].anyOf[1].type`	`string ["text","longtext","number","boolean","single_select","multi_select"]`	`כן`
`dataJSON.questions[].anyOf[1].help`	`string`	`לא`
`dataJSON.questions[].anyOf[1].required`	`boolean`	`לא`
`dataJSON.questions[].anyOf[1].remember`	`boolean`	`לא`
`dataJSON.questions[].anyOf[1].integer`	`boolean`	`לא`
`dataJSON.questions[].anyOf[1].min`	`DatabaseNumber`	`לא`	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].max`	`DatabaseNumber`	`לא`	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].options`	`array`	`לא`
`dataJSON.questions[].anyOf[1].options[]`	`object`	`לא`
`dataJSON.questions[].anyOf[1].options[].key`	`string`	`לא`
`dataJSON.questions[].anyOf[1].options[].label`	`string`	`כן`

שדות התגובה

שדה	סוג	חובה
`$`	`customer_survey_set_template_Response`	`כן`
`$.oneOf[0]`		`כן`
`$.oneOf[0].allOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.templateID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.versionID`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.templateID`	`integer`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[1].ErrorReason`	`string ["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
    }
}

תיעוד נקודת קצה קריא למכונה