AT AppointmentTrader
Anmelden
Jetzt online  

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

Parameter

NameTypErforderlichStandardBeschreibung
activeNavKey string Nein "" Current page's active sidebar key.
theme string Nein "upscale_at" Theme name; controls per-theme markup helper. Defaults to "upscale_at".
Anfragebeispiel (cURL) 
curl --get \
  'https://de.appointmenttrader.com/v1/sidebar/get_plans_render' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$sidebar_get_plans_render_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.htmlstring Ja
$.oneOf[0].allOf[1].Payload.stateobject Ja
$.oneOf[0].allOf[1].Payload.state.activeKeystring Ja
$.oneOf[0].allOf[1].Payload.state.plans Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel 
{
    "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
            }
        }
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
activeNavKey string Nein "" Current page's active sidebar key.
theme string Nein "upscale_at" Theme name; controls per-theme markup helper. Defaults to "upscale_at".
Anfragebeispiel (cURL) 
curl --get \
  'https://de.appointmenttrader.com/v1/sidebar/get_render' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}' \
  --data-urlencode 'theme={{theme}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$sidebar_get_render_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.htmlstring Ja
$.oneOf[0].allOf[1].Payload.stateobject Ja
$.oneOf[0].allOf[1].Payload.state.activeKeystring Ja
$.oneOf[0].allOf[1].Payload.state.expanded Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean Nein
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.state.itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring NeinLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null Nein
$.oneOf[0].allOf[1].Payload.state.plans Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.state.appMenu = null Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel 
{
    "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": []
            }
        }
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
activeNavKey string Nein "" Current page's active sidebar key (e.g. "network", "market-data", "transactions"). Empty string when the page does not declare one.
Anfragebeispiel (cURL) 
curl --get \
  'https://de.appointmenttrader.com/v1/sidebar/get_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'activeNavKey={{activeNavKey}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$sidebar_get_state_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.activeKeystring Ja
$.oneOf[0].allOf[1].Payload.expanded Ja
$.oneOf[0].allOf[1].Payload.expanded.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.expanded.anyOf[0].*boolean Nein
$.oneOf[0].allOf[1].Payload.expanded.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.itemsarray Ja
$.oneOf[0].allOf[1].Payload.items[]object Nein
$.oneOf[0].allOf[1].Payload.items[].keystring Ja
$.oneOf[0].allOf[1].Payload.items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.items[].todoboolean Nein
$.oneOf[0].allOf[1].Payload.items[].hide_when_rightbar_visibleboolean Nein
$.oneOf[0].allOf[1].Payload.items[].mobile_headerobject Nein
$.oneOf[0].allOf[1].Payload.items[].mobile_header.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.items[].mobile_header.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.items[].sort = "communities" Nein
$.oneOf[0].allOf[1].Payload.items[].submenu Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0]object Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].itemsarray Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[]object Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].keystring Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].items[].conditionstring NeinLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].persist_when_emptyboolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].wrapper_attrsobject Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].wrapper_attrs.*string Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[0].default_expandedboolean Nein
$.oneOf[0].allOf[1].Payload.items[].submenu.anyOf[1]null Nein
$.oneOf[0].allOf[1].Payload.plans Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].sortBystring ["upcoming","name"] Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groupBy = "city" Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groupsarray Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[]object Nein
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].cityCodestring Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].emojistring Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingCountinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastCountinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingBidsinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastBidsinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].upcomingSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].groups[].pastSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].bubblesobject Nein
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].bubbles.*integer Nein
$.oneOf[0].allOf[1].Payload.plans.anyOf[0].hasArchivedPlansboolean Ja
$.oneOf[0].allOf[1].Payload.plans.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.appMenu = null Ja
$.oneOf[0].allOf[1].Payload.mobileHeaderobject Ja
$.oneOf[0].allOf[1].Payload.mobileHeader.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.mobileHeader.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.communitiesSortBystring ["latest_post","name"] Ja
$.oneOf[0].allOf[1].Payload.personalNavigationobject Ja
$.oneOf[0].allOf[1].Payload.personalNavigation.MembershipFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.CompleteScopesarray Ja
$.oneOf[0].allOf[1].Payload.personalNavigation.CompleteScopes[]string ["status","activity"] Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.CommunityOrderFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.payloadPersonalNavigationBubbles Ja
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].* Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[0]integer Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[1] = false Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[2]object Nein
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring Ja
$.oneOf[0].allOf[1].Payload.personalNavigation.payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel 
{
    "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": []
        }
    }
}
Maschinenlesbare Endpunktdokumentation
POST

/v1/sidebar/set_communities_view

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

Parameter

