AT AppointmentTrader
تسجيل الدخول
متصلون الآن  

/v1/sidebar/

V2 sidebar — runtime read/render endpoints. The sidebar markup is owned by `\AT\ATV2Sidebar` (declarative registry at /config/atv2-sidebar.php → /libraries/atv2-sidebar.lib.php) and rendered server-side once per page load. After the initial render the client may mutate sidebar-relevant state (pin/unpin, expand/collapse a submenu, change the plans sort/group). These endpoints are how the client gets a fresh, server-canonical render after such a mutation — so layout never drifts between client and server, and the client never re-implements the markup. The complementary mutation endpoints are set_expanded (submenu collapse state) and set_plans_view (plans-block sort). Per-user bookmarks moved to /v1/bookmarks/* — they're no longer references to sidebar registry items but full {title, url, description} rows owned by the user. Auth: all endpoints accept anonymous callers and degrade gracefully (no plans block). The viewer's user id is taken from the apiv1 dispatcher's session resolution — no explicit auth params.
GET

/v1/sidebar/get_plans_render

#
Returns only the server-rendered "My Bookings" block plus the matching plans state. Used by the v2 shell to defer the expensive city-grouped travel-plans fetch until after the initial page render. Auth: plans are personal; anonymous callers receive ErrorUnauthorized.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
activeNavKey string لا "" Current page's active sidebar key.
theme string لا "upscale_at" Theme name; controls per-theme markup helper. Defaults to "upscale_at".
مثال طلب (cURL) 
curl --get \
  'https://ar.appointmenttrader.com/v1/sidebar/get_plans_render' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$sidebar_get_plans_render_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.htmlstring نعم
$.oneOf[0].allOf[1].Payload.stateobject نعم
$.oneOf[0].allOf[1].Payload.state.activeKeystring نعم
$.oneOf[0].allOf[1].Payload.state.plans نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/sidebar/get_plans_render",
    "RequestUserAlias": "example-user",
    "Payload": {
        "html": "synthetic-example",
        "state": {
            "activeKey": "synthetic-example",
            "plans": {
                "sortBy": "upcoming",
                "groupBy": "city",
                "groups": [],
                "hasArchivedPlans": false
            }
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/sidebar/get_render

#
Returns server-canonical rendered HTML for the v2 sidebar plus the matching state struct. The client's contract is to replace the inner HTML of the sidebar aside element with Payload.html and update window.ATV2ShellState.sidebar with Payload.state — there is no client-side render, ever. Use this after any mutation that affects the sidebar's structure or data (pin/unpin, plans sort/group toggle, app added/removed). For pure active-state changes triggered by inline navigation, prefer window.ATV2Sidebar.applyActiveKey() instead — it's a DOM toggle and doesn't need a roundtrip.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
activeNavKey string لا "" Current page's active sidebar key.
theme string لا "upscale_at" Theme name; controls per-theme markup helper. Defaults to "upscale_at".
مثال طلب (cURL) 
curl --get \
  'https://ar.appointmenttrader.com/v1/sidebar/get_render' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$sidebar_get_render_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.htmlstring نعم
$.oneOf[0].allOf[1].Payload.stateobject نعم
$.oneOf[0].allOf[1].Payload.state.activeKeystring نعم
$.oneOf[0].allOf[1].Payload.state.expanded نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean لا
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array نعم
$.oneOf[0].allOf[1].Payload.state.itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring لاLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null لا
$.oneOf[0].allOf[1].Payload.state.plans نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.state.appMenu = null نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/sidebar/get_render",
    "RequestUserAlias": "example-user",
    "Payload": {
        "html": "<aside>Example navigation</aside>",
        "state": {
            "activeKey": "synthetic-example",
            "expanded": [],
            "items": [],
            "plans": {
                "sortBy": "upcoming",
                "groupBy": "city",
                "groups": [],
                "hasArchivedPlans": false
            },
            "appMenu": null,
            "mobileHeader": {
                "primary": "search",
                "cta": "post"
            },
            "communitiesSortBy": "latest_post",
            "personalNavigation": {
                "CompleteScopes": [],
                "payload": []
            }
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/sidebar/get_state

#
Returns the current state of the v2 sidebar — the same struct that is embedded in window.ATV2ShellState.sidebar at SSR time. Use this when the client needs to re-derive its in-memory model without re-parsing the rendered HTML. Pass the page's currently-active sidebar key as activeNavKey so the server can mark the right item active in the response. The expanded / collapsed submenu set is read server-side from the `atv2_sidebar_expanded` cookie — pass nothing for that.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
activeNavKey string لا "" Current page's active sidebar key (e.g. "network", "market-data", "transactions"). Empty string when the page does not declare one.
مثال طلب (cURL) 
curl --get \
  'https://ar.appointmenttrader.com/v1/sidebar/get_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$sidebar_get_state_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.activeKeystring نعم
$.oneOf[0].allOf[1].Payload.expanded نعم
$.oneOf[0].allOf[1].Payload.expanded.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.expanded.anyOf[0].*boolean لا
$.oneOf[0].allOf[1].Payload.expanded.anyOf[1]array نعم
$.oneOf[0].allOf[1].Payload.itemsarray نعم
$.oneOf[0].allOf[1].Payload.items[]object لا
$.oneOf[0].allOf[1].Payload.items[].keystring نعم
$.oneOf[0].allOf[1].Payload.items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.items[].iconstring لا
$.oneOf[0].allOf[1].Payload.items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.items[].rolestring لا
$.oneOf[0].allOf[1].Payload.items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.items[].badge.value لا
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.items[].todoboolean لا
$.oneOf[0].allOf[1].Payload.items[].hide_when_rightbar_visibleboolean لا
$.oneOf[0].allOf[1].Payload.items[].mobile_headerobject لا
$.oneOf[0].allOf[1].Payload.items[].mobile_header.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.items[].mobile_header.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.items[].sort = "communities" لا
$.oneOf[0].allOf[1].Payload.items[].submenu لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0]object لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].itemsarray نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[]object لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].keystring نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].iconstring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].rolestring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].conditionstring لاLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].persist_when_emptyboolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].wrapper_attrsobject لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].wrapper_attrs.*string لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].default_expandedboolean لا
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[1]null لا
$.oneOf[0].allOf[1].Payload.plans نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].sortBystring ["upcoming","name"] نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groupBy = "city" نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groupsarray نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[]object لا
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].cityCodestring نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].emojistring نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingCountinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastCountinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingBidsinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastBidsinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].bubblesobject لا
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].bubbles.*integer لا
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].hasArchivedPlansboolean نعم
$.oneOf[0].allOf[1].Payload.plans.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.appMenu = null نعم
$.oneOf[0].allOf[1].Payload.mobileHeaderobject نعم
$.oneOf[0].allOf[1].Payload.mobileHeader.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.mobileHeader.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.communitiesSortBystring ["latest_post","name"] نعم
$.oneOf[0].allOf[1].Payload.personalNavigationobject نعم
$.oneOf[0].allOf[1].Payload.personalNavigation.MembershipFingerprintstring لا
$.oneOf[0].allOf[1].Payload.personalNavigation.CompleteScopesarray نعم
$.oneOf[0].allOf[1].Payload.personalNavigation.CompleteScopes[]string ["status","activity"] لا
$.oneOf[0].allOf[1].Payload.personalNavigation.CommunityOrderFingerprintstring لا
$.oneOf[0].allOf[1].Payload.personalNavigation.payloadPersonalNavigationBubbles نعم
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].* لا
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[0]integer لا
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[1] = false لا
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[2]object لا
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring نعم
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[1]array نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/sidebar/get_state",
    "RequestUserAlias": "example-user",
    "Payload": {
        "activeKey": "synthetic-example",
        "expanded": [],
        "items": [],
        "plans": {
            "sortBy": "upcoming",
            "groupBy": "city",
            "groups": [],
            "hasArchivedPlans": false
        },
        "appMenu": null,
        "mobileHeader": {
            "primary": "search",
            "cta": "post"
        },
        "communitiesSortBy": "latest_post",
        "personalNavigation": {
            "CompleteScopes": [],
            "payload": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
POST

/v1/sidebar/set_communities_view

#
Persist the personal community list sort without changing My Bookings. Authenticated users only; writes the sidebar preference cookie.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
sortBy string نعم — "latest_post" (default) or "name".
activeNavKey string لا "" Current sidebar key.
theme string لا "upscale_at" Sidebar theme.
isWritingRequest bool لا false Set true to save the preference.
مثال طلب (cURL) 
curl --request POST \
  'https://ar.appointmenttrader.com/v1/sidebar/set_communities_view' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sortBy={{sortBy}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$sidebar_set_communities_view_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.htmlstring نعم
$.oneOf[0].allOf[1].Payload.stateobject نعم
$.oneOf[0].allOf[1].Payload.state.activeKeystring نعم
$.oneOf[0].allOf[1].Payload.state.expanded نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean لا
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array نعم
$.oneOf[0].allOf[1].Payload.state.itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring لاLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null لا
$.oneOf[0].allOf[1].Payload.state.plans نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.state.appMenu = null نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/sidebar/set_communities_view",
    "RequestUserAlias": "example-user",
    "Payload": {
        "html": "<aside>Example navigation</aside>",
        "state": {
            "activeKey": "synthetic-example",
            "expanded": [],
            "items": [],
            "plans": {
                "sortBy": "upcoming",
                "groupBy": "city",
                "groups": [],
                "hasArchivedPlans": false
            },
            "appMenu": null,
            "mobileHeader": {
                "primary": "search",
                "cta": "post"
            },
            "communitiesSortBy": "latest_post",
            "personalNavigation": {
                "CompleteScopes": [],
                "payload": []
            }
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
POST

/v1/sidebar/set_expanded

#
Toggle the expand/collapse state of a top-level submenu and persist the choice to the user's `atv2_sidebar_expanded` cookie. Returns the post-mutation {html, state} so the client can swap the rendered nav block. The cookie is the source of truth for SSR re-renders. The shared browser runtime writes this same cookie directly; this endpoint remains available for API clients that need the cookie and rendered response together.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
itemKey string نعم — Submenu key (must match a sidebar item's key). Named `itemKey` rather than `key` to avoid colliding with the apiv1 dispatcher's reserved `key=` auth parameter.
expanded bool نعم — True to expand, false to collapse.
activeNavKey string لا "" Current page's active sidebar key.
theme string لا "upscale_at" Theme name; defaults to "upscale_at".
isWritingRequest bool لا false Set true to actually write the cookie.
مثال طلب (cURL) 
curl --request POST \
  'https://ar.appointmenttrader.com/v1/sidebar/set_expanded' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'itemKey={{itemKey}}' \
  --data-urlencode 'expanded={{expanded}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$sidebar_set_expanded_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.htmlstring نعم
$.oneOf[0].allOf[1].Payload.stateobject نعم
$.oneOf[0].allOf[1].Payload.state.activeKeystring نعم
$.oneOf[0].allOf[1].Payload.state.expanded نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean لا
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array نعم
$.oneOf[0].allOf[1].Payload.state.itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring لاLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null لا
$.oneOf[0].allOf[1].Payload.state.plans نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.state.appMenu = null نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/sidebar/set_expanded",
    "RequestUserAlias": "example-user",
    "Payload": {
        "html": "<aside>Example navigation</aside>",
        "state": {
            "activeKey": "synthetic-example",
            "expanded": [],
            "items": [],
            "plans": {
                "sortBy": "upcoming",
                "groupBy": "city",
                "groups": [],
                "hasArchivedPlans": false
            },
            "appMenu": null,
            "mobileHeader": {
                "primary": "search",
                "cta": "post"
            },
            "communitiesSortBy": "latest_post",
            "personalNavigation": {
                "CompleteScopes": [],
                "payload": []
            }
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
POST

/v1/sidebar/set_plans_view

#
Persist the user's preferred sort mode for the v2 sidebar's "Your Plans" block (city-grouped appointments). The choice is written to the `atv2_sidebar_plans_view` cookie so subsequent SSR renders pick it up; the response carries the freshly-rendered {html, state} so the client can swap the rendered nav + plans without a follow-up.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
sortBy string نعم — Sort mode: "upcoming" (most upcoming first; default) or "name" (alphabetical city name).
activeNavKey string لا "" Current page's active sidebar key.
theme string لا "upscale_at" Theme name; defaults to "upscale_at".
isWritingRequest bool لا false Set true to actually write the cookie.
مثال طلب (cURL) 
curl --request POST \
  'https://ar.appointmenttrader.com/v1/sidebar/set_plans_view' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sortBy={{sortBy}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$sidebar_set_plans_view_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.htmlstring نعم
$.oneOf[0].allOf[1].Payload.stateobject نعم
$.oneOf[0].allOf[1].Payload.state.activeKeystring نعم
$.oneOf[0].allOf[1].Payload.state.expanded نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean لا
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array نعم
$.oneOf[0].allOf[1].Payload.state.itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject لا
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring لاLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean لا
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null لا
$.oneOf[0].allOf[1].Payload.state.plans نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer لا
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean نعم
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.state.appMenu = null نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] نعم
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] نعم
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object لا
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring نعم
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/sidebar/set_plans_view",
    "RequestUserAlias": "example-user",
    "Payload": {
        "html": "<aside>Example navigation</aside>",
        "state": {
            "activeKey": "synthetic-example",
            "expanded": [],
            "items": [],
            "plans": {
                "sortBy": "upcoming",
                "groupBy": "city",
                "groups": [],
                "hasArchivedPlans": false
            },
            "appMenu": null,
            "mobileHeader": {
                "primary": "search",
                "cta": "post"
            },
            "communitiesSortBy": "latest_post",
            "personalNavigation": {
                "CompleteScopes": [],
                "payload": []
            }
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا