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://jp.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://jp.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://jp.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://jp.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://jp.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://jp.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": []
            }
        }
    }
}
機械可読のエンドポイントドキュメント