NameTypErforderlichStandardBeschreibung
sortBy string Ja — "latest_post" (default) or "name".
activeNavKey string Nein "" Current sidebar key.
theme string Nein "upscale_at" Sidebar theme.
isWritingRequest bool Nein false Set true to save the preference.
Anfragebeispiel (cURL) 
curl --request POST \
  'https://de.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}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$sidebar_set_communities_view_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.htmlstring Ja
$.oneOf[0].allOf[1].Payload.stateobject Ja
$.oneOf[0].allOf[1].Payload.state.activeKeystring Ja
$.oneOf[0].allOf[1].Payload.state.expanded Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean Nein
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.state.itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring NeinLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null Nein
$.oneOf[0].allOf[1].Payload.state.plans Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.state.appMenu = null Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel 
{
    "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": []
            }
        }
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
itemKey string Ja — 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 Ja — True to expand, false to collapse.
activeNavKey string Nein "" Current page's active sidebar key.
theme string Nein "upscale_at" Theme name; defaults to "upscale_at".
isWritingRequest bool Nein false Set true to actually write the cookie.
Anfragebeispiel (cURL) 
curl --request POST \
  'https://de.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}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$sidebar_set_expanded_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.htmlstring Ja
$.oneOf[0].allOf[1].Payload.stateobject Ja
$.oneOf[0].allOf[1].Payload.state.activeKeystring Ja
$.oneOf[0].allOf[1].Payload.state.expanded Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean Nein
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.state.itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring NeinLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null Nein
$.oneOf[0].allOf[1].Payload.state.plans Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.state.appMenu = null Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel 
{
    "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": []
            }
        }
    }
}
Maschinenlesbare Endpunktdokumentation
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.

Parameter

NameTypErforderlichStandardBeschreibung
sortBy string Ja — Sort mode: "upcoming" (most upcoming first; default) or "name" (alphabetical city name).
activeNavKey string Nein "" Current page's active sidebar key.
theme string Nein "upscale_at" Theme name; defaults to "upscale_at".
isWritingRequest bool Nein false Set true to actually write the cookie.
Anfragebeispiel (cURL) 
curl --request POST \
  'https://de.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}}'

Rückgabe

JSON
See the shared response schema and synthetic example.
Antwortfelder
FeldTypErforderlichBeschreibung
$sidebar_set_plans_view_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nein
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.htmlstring Ja
$.oneOf[0].allOf[1].Payload.stateobject Ja
$.oneOf[0].allOf[1].Payload.state.activeKeystring Ja
$.oneOf[0].allOf[1].Payload.state.expanded Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[0].*boolean Nein
$.oneOf[0].allOf[1].Payload.state.expanded.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.state.itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].todoboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].hide_when_rightbar_visibleboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_headerobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].mobile_header.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].sort = "communities" Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].itemsarray Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].keystring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].label_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].iconstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].hrefstring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].rolestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badgeobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.typestring ["count","money","icon","dot","status"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.bubble_keystring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[0]string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[1]number Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[2]boolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3]object Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.value.anyOf[3].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.tonestring Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].status_badge.guidanceboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].activeboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].bookmark_post_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].unfollow_board_idinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].is_pinnedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].pin_sort_orderinteger Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].items[].conditionstring NeinLegacy static submenu visibility callback identifier, retained as inert text by ToClientState.
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].persist_when_emptyboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrsobject Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].wrapper_attrs.*string Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[0].default_expandedboolean Nein
$.oneOf[0].allOf[1].Payload.state.items[].submenu.anyOf[1]null Nein
$.oneOf[0].allOf[1].Payload.state.plans Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].sortBystring ["upcoming","name"] Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupBy = "city" Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groupsarray Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[]object Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityCodestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].emojistring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastCountinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastAppointmentsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastBidsinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].upcomingSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].groups[].pastSoldSalesinteger Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubblesobject Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].bubbles.*integer Nein
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[0].hasArchivedPlansboolean Ja
$.oneOf[0].allOf[1].Payload.state.plans.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.state.appMenu = null Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeaderobject Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.primarystring ["search","ticker","title","brand"] Ja
$.oneOf[0].allOf[1].Payload.state.mobileHeader.ctastring ["post","search-icon","none"] Ja
$.oneOf[0].allOf[1].Payload.state.communitiesSortBystring ["latest_post","name"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigationobject Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.MembershipFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopesarray Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CompleteScopes[]string ["status","activity"] Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.CommunityOrderFingerprintstring Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payloadPersonalNavigationBubbles Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].* Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[0]integer Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[1] = false Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2]object Nein
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].codestring ["pending","answer-required"] Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[0].*.anyOf[2].labelstring Ja
$.oneOf[0].allOf[1].Payload.state.personalNavigation.payload.anyOf[1]array Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nein
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nein
$.oneOf[1].RequestImpersonatedByUserAliasstring Nein
Antwortbeispiel 
{
    "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": []
            }
        }
    }
}
Maschinenlesbare Endpunktdokumentation