### Information and Authentication Links to detailed guides on API information, including market API, rate limits, token configuration, and OAuth2 authentication. ```APIDOC API Information: - Market API: https://lolzteam.readme.io/reference/information#market-api - Telegram chat: https://lolzteam.readme.io/reference/information#telegram-chat - Free API Client packages: https://lolzteam.readme.io/reference/information#free-api-client-packages - Rate limit: https://lolzteam.readme.io/reference/information#rate-limit - Token configuration: https://lolzteam.readme.io/reference/information#token-configuration - Discoverability: https://lolzteam.readme.io/reference/information#discoverability - Status codes: https://lolzteam.readme.io/reference/information#status-codes - Common Parameters: https://lolzteam.readme.io/reference/information#common-parameters - i18n: https://lolzteam.readme.io/reference/information#i18n - Fields filtering: https://lolzteam.readme.io/reference/information#fields-filtering - Resource ordering: https://lolzteam.readme.io/reference/information#resource-ordering - Encryption: https://lolzteam.readme.io/reference/information#encryption - Headers: https://lolzteam.readme.io/reference/information#headers - Content-Type: https://lolzteam.readme.io/reference/information#content-type Authentication: - Oauth2 Guide: https://lolzteam.readme.io/reference/oauth2 ``` -------------------------------- ### Lolzteam API: Information and OAuth2 Provides access to general information about the API and guides for OAuth2 authentication. ```APIDOC GET /information Description: Get general information about the Lolzteam API. GET /oauth2 Description: Provides information and links related to OAuth2 authentication. ``` -------------------------------- ### Conversation Management API Endpoints for managing conversations, including starting, creating, editing, deleting, inviting users, kicking users, and leaving conversations. ```APIDOC DELETE /conversations/{id} Description: Deletes a conversation. POST /conversations/kick Description: Kicks a user from a conversation. Parameters: conversationId: The ID of the conversation. userId: The ID of the user to kick. POST /conversations/invite Description: Invites users to a conversation. Parameters: conversationId: The ID of the conversation. userIds: An array of user IDs to invite. PUT /conversations/{id} Description: Edits an existing conversation. Parameters: id: The ID of the conversation to edit. name: The new name for the conversation. POST /conversations/start Description: Starts a new conversation with a user. Parameters: userId: The ID of the user to start a conversation with. POST /conversations/create Description: Creates a new conversation with multiple users. Parameters: userIds: An array of user IDs to include in the conversation. name: The name of the conversation. GET /conversations/{id} Description: Retrieves details of a specific conversation. GET /conversations Description: Retrieves a list of all conversations for the authenticated user. POST /conversations/search Description: Searches for conversations based on a query. Parameters: query: The search query string. ``` -------------------------------- ### Navigation and Assets Endpoints for retrieving navigation data and CSS assets. ```APIDOC Navigation and Assets: GET /navigation/list Retrieves navigation data. GET /assets/css Retrieves CSS assets. ``` -------------------------------- ### Navigation and Assets API Endpoints for retrieving navigation data and CSS assets. ```APIDOC GET /navigation/list Description: Retrieves navigation data for the website. GET /assets/css Description: Retrieves the main CSS file for the website. ``` -------------------------------- ### API Reference Information This section provides general information about the API, including navigation and search functionality. ```APIDOC Project: /websites/lolzteam_readme_io Content: [Jump to Content](https://lolzteam.readme.io/reference/information#content) [](https://lolzteam.readme.io/reference) [API Reference](https://lolzteam.readme.io/reference) v1.0 * * [Log In](https://lolzteam.readme.io/login?redirect_uri=/reference/information) [](https://lolzteam.readme.io/reference) [Log In](https://lolzteam.readme.io/login?redirect_uri=/reference/information) Moon (Dark Mode)Sun (Light Mode) v1.0[API Reference](https://lolzteam.readme.io/reference)Information Search `CTRL-K` ###### Start typing to search… JUMP TOCTRL-/ ``` -------------------------------- ### User Management API Endpoints for managing user profiles, avatars, backgrounds, followers, and ignored users. ```APIDOC Users: GET /userslist Description: Retrieves a list of users. Response: (Details not provided) GET /usersfields Description: Retrieves user fields. Response: (Details not provided) GET /usersfind Description: Finds users based on certain criteria. Response: (Details not provided) GET /usersget Description: Retrieves a specific user's information. Parameters: - user_id: The ID of the user to retrieve. Response: (Details not provided) PUT /usersedit Description: Edits a user's profile. Request Body: (Details not provided) Response: (Details not provided) GET /usersfollowers Description: Retrieves a user's followers. Parameters: - user_id: The ID of the user. Response: (Details not provided) GET /usersfollowings Description: Retrieves users followed by a specific user. Parameters: - user_id: The ID of the user. Response: (Details not provided) POST /usersfollow Description: Follows a user. Request Body: (Details not provided) Response: (Details not provided) DELETE /usersunfollow Description: Unfollows a user. Request Body: (Details not provided) Response: (Details not provided) GET /usersignored Description: Retrieves a list of ignored users. Response: (Details not provided) POST /usersignore Description: Ignores a user. Request Body: (Details not provided) Response: (Details not provided) DELETE /usersunignore Description: Unignores a user. Request Body: (Details not provided) Response: (Details not provided) GET /userstrophies Description: Retrieves a user's trophies. Parameters: - user_id: The ID of the user. Response: (Details not provided) GET /userssecretanswertypes Description: Retrieves types of secret answers for users. Response: (Details not provided) User Avatar: POST /usersavatarupload Description: Uploads a user's avatar. Request Body: (Details not provided) Response: (Details not provided) POST /usersavatarcrop Description: Crops a user's avatar. Request Body: (Details not provided) Response: (Details not provided) DELETE /usersavatardelete Description: Deletes a user's avatar. Response: (Details not provided) User Background: POST /usersbackgroundupload Description: Uploads a user's background image. Request Body: (Details not provided) Response: (Details not provided) POST /usersbackgroundcrop Description: Crops a user's background image. Request Body: (Details not provided) Response: (Details not provided) DELETE /usersbackgrounddelete Description: Deletes a user's background image. Response: (Details not provided) ``` -------------------------------- ### Lolzteam API: Forum Endpoints Provides access to forum-related operations, including listing all forums, retrieving forum details, and managing forum subscriptions. ```APIDOC GET /forums Description: Get a list of all forums. GET /forums/{id} Description: Get details of a specific forum. GET /forums/grouped Description: Get forums grouped by category or hierarchy. GET /forums/followers Description: Get a list of users following a specific forum. POST /forums/{id}/follow Description: Follow a forum. Request Body: - user_id: The ID of the user to follow. DELETE /forums/{id}/unfollow Description: Unfollow a forum. Request Body: - user_id: The ID of the user to unfollow. GET /forums/followed Description: Get a list of forums followed by the authenticated user. ``` -------------------------------- ### Batch Execution API Endpoint for executing batch operations. ```APIDOC POST /batch/execute Description: Executes a batch of operations. Parameters: operations: An array of operations to execute. ``` -------------------------------- ### User Background API Endpoints for managing user background images, including uploading, cropping, and deleting. ```APIDOC POST /users/{userId}/background/upload - Upload a new background image. POST /users/{userId}/background/crop - Crop the user's background image. DELETE /users/{userId}/background - Delete the user's background image. ``` -------------------------------- ### Forum Management API Provides endpoints for managing forum categories, retrieving forum information, and handling forum subscriptions. ```APIDOC Categories: - Get Category: GET /reference/categoriesget - Get Categories: GET /reference/categorieslist Forums: - Get Followed Forums: GET /reference/forumsfollowed - Unfollow Forum: DELETE /reference/forumsunfollow - Follow Forum: POST /reference/forumsfollow - Get Followers: GET /reference/forumsfollowers - Get Forum: GET /reference/forumsget - Get Forums Tree: GET /reference/forumsgrouped - Get Forums: GET /reference/forumslist ``` -------------------------------- ### API Resource Ordering Allows ordering of resources in API list responses using the 'order' parameter. Supported orders are specified per method, with 'natural' as the default, typically representing the order of resource addition. ```APIDOC APIDOC: resource_ordering: description: "Order resources in API list responses with the 'order' parameter." parameters: - name: order type: string description: "List of supported orders will be specified for each method. Default is 'natural'." default_order: "natural" natural_order_description: "The order of which each resource is added to the system (resource id for example)." ``` -------------------------------- ### Post Management API Endpoints for creating, retrieving, updating, and deleting posts, including liking and unliking functionality. ```APIDOC POST /posts - Create a new post. GET /posts/{id} - Retrieve a specific post. GET /posts - Retrieve a list of posts. PUT /posts/{id} - Edit an existing post. DELETE /posts/{id} - Delete a post. POST /posts/{id}/like - Like a post. DELETE /posts/{id}/like - Unlike a post. ``` -------------------------------- ### Batch Execution Endpoint for executing batch operations. ```APIDOC Batch Execution: POST /batch/execute Executes a batch of operations. ``` -------------------------------- ### API Content Type and Import Details the expected Content-Type for API requests and responses, and provides a link to import the API definition into Postman for easier testing and integration. ```APIDOC Content-Type: - API always returns the response as application/json (With few exceptions). - You should send requests to API with application/json or application/x-www-form-urlencoded content type. Import API into Postman: - [https://raw.githubusercontent.com/AS7RIDENIED/LOLZTEAM/refs/heads/main/Official%20Documentation/forum.json](https://raw.githubusercontent.com/AS7RIDENIED/LOLZTEAM/refs/heads/main/Official%20Documentation/forum.json) ``` -------------------------------- ### Lolzteam API: Profile Post Endpoints Handles posts and comments associated with user profiles, allowing retrieval and management of profile-specific content. ```APIDOC GET /profile/posts Description: Get a list of posts on the authenticated user's profile. GET /profile/posts/{id} Description: Get details of a specific post on a user's profile. POST /profile/posts/create Description: Create a new post on the authenticated user's profile. Request Body: - content: The content of the profile post. PUT /profile/posts/{id}/edit Description: Edit an existing profile post. Request Body: - content: The updated content. DELETE /profile/posts/{id}/delete Description: Delete a profile post. GET /profile/posts/{id}/comments Description: Get comments for a specific profile post. GET /profile/posts/comments Description: Get all comments on the authenticated user's profile posts. GET /profile/posts/comments/{id} Description: Get a specific comment on a profile post. POST /profile/posts/comments/create Description: Create a comment on a profile post. Request Body: - profile_post_id: The ID of the profile post. - content: The content of the comment. PUT /profile/posts/comments/{id}/edit Description: Edit an existing profile post comment. Request Body: - content: The updated content. DELETE /profile/posts/comments/{id}/delete Description: Delete a profile post comment. ``` -------------------------------- ### API Custom Headers Defines custom headers for modifying API behavior. 'Api-Bb-Code-Chr' replaces multimedia tags with specific links, and 'Api-Username-Inline-Style' enables rich username formatting. ```APIDOC APIDOC: headers: - name: Api-Bb-Code-Chr value: "!youtube" description: "Replace multimedia tags (except youtube) in bbcode html with tools/chr link." version_since: "forum-2018100301" - name: Api-Username-Inline-Style description: "Return rich username for username fields." version_since: "forum-2018052101" ``` -------------------------------- ### Search Functionality Endpoints for performing various searches across the platform, including general search, threads, posts, profile posts, and tagged content. ```APIDOC Search Endpoints: POST /search/all Performs a general search. POST /search/threads Searches within threads. POST /search/posts Searches within posts. POST /search/profileposts Searches within user profile posts. POST /search/tagged Searches for tagged content. ``` -------------------------------- ### Profile Posts API Endpoints for creating, editing, deleting, and managing likes for profile posts. ```APIDOC Profile Posts: POST /profilepostscreate Description: Creates a new profile post. Request Body: (Details not provided) Response: (Details not provided) PUT /profilepostsedit Description: Edits an existing profile post. Request Body: (Details not provided) Response: (Details not provided) DELETE /profilepostsdelete Description: Deletes a profile post. Request Body: (Details not provided) Response: (Details not provided) GET /profilepostslikes Description: Retrieves likes for a profile post. Parameters: - post_id: ID of the profile post. Response: (Details not provided) POST /profilepostslike Description: Likes a profile post. Request Body: (Details not provided) Response: (Details not provided) DELETE /profilepostsunlike Description: Unlikes a profile post. Request Body: (Details not provided) Response: (Details not provided) GET /profilepostscontents Description: Retrieves content related to profile posts. Response: (Details not provided) ``` -------------------------------- ### Lolzteam API: Category Endpoints Allows retrieval of forum categories and specific category details. ```APIDOC GET /categories Description: Get a list of all forum categories. GET /categories/{id} Description: Get details of a specific forum category. ``` -------------------------------- ### Lolzteam API: Post Endpoints Manages posts within threads, including creating, editing, deleting, liking, and reporting posts, as well as managing comments on posts. ```APIDOC GET /posts Description: Get a list of posts. GET /posts/{id} Description: Get details of a specific post. POST /posts/create Description: Create a new post within a thread. Request Body: - thread_id: The ID of the thread. - content: The content of the post. PUT /posts/{id}/edit Description: Edit an existing post. Request Body: - content: The updated content. DELETE /posts/{id}/delete Description: Delete a post. GET /posts/{id}/likes Description: Get users who liked a specific post. POST /posts/{id}/like Description: Like a post. Request Body: - user_id: The ID of the user liking the post. DELETE /posts/{id}/unlike Description: Unlike a post. Request Body: - user_id: The ID of the user unliking the post. POST /posts/{id}/report Description: Report a post. Request Body: - reason: The reason for reporting. GET /posts/{id}/comments Description: Get comments for a specific post. POST /posts/comments/create Description: Create a comment on a post. Request Body: - post_id: The ID of the post. - content: The content of the comment. PUT /posts/comments/{id}/edit Description: Edit an existing comment. Request Body: - content: The updated content. DELETE /posts/comments/{id}/delete Description: Delete a comment. ``` -------------------------------- ### Lolzteam API: Thread Endpoints Enables management of threads, including creation, editing, deletion, and various interaction methods like bumping, moving, and following. ```APIDOC GET /threads Description: Get a list of threads. GET /threads/{id} Description: Get details of a specific thread. POST /threads/create Description: Create a new thread. Request Body: - title: The title of the thread. - content: The content of the thread. - forum_id: The ID of the forum where the thread will be created. POST /threads/create/contest Description: Create a new contest thread. Request Body: - title: The title of the contest thread. - content: The content of the contest thread. - forum_id: The ID of the forum. - start_date: The start date of the contest. - end_date: The end date of the contest. POST /threads/create/arbitrage Description: Create a new arbitrage thread. Request Body: - title: The title of the arbitrage thread. - content: The content of the arbitrage thread. - forum_id: The ID of the forum. PUT /threads/{id}/edit Description: Edit an existing thread. Request Body: - title: The updated title. - content: The updated content. DELETE /threads/{id}/delete Description: Delete a thread. POST /threads/{id}/bump Description: Bump a thread to the top. POST /threads/{id}/move Description: Move a thread to a different forum. Request Body: - new_forum_id: The ID of the new forum. GET /threads/{id}/followers Description: Get users following a specific thread. GET /threads/followed Description: Get threads followed by the authenticated user. POST /threads/{id}/follow Description: Follow a thread. Request Body: - user_id: The ID of the user to follow. DELETE /threads/{id}/unfollow Description: Unfollow a thread. Request Body: - user_id: The ID of the user to unfollow. GET /threads/navigation Description: Get navigation elements for threads. GET /threads/{id}/poll Description: Get poll information for a thread. POST /threads/{id}/poll/vote Description: Vote in a thread's poll. Request Body: - poll_option_id: The ID of the poll option to vote for. GET /threads/unread Description: Get unread threads for the authenticated user. GET /threads/recent Description: Get recently active threads. POST /threads/{id}/star Description: Bookmark a thread. Request Body: - user_id: The ID of the user to bookmark for. DELETE /threads/{id}/unstar Description: Remove a thread bookmark. Request Body: - user_id: The ID of the user to remove the bookmark for. POST /threads/{id}/finish Description: Mark a contest thread as finished. ``` -------------------------------- ### User Management API Endpoints for retrieving, finding, and editing user information, as well as managing user relationships like following and ignoring. ```APIDOC GET /users/{id} - Retrieve a specific user. GET /users - Retrieve a list of users. GET /users/find - Find users based on criteria. PUT /users/{id} - Edit user information. POST /users/follow - Follow a user. DELETE /users/follow - Unfollow a user. POST /users/ignore - Ignore a user. DELETE /users/ignore - Unignore a user. GET /users/{id}/followers - Get a user's followers. GET /users/{id}/followings - Get users followed by a user. GET /users/ignored - Get ignored users. GET /users/{id}/secret-answer-types - Get secret answer types for a user. GET /users/{id}/trophies - Get trophies for a user. GET /users/fields - Get available user fields. ``` -------------------------------- ### Profile Post Management API Endpoints for managing posts associated with user profiles, including creating, retrieving, updating, deleting, and liking/unliking. ```APIDOC POST /profile-posts - Create a new post for a profile. GET /profile-posts/{id} - Retrieve a specific profile post. GET /profile-posts - Retrieve a list of profile posts. PUT /profile-posts/{id} - Edit an existing profile post. DELETE /profile-posts/{id} - Delete a profile post. POST /profile-posts/{id}/like - Like a profile post. DELETE /profile-posts/{id}/like - Unlike a profile post. ``` -------------------------------- ### Conversation Management API Endpoints for managing user conversations, including starring, unstarring, reading, and managing alerts. ```APIDOC POST /conversations/{conversationId}/star - Star a conversation. DELETE /conversations/{conversationId}/star - Unstar a conversation. POST /conversations/read - Mark a conversation as read. POST /conversations/read-all - Mark all conversations as read. POST /conversations/{conversationId}/alerts/enable - Enable alerts for a conversation. DELETE /conversations/{conversationId}/alerts - Disable alerts for a conversation. ``` -------------------------------- ### Post Management API Provides an endpoint for reporting posts within the forum system. ```APIDOC Posts: - Report Post: POST /reference/postsreport ``` -------------------------------- ### Search API Endpoints for performing various search operations across the platform, including posts, threads, profiles, and tagged content. ```APIDOC POST /search/tagged Description: Searches for content tagged with specific tags. Parameters: tags: A comma-separated list of tags. query: The search query. POST /search/profile/posts Description: Searches for posts made by a specific user. Parameters: userId: The ID of the user. query: The search query. POST /search/posts Description: Searches for posts based on a query. Parameters: query: The search query. POST /search/threads Description: Searches for threads based on a query. Parameters: query: The search query. POST /search/all Description: Performs a general search across all platform content. Parameters: query: The search query. ``` -------------------------------- ### Forms API Endpoints for managing forms, including creating new forms and retrieving a list of existing forms. ```APIDOC POST /forms/create Description: Creates a new form. Parameters: title: The title of the form. fields: A JSON object defining the form fields. GET /forms/list Description: Retrieves a list of all available forms. ``` -------------------------------- ### Thread Management API Encompasses functionalities for creating, managing, and retrieving threads, including voting on polls within threads and bookmarking. ```APIDOC Threads: - Finish Contest: POST /reference/threadsfinish - Unbookmark Thread: DELETE /reference/threadsunstar - Bookmark Thread: POST /reference/threadsstar - Get Recent Threads: GET /reference/threadsrecent - Get Unread Threads: GET /reference/threadsunread - Vote Poll: POST /reference/threadspollvote - Get Poll: GET /reference/threadspollget - Get Navigation Elements: GET /reference/threadsnavigation - Unfollow Thread: DELETE /reference/threadsunfollow - Follow Thread: POST /reference/threadsfollow - Get Followed Threads: GET /reference/threadsfollowed - Get Thread Followers: GET /reference/threadsfollowers - Move Thread: POST /reference/threadsmove - Bump Thread: POST /reference/threadsbump - Delete Thread: DELETE /reference/threadsdelete - Edit Thread: PUT /reference/threadsedit - Create Arbitrage: POST /reference/threadscreatearbitrage - Create Contest: POST /reference/threadscreatecontest - Create Thread: POST /reference/threadscreate - Get Thread: GET /reference/threadsget - Get Threads: GET /reference/threadslist ``` -------------------------------- ### Notification API Endpoints for retrieving notifications. ```APIDOC Notifications: GET /notificationslist Description: Retrieves a list of notifications. Response: (Details not provided) GET /notificationsget Description: Retrieves a specific notification. Parameters: - notification_id: The ID of the notification. Response: (Details not provided) ``` -------------------------------- ### Conversation Management API Endpoints for managing conversations, messages, and user participation within conversations. ```APIDOC Conversations: GET /conversationslist Description: Retrieves a list of conversations. Response: (Details not provided) GET /conversationsget Description: Retrieves a specific conversation. Parameters: - conversation_id: The ID of the conversation. Response: (Details not provided) POST /conversationscreate Description: Creates a new conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationsstart Description: Starts a new conversation. Request Body: (Details not provided) Response: (Details not provided) PUT /conversationsupdate Description: Updates an existing conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationsinvite Description: Invites users to a conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationskick Description: Kicks a user from a conversation. Request Body: (Details not provided) Response: (Details not provided) DELETE /conversationsdelete Description: Leaves a conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationsread Description: Marks a conversation as read. Request Body: (Details not provided) Response: (Details not provided) POST /conversationsreadall Description: Marks all conversations as read. Response: (Details not provided) POST /conversationsstar Description: Stars a conversation. Request Body: (Details not provided) Response: (Details not provided) DELETE /conversationsunstar Description: Unstars a conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationsalertsenable Description: Enables alerts for a conversation. Request Body: (Details not provided) Response: (Details not provided) DELETE /conversationsalertsdisable Description: Disables alerts for a conversation. Request Body: (Details not provided) Response: (Details not provided) Conversation Messages: GET /conversationsmessageslist Description: Retrieves messages for a conversation. Parameters: - conversation_id: The ID of the conversation. Response: (Details not provided) GET /conversationsmessagesget Description: Retrieves a specific message in a conversation. Parameters: - message_id: The ID of the message. Response: (Details not provided) POST /conversationsmessagescreate Description: Creates a new message in a conversation. Request Body: (Details not provided) Response: (Details not provided) PUT /conversationsmessagesedit Description: Edits an existing message in a conversation. Request Body: (Details not provided) Response: (Details not provided) DELETE /conversationsmessagesdelete Description: Deletes a message from a conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationsmessagesstick Description: Sticks a message in a conversation. Request Body: (Details not provided) Response: (Details not provided) DELETE /conversationsmessagesunstick Description: Unsticks a message in a conversation. Request Body: (Details not provided) Response: (Details not provided) POST /conversationssearch Description: Searches for messages within conversations. Request Body: (Details not provided) Response: (Details not provided) ``` -------------------------------- ### Content Tagging API Endpoints for managing content tags, including retrieving popular tags, tags associated with content, and filtering content by tags. ```APIDOC GET /tags/popular Description: Retrieves a list of popular content tags. GET /tags/{contentId} Description: Retrieves tags associated with a specific piece of content. Parameters: contentId: The ID of the content. GET /tags/find Description: Retrieves content filtered by specified tags. Parameters: tags: A comma-separated list of tags to filter by. ``` -------------------------------- ### Content Tagging API API endpoints for managing and retrieving content tags, including popular tags and tagged content. ```APIDOC Content Tagging: GET /tags/popular Retrieves a list of popular tags. GET /tags/list Retrieves a list of all available tags. GET /tags/{tag_id} Retrieves content associated with a specific tag. GET /tags/find Retrieves content filtered by tags. ``` -------------------------------- ### Chatbox API Endpoints for managing chat messages, conversations, ignored users, and the chat leaderboard. ```APIDOC Chatbox Management: GET /chatbox/messages Retrieves chat messages. POST /chatbox/message Creates a new chat message. PUT /chatbox/message/{message_id} Edits an existing chat message. DELETE /chatbox/message/{message_id} Deletes a chat message. POST /chatbox/report/message/{message_id} Reports a chat message. GET /chatbox/chats Retrieves a list of chats. GET /chatbox/ignore Retrieves a list of ignored users. POST /chatbox/ignore/{user_id} Ignores a chat user. DELETE /chatbox/ignore/{user_id} Unignores a chat user. GET /chatbox/leaderboard Retrieves the chat leaderboard. ``` -------------------------------- ### Forms API Endpoints for managing forms, including retrieving a list of forms and creating new forms. ```APIDOC Forms Management: GET /forms/list Retrieves a list of available forms. POST /forms/create Creates a new form. ``` -------------------------------- ### Chatbox API Endpoints for interacting with the chatbox, including managing ignored users, retrieving chat history, and reporting messages. ```APIDOC GET /chatbox/getleaderboard Description: Retrieves the chat leaderboard. DELETE /chatbox/deleteignore Description: Unignores a chat user. Parameters: userId: The ID of the user to unignore. POST /chatbox/postignore Description: Ignores a chat user. Parameters: userId: The ID of the user to ignore. GET /chatbox/getignore Description: Retrieves a list of ignored chat users. GET /chatbox Description: Retrieves a list of the user's chats. POST /chatbox/reportmessage Description: Reports a chat message. Parameters: messageId: The ID of the message to report. reason: The reason for reporting. DELETE /chatbox/deletemessage Description: Deletes a chat message. Parameters: messageId: The ID of the message to delete. PUT /chatbox/editmessage Description: Edits an existing chat message. Parameters: messageId: The ID of the message to edit. content: The new content of the message. POST /chatbox/postmessage Description: Sends a new message in a chat. Parameters: chatId: The ID of the chat. content: The content of the message. GET /chatbox/getmessages Description: Retrieves messages for a specific chat. Parameters: chatId: The ID of the chat. ``` -------------------------------- ### Notification Management Endpoints for managing user notifications, specifically marking them as read. ```APIDOC Mark Notification Read: POST /notifications/read Marks a notification as read. Parameters: - None explicitly mentioned, likely uses authentication token. Returns: - Success status (e.g., 200 OK) if the notification is marked as read. ``` -------------------------------- ### Information Endpoints Endpoints related to general information about the API, including rate limits, token configuration, discoverability, and status codes. ```APIDOC Information: GET / Retrieves system information and availability. Returns a list of resources. If authenticated, includes API system and module revisions. Rate Limit: 300 requests per minute. A 0.2-second delay between requests is recommended. Exceeding the limit returns a 429 status code. Token Configuration: Tokens can be passed as a query parameter or in request headers. Query Parameter: oauth_token=_token_ Header: Authorization: Bearer _token_ Status Codes: 200 OK: Request successful. 400 Bad Request: Invalid request due to client error. 401 Unauthorized: Authentication required. 403 Forbidden: Insufficient permissions. 429 Too Many Requests: Rate limit exceeded. 500 Internal Server Error: Server-side error. 502 Bad Gateway: Gateway error. 503 Service Unavailable: Server temporarily unavailable. 504 Gateway Timeout: Gateway timed out. ``` -------------------------------- ### User Avatar API Endpoints for managing user avatars, including uploading, cropping, and deleting. ```APIDOC POST /users/{userId}/avatar/upload - Upload a new avatar. POST /users/{userId}/avatar/crop - Crop the user's avatar. DELETE /users/{userId}/avatar - Delete the user's avatar. ``` -------------------------------- ### Post Comments API Endpoints for managing comments on posts, including creating, retrieving, updating, and deleting comments. ```APIDOC POST /posts/{postId}/comments - Create a new comment on a post. GET /posts/{postId}/comments - Retrieve comments for a specific post. PUT /posts/comments/{commentId} - Edit an existing post comment. DELETE /posts/comments/{commentId} - Delete a post comment. ``` -------------------------------- ### Notification API Endpoints for managing user notifications, including marking them as read and retrieving notification lists. ```APIDOC POST /notifications/read Description: Marks a notification as read. Parameters: notificationId: The ID of the notification to mark as read. GET /notifications/{id} Description: Retrieves details of a specific notification. GET /notifications Description: Retrieves a list of all notifications for the authenticated user. ``` -------------------------------- ### API Encryption Methods Provides encryption options for sensitive data, using 'client_secret' as the key for key-supported encryptions. Supports AES 128-bit encryption (ECB mode, PKCS#7 padding). ```APIDOC APIDOC: encryption: description: "Encryption for sensitive information like password." key_source: "client_secret" supported_encryptions: - name: aes128 mode: ECB padding: PKCS7 key_transformation: "Binary md5 hash of key will be used instead of the key itself due to algorithm limitation." ``` -------------------------------- ### Profile Post Comments API Endpoints for managing comments on profile posts, including creating, retrieving, updating, and deleting comments. ```APIDOC POST /profile-posts/{profilePostId}/comments - Create a new comment on a profile post. GET /profile-posts/{profilePostId}/comments - Retrieve comments for a specific profile post. PUT /profile-posts/comments/{commentId} - Edit an existing profile post comment. DELETE /profile-posts/comments/{commentId} - Delete a profile post comment. ``` -------------------------------- ### Message Management API Endpoints for managing messages within conversations, including creating, editing, deleting, sticking, unsticking, and retrieving messages. ```APIDOC DELETE /conversations/messages/{id} Description: Deletes a specific message. POST /conversations/messages/stick Description: Sticks a message to the top of a conversation. Parameters: messageId: The ID of the message to stick. DELETE /conversations/messages/unstick Description: Unsticks a message from a conversation. Parameters: messageId: The ID of the message to unstick. PUT /conversations/messages/{id} Description: Edits an existing message. Parameters: id: The ID of the message to edit. content: The new content of the message. POST /conversations/messages/create Description: Creates a new message in a conversation. Parameters: conversationId: The ID of the conversation. content: The content of the message. GET /conversations/messages/{id} Description: Retrieves details of a specific message. GET /conversations/messages Description: Retrieves a list of messages for a specific conversation. Parameters: conversationId: The ID of the conversation. ``` -------------------------------- ### API Internationalization (i18n) Allows switching user-facing messages to a specified language using the 'locale' parameter. Supports ISO 639-1 language codes with optional ISO 3166-1 alpha 2 country codes. Fallbacks to language code match or default language if no exact match is found. ```APIDOC APIDOC: i18n: description: "All API requests accept **locale** parameter to switch user facing messages to specified language." parameters: - name: locale type: string description: "A valid language code (ISO 639-1) with optional inclusion of a valid country code (ISO 3166-1 alpha 2) separated by a hyphen ("-")." behavior: - "If no complete match can be found, a language with the same language code (even with different country code) will be used." - "In the worst case that there are no installed languages of requested language code, the default language will be used." version_since: "api-2015100401" ``` -------------------------------- ### API Fields Filtering Enables filtering of resource data to include only desired fields using 'fields_include' and 'fields_exclude' parameters. Supports dot notation for nested fields and wildcards for broader inclusion/exclusion. ```APIDOC APIDOC: fields_filtering: description: "Filter resource data to get interested fields only. General format is "key.sub_key.deep_key". Including rules take precedence over excluding ones." parameters: - name: fields_include type: string description: "Comma-separated list of fields of a resource. Can use wildcard (*) to include all default fields before specifying additional ones." - name: fields_exclude type: string description: "Comma-separated list of fields of a resource to exclude. Can use wildcard as a prefix (e.g. "*.key") to exclude the field everywhere." version_since: "r2016062001 (for wildcard prefix in fields_exclude)" ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.