AT AppointmentTrader
登录
当前在线  

/v1/bookmarks/

V2 user bookmarks — list / add / remove / reorder. Bookmarks here are arbitrary destinations the user has chosen to save: a forum thread, a location market page, a user profile, a specific listing. Each row carries its own title + url + description, persisted per-user in `ATUserBookmarks` (added in 000002 migration). V2 newsfeed post URLs also cache `Cache-ATDiscussionPosts_ID` for indexed post bookmark counts. This replaces the earlier sidebar-pin model (set_pin / set_reorder on /v1/sidebar/) where bookmarks were registry-key references — keeping a pinned copy of an item that already lived in the main nav was redundant by design and showed up as duplicate rows in the sidebar. Auth: every endpoint requires an authenticated user ($_APIUserID > 0). The library layer (\AT\ATV2Bookmarks) enforces ownership on every read and write so a stolen/forged bookmark id never lets one user touch another's row.
GET

/v1/bookmarks/get_list

#
Returns the authenticated user's active bookmarks, ordered by their chosen sort (drag-reorderable on the v2 Bookmarks page). Empty array for users with no bookmarks; ErrorInvalidUser for anonymous callers.
请求示例（cURL） 
curl --get \
  'https://cn.appointmenttrader.com/v1/bookmarks/get_list' \
  --data-urlencode 'key={{API_KEY}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$bookmarks_get_list_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].Payloadarray 是的
$.oneOf[0].allOf[1].Payload[]object 否
$.oneOf[0].allOf[1].Payload[].IDDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].ID.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload[].ID.oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload[].Titlestring 是的
$.oneOf[0].allOf[1].Payload[].URLstring 是的
$.oneOf[0].allOf[1].Payload[].Description 是的
$.oneOf[0].allOf[1].Payload[].Description.anyOf[0]string 是的
$.oneOf[0].allOf[1].Payload[].Description.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload[].Cache-ATDiscussionPosts_ID 是的
$.oneOf[0].allOf[1].Payload[].Cache-ATDiscussionPosts_ID.anyOf[0]DatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].Cache-ATDiscussionPosts_ID.anyOf[0].oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload[].Cache-ATDiscussionPosts_ID.anyOf[0].oneOf[1]string 是的
$.oneOf[0].allOf[1].Payload[].Cache-ATDiscussionPosts_ID.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload[].CreatedDatestring 是的
$.oneOf[0].allOf[1].Payload[].SortOrderDatabaseInteger 是的Integer value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload[].SortOrder.oneOf[0]integer 是的
$.oneOf[0].allOf[1].Payload[].SortOrder.oneOf[1]string 是的
$.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/bookmarks/get_list",
    "RequestUserAlias": "example-user",
    "Payload": []
}
机器可读的端点文档
POST

/v1/bookmarks/set_add

#
Add (or refresh) a bookmark for the authenticated user. Idempotent on URL: if the user already has a live bookmark for the supplied url, the existing row is returned (with title / description updated to the new values) instead of creating a duplicate. The url must be either http(s) absolute or root-relative ("/foo/bar"). Anything else (javascript:, data:, mailto:, naked schemes) is rejected with ErrorBadParameters so untrusted page code can't smuggle exotic urls into the user's collection. Canonical v2 newsfeed post URLs populate Cache-ATDiscussionPosts_ID so the feed can count how many users bookmarked a post without parsing URLs. A user's first bookmark for a v2 forum post sends the post author a push-only Priority notification tagged back to that discussion post.

参数

名称类型必填默认值描述
title string 是的 — Display title for the card on the bookmarks page (max 250 chars; truncated).
url string 是的 — Destination url. Absolute http(s) or root-relative path.
description string 否 "" Optional descriptive subtitle. Plain text, no markup.
isWritingRequest bool 否 false Set true to actually persist the bookmark.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/bookmarks/set_add' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'title={{title}}' \
  --data-urlencode 'url={{url}}' \
  --data-urlencode 'description={{description}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$bookmarks_set_add_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.idinteger 是的
$.oneOf[0].allOf[1].Payload.urlstring 是的
$.oneOf[0].allOf[1].Payload.postId 是的
$.oneOf[0].allOf[1].Payload.postId.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.postId.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.bookmarkCount 是的
$.oneOf[0].allOf[1].Payload.bookmarkCount.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.bookmarkCount.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/bookmarks/set_add",
    "RequestUserAlias": "example-user",
    "Payload": {
        "id": 0,
        "url": "synthetic-example",
        "postId": 0,
        "bookmarkCount": 0
    }
}
机器可读的端点文档
POST

/v1/bookmarks/set_remove

#
Remove a bookmark owned by the authenticated user. This is a hard delete. Removing a bookmark that doesn't exist or isn't owned by this user returns Error rather than silently succeeding, so client UI can distinguish "deleted" from "wasn't yours to delete".

参数

名称类型必填默认值描述
bookmarkID int 是的 — The ID returned by set_add or get_list.
isWritingRequest bool 否 false Set true to actually delete.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/bookmarks/set_remove' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'bookmarkID={{bookmarkID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$bookmarks_set_remove_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.idinteger 是的
$.oneOf[0].allOf[1].Payload.urlstring 是的
$.oneOf[0].allOf[1].Payload.postId 是的
$.oneOf[0].allOf[1].Payload.postId.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.postId.anyOf[1]null 是的
$.oneOf[0].allOf[1].Payload.bookmarkCount 是的
$.oneOf[0].allOf[1].Payload.bookmarkCount.anyOf[0]integer 是的
$.oneOf[0].allOf[1].Payload.bookmarkCount.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/bookmarks/set_remove",
    "RequestUserAlias": "example-user",
    "Payload": {
        "id": 0,
        "url": "synthetic-example",
        "postId": 0,
        "bookmarkCount": 0
    }
}
机器可读的端点文档
POST

/v1/bookmarks/set_reorder

#
Replace the user's bookmark sort order with the supplied id list. IDs not currently owned by the user (or already deleted) are silently skipped; any owned bookmarks not present in the list keep their relative order, appended after the supplied ones — defensive in case the client view is stale.

参数

名称类型必填默认值描述
orderedBookmarkIDs string 是的 — Comma-separated bookmark IDs in the desired order.
isWritingRequest bool 否 false Set true to actually persist the order.
请求示例（cURL） 
curl --request POST \
  'https://cn.appointmenttrader.com/v1/bookmarks/set_reorder' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'orderedBookmarkIDs={{orderedBookmarkIDs}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

返回值

JSON
See the shared response schema and synthetic example.
响应字段
字段类型必填描述
$bookmarks_set_reorder_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].Payload = true 是的
$.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/bookmarks/set_reorder",
    "RequestUserAlias": "example-user",
    "Payload": true
}
机器可读的端点文档