CIX Developer Documentation

API Changes


Changes in the CIX API

The CIX API changed significantly between the V2 and V3 versions. The table below lists the V2 API methods and their V3 corresponding methods, plus notes to guide how to use the V3 methods to achieve the same functionality. Note that not all V2 methods are supported in V3. Some methods have been intentionally retired due to technical changes or because they were no longer considered useful.

V2 API Method V3 API Method Notes
Forum.Details.get /Forum/{name}/details Accepts a flag which specifies whether to return basic or full details
Forum.Moderators.get /Forum/{name}/details Specify the full details to have the list of moderators returned in the forum details
Forum.Participants.get /Forum/{name}/details Specify the full details to have the list of participants returned in the forum details
Forum.Topics.get /Forum/{name}/details Specify the full details to have the list of topics returned in the forum details
Forum.TopicThreads.get /Conversation/{topicId}/get Returns conversations in a topic since the last client commit
Forum.TopicThread.get /Conversation/{conversationId}/messages Returns all messages in the specified conversation since the last client commit
Forum.Message.get /Message/{messageId}/get Returns a specific message
Forum.MessageRange.post /Message/newrange Post a range of new messages with optional attachments
Forum.MessageRoot.get /Message/{messageId}/get Retrieve the RootNumber from the details for the given message
Forum.Message.post /Message/new Post a new message with optional attachments
Forum.Message2.post /Message/new Post a new message with optional attachments
Forum.MessageCopy.post /Message/new Retrieve a copy of the existing message then post it again to the same topic
Forum.Withdraw.get /Message/withdraw Withdraw a message based on its message ID
Forum.PriorityToggle.get None Not supported
Forum.MarkReadForum.get /Forum/{forum}/read Specify the unique forum name
Forum.MarkReadTopic.get /Topic/{topicId}/read Specify the unique topic ID
Forum.MarkReadThread.get /Conversation/{conversationId}/read Mark a conversation read or unread
Forum.MarkReadRange.post None Not yet supported
Forum.MarkReadMessage.get /Message/{messageId}/read/{state} Specify a flag to indicate whether to mark a message read or unread
Forum.Join.get /Forum/{forum}/join Just specify the forum name to join that forum
Forum.JoinTopic.get /Forum/{forum}/join?topic={topic} Specify the forum and topic name to join that forum and topic
Forum.Resign.get /Forum/{forum}/resign Just specify the forum name to resign that forum
Forum.ResignTopic.get /Forum/{forum}/resign?topic={topic} Specify the forum and topic name to resign that forum and topic
Forum.Search.post /Forum/{forum}/messages Use a filter to search the forum

V2 API Method V3 API Method Notes
Mod.ParticipantAdd.get /Moderator/{forum}/{username}/partadd Add a participant to the specified forum
Mod.ParticipantRemove.get /Moderator/{forum}/{username}/partrem Remove a participant from the specified forum
Mod.ModeratorAdd.get /Moderator/{forum}/{username}/modadd Make a user a moderator of the specified forum
Mod.ModeratorRemove.get /Moderator/{forum}/{username}/modrem Remove a user as moderator of the specified forum

V2 API Method V3 API Method Notes
Directory.Categories.get /CIX/directory Obtain the directory and retrieve the categories from there
Directory.Forums.get /CIX/directory Obtain the directory
Directory.CategoryForums.get /CIX/directory Obtain the directory sorted by category and retrieve the forums from there
Directory.Search.post /CIX/directory Using filtering to limit the directory by specific keywords

V2 API Method V3 API Method Notes
Starred.get /User/messages Use the starred=true filter to obtain all starred messages
Starred.Add.post /Message/{messageId}/star/{state} Set state to true to star the specified message
Starred.Remove.get /Message/{messageId}/star/{state} Set state to false to remove a star from the specified message

V2 API Method V3 API Method Notes
User.Account.get None Not yet supported
User.AllTopics.get /User/subscriptions Retrieve the user's full subscription list
User.AllUnread.get /User/messages Use the read=false filter to obtain all unread messages
User.AllUnreadSync.get None Not supported
User.Forums.get /User/subscriptions Retrieve the user's subscription list
User.ForumTopics.get /User/subscriptions Topic status (live or archived) is not supported
User.Mugshot.get /User/picture/{username} Retrieve the picture specifying the user's own username
User.NextPriority.post None Not supported
User.NextUnread.post None Not supported
User.Notifications.get /User/profile Notification settings can now be retrieved as part of the user's profile
User.Notifications.set /User/profile Notification settings can now be changed as part of the user's profile
User.Profile.get /User/profile Retrieve the user's profile
User.RecentPosts.get None Not supported
User.Resume.get /User/profile The users resume can now be retrieved as part of the user's profile
User.ScratchPad.get None Not supported
User.SetMugshot.post /User/picture Change the user's own picture
User.SetPointersBack.get None Not supported
User.SetProfile.post /User/profile Update the user's own profile
User.SetResume.post /User/profile Update the resume as part of updating the user's own profile,
User.Sync.get None Not yet supported
User.UserProfile.get /User/profile/{username} Retrieve the specified user's profile
User.Who.get None Not yet supported

Personal Messages Methods

Personal Messages are not yet supported.


Alerts Methods

Alerts are not supported in V3.


Tags Methods

Tags are not supported in V3.