http://help.cixonline.co.uk/ 2010-09-08T14:58:50+01:00 http://help.cixonline.co.uk/ http://help.cixonline.co.uk/lib/images/favicon.ico text/html 2008-10-17T15:36:57+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.add.post?rev=1224254217&do=diff Description Adds a new alert for the user, a populated Alert most be sent with the post request. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/alerts/add>(.xml/.json) Parameters Required Name Type Description required alert object Alert A populated Alert object Example Request <http://api.cixonline.com/v1.0/cix.svc/alerts/add.xml> text/html 2008-07-21T11:59:07+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.del?rev=1216637947&do=diff Description Remove a message from the alerts list. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/alerts/>{msgid}/del(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string … text/html 2008-10-17T15:26:06+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.get?rev=1224253566&do=diff Description Get a list of messages a user has an alert for. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/alerts>(.xml/.json) Parameters Required Name Type Description Example Return XML <AlertSet xmlns="http://schemas.datacontract.org/2004/07/CIX.API.Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Alerts> <Alert> <Active>false</Active> <Conf>home_cinema</Conf> <Date>2008-07-15T14:25:53.1… text/html 2008-07-21T11:57:20+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.post?rev=1216637840&do=diff Description Add a message to the alerts list. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/alerts/post>(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string The oauth tim… text/html 2008-10-17T15:32:29+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.remove.get?rev=1224253949&do=diff Description Remove an alert rule for the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/alerts/>{id}/remove(.xml/.json) Parameters Required Name Type Description required id string The id of the alert to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/alerts/10/remove.xml> text/html 2008-10-17T15:49:26+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.setactive.get?rev=1224254966&do=diff Description Set an alert as active or inactive. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/alerts/>{id}/{bool}/setactive(.xml/.json) Parameters Required Name Type Description required id string The id of the alert. bool bool 1 to set the alert as active 0 to set it as inactive. Example Request <http://api.cixonline.com/v1.0/cix.svc/alerts/10/1/setactive.xml> text/html 2008-07-21T12:01:38+01:00 http://help.cixonline.co.uk/doku.php/cix.api:alerts.setdeactive.get?rev=1216638098&do=diff Description Set an alert message as deactive. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/alerts/>{msgid}/deactive(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string T… text/html 2008-11-13T11:27:58+01:00 http://help.cixonline.co.uk/doku.php/cix.api:authentication.guide?rev=1226575678&do=diff The following is a detailed guide to the API login procedure. The authentication method for logging in to a Web application and a desktop application differ slightly so high level guides are also documented. All calls to the CIX API require a digital signature authorising access before any data will be returned. We use the OAuth protocol to provide this security layer, developers use this format in their applications to make successful requests to the CIX REST APIs. text/html 2008-10-17T15:45:45+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.alert?rev=1224254745&do=diff Description The Alert class contains the information required to add an alert rule for the user. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Forum string The name of the forum. Topic string The name of the topic. MsgID int Set this to the message ID if the rule is to only send alerts for direct replies to this message (unless Root is true). Root bool Set to true if the rule is to alert the user of all posts to thi… text/html 2008-10-16T12:12:04+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.forum?rev=1224155524&do=diff Description The Forum class is used for submiting forum details to the system. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Name string The name of the forum. Type string Must be o,p or c for open/private/closed. Category string Must be a valid top level directory category. SubCategory string Must be a valid sub category of the category. Title string The title of the forum (max length 255). Description string The … text/html 2008-10-20T13:25:42+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.frienddetailadd?rev=1224505542&do=diff Description The FriendDetailAdd class is used for attaching additonal details to a friend. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description FriendName string The name of the friend to add details to. Detail string The detail to add. Example XML <FriendDetailAdd xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Detail>We work at CIX</Detail> <FriendName>charlie</FriendName> </Fr… text/html 2008-10-20T17:09:41+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.pmessageadd?rev=1224518981&do=diff Description The PMessageAdd class is used for posting new personal messages. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description FriendName string The name of the friend to add details to. Recipient string The user account where the message is being sent. Subject string The subject of the message. Body string The body of the message. Example XML <PMessageAdd xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/… text/html 2008-10-20T17:09:17+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.pmessagereply?rev=1224518957&do=diff Description The PMessageReply class is used for posting a reply to a personal message. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description ConID string The ID of the conversation. Body string The body of the message. Example XML <PMessageReply xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Body>Reply to test</Body> <ConID>196</ConID> </PMessageReply> text/html 2008-10-15T15:45:44+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.pointer?rev=1224081944&do=diff Description The Pointer class contains the information required to find a message. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Forum string The name of the forum. Topic string The name of the topic. ID int The message ID of the message. Example XML <PostMessage xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Forum>charlietest</Forum> <ID>10</ID> <Topic>newtest</Topic>… text/html 2008-10-14T16:48:14+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.postmessage?rev=1223999294&do=diff Description The PostMessage class is used for submiting new messages into the system. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Forum string The name of the forum to post into. Topic string The name of the topic to post into. Body string The body of the message. MsgID int The message ID of the message this is a replt to or 0 for a new post. Example XML <PostMessage xmlns="http://cixonline.com" xmlns:i="http:/… text/html 2008-10-16T13:58:15+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.rule?rev=1224161895&do=diff Description The Rule class is used for submiting new rule details to the system. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description RuleID string The id of the rule 0 for a new one. Username string The user the rule is to apply to. Forum string The forum being moderated. Topic string The topic the rule is for (can be blank to imply for all topics). CanPost string 1 to say the user can post 0 to block posts. Banned string… text/html 2008-10-15T17:17:26+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.searchrequest?rev=1224087446&do=diff Description The SearchRequest class is used for submiting searchs to the system. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Query string The text to search for. Years string The number of years to search back (default 1). Forum string Set this property to restrict the search to a forum. Author string Set this to only return messages posted by this author. Example XML <SearchRequest xmlns="http://cixonline.com"… text/html 2008-10-20T14:35:38+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.staradd?rev=1224509738&do=diff Description The StarAdd class contains the information required to star a message. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Forum string The name of the forum. Topic string The name of the topic. MsgID int The message ID of the message. Example XML <PostMessage xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Forum>charlietest</Forum> <MsgID>10</ID> <Topic>newtest</… text/html 2008-10-16T12:25:14+01:00 http://help.cixonline.co.uk/doku.php/cix.api:class.topic?rev=1224156314&do=diff Description The Toic class is used for submiting forum topic details to the system. Simply build up a string in the style of either XML or JSON and POST it to the correct end point. Property Type Description Name string The name of the topic. Flag string 'r' for read only. Desc string The topic description. Files string 'f' if the topic supports CoSy files. Example XML <Forum xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Desc>A test forum topic descr… text/html 2009-10-29T12:52:03+01:00 http://help.cixonline.co.uk/doku.php/cix.api:desktop.app?rev=1256820723&do=diff Desktop Application We recommend different authorisation urls for desktop applications and web applications for desktop applications we recommend that for step “C” in the above diagram users are sent to:- <http://forums.cixonline.com/secure/authapp.aspx?oauth_token=>{request token from step “B”}&oauth_callback={optional address to redirect to on completion of autorisation} text/html 2008-10-16T10:52:34+01:00 http://help.cixonline.co.uk/doku.php/cix.api:directory.categories.get?rev=1224150754&do=diff Description Returns a list of the directories categories and sub categories. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/directory/categories>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/directory/categories.xml> text/html 2008-10-16T11:12:08+01:00 http://help.cixonline.co.uk/doku.php/cix.api:directory.categoryforums.get?rev=1224151928&do=diff Description Returns all the forums listed under a directory category. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/directory/>{category}/forums(.xml/.json) Parameters Required Name Type Description required category string The category to return results for. Example Request <http://api.cixonline.com/v1.0/cix.svc/directory/arts/forums.xml> text/html 2008-10-16T11:18:53+01:00 http://help.cixonline.co.uk/doku.php/cix.api:directory.search.post?rev=1224152333&do=diff Description To search the directory you must first populate and post a SearchRequest object. The directory search only uses the Query field. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/directory/search>(.xml/.json) text/html 2008-10-21T12:17:20+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.details.get?rev=1224587840&do=diff Description Returns the title, description and other details related to the forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/details(.xml/.json) Parameters Required Name Type Description required forum string The name of the forum to return details for. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/details.xml> text/html 2008-10-15T16:43:54+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.join.get?rev=1224085434&do=diff Description Joins the current user to a forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/join(.xml/.json) Parameters Required Name Type Description required forum string The forum to join. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/join.xml> text/html 2008-10-15T16:26:01+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.markreadforum.get?rev=1224084361&do=diff Description Marks all the messages in a forum read for the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/markreadforum(.xml/.json) Parameters Required Name Type Description required forum string The forum to mark read. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/markreadforum.xml> text/html 2008-10-15T16:31:56+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.markreadmessage.get?rev=1224084716&do=diff Description Mark an individual message as read or unread for the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/{bool}/markreadmessage(.xml/.json) Parameters Required Name Type Description required forum string The forum containing the thread. topic string The topic containing the thread. msgid string The message id to mark read. bool int 1 to mark read 0 to mark unread. Example Request … text/html 2008-10-15T16:29:35+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.markreadthread.get?rev=1224084575&do=diff Description Marks all the messages in a topic thread read for the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/markreadthread(.xml/.json) Parameters Required Name Type Description required forum string The forum containing the thread. topic string The topic containing the thread. msgid string The thread root id to mark read. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/c… text/html 2008-10-15T16:27:21+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.markreadtopic.get?rev=1224084441&do=diff Description Marks all the messages in a forum topic read for the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/markreadtopic(.xml/.json) Parameters Required Name Type Description required forum string The forum containing the topic. topicstring The forum topic to mark read. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/8feedback/markreadtopic.xml> text/html 2008-10-14T16:20:56+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.message.get?rev=1223997656&do=diff Description Returns an individual message. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/message(.xml/.json) Parameters Required Name Type Description required forum string The forum containing the topic. topic string The topic containing the message. msgid string The message ID of the message to retrieve. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/8feedback/2/message.xml> text/html 2008-10-15T15:31:54+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.message.post?rev=1224081114&do=diff Description Post a message into a topic, to start a new thread. The new message needs to be formated as an PostMessage object, the message ID should be 0 for a new post and non zero for a comment. The number returned is the message ID of the new message. text/html 2008-10-17T11:59:17+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.messagecopy.post?rev=1224241157&do=diff Description Copy an exisiting message into a topic, a Pointer object must be submit in the POST request, with the details of the existing message. The number returned is the message ID of the new message. Requires OAuth authentification. Method POST text/html 2008-10-14T16:19:53+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.messageroot.get?rev=1223997593&do=diff Description Returns the root message pointer for a given message. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/root(.xml/.json) Parameters Required Name Type Description required forum string The forum containing the topic. topic string The topic to list threads for. msgid string The message ID of the message to find the root of. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/… text/html 2008-10-14T15:42:41+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.moderators.get?rev=1223995361&do=diff Description Returns a list of the forum moderators. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/moderators(.xml/.json)[?start={start}&maxresults={maxresults}] Parameters Required Name Type Description required forum string Name of the forum to get a moderator list for. optional maxresults string The max number of results to retreive (Default 200) start string The position to start from (Default 0) Example Request <http:… text/html 2008-10-14T15:43:06+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.participants.get?rev=1223995386&do=diff Description Returns a list of the forum participants. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/participants(.xml/.json)[?start={start}&maxresults={maxresults}] Parameters Required Name Type Description required forum string Name of the forum to get a participant list for. optional maxresults string The max number of results to retreive (Default 200) start string The position to start from (Default 0) Example Return XM… text/html 2008-10-14T16:33:57+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.post?rev=1223998437&do=diff Description Post a message into a topic, to start a new thread. The new message needs to be formated as an PostMessage object, the message ID should be 0 for a new post and non zero for a comment. The number returned is the message ID of the new message. text/html 2008-10-15T16:22:51+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.prioritytoggle.get?rev=1224084171&do=diff Description Toggles a forum between priority and not. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/priority(.xml/.json) Parameters Required Name Type Description required forum string The forum to toggle Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/priority.xml> text/html 2008-10-15T16:46:10+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.resign.get?rev=1224085570&do=diff Description Resigns a user from a forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/resign(.xml/.json) Parameters Required Name Type Description required forum string The forum to resign. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/resign.xml> text/html 2008-10-15T17:10:37+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.search.post?rev=1224087037&do=diff Description To search forums you must first populate and post a SearchRequest object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/search>(.xml/.json) Parameters Required Name Type Description required new search SearchRequest A populated SearchRequest object Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/search.xml> text/html 2008-10-14T15:43:25+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.tags.get?rev=1223995405&do=diff Description Returns a list of tags associated with a forum. Requires OAuth authentification. Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/tags(.xml/.json)[?start={start}&maxresults={maxresults}] Parameters Required Name Type Description required forum string The forum to return tags for. optional maxresults string The max number of results to retreive (Default 200) start string The position to start from (Default 0) Example Request <http://api.cixonline.com/v1.0/cix… text/html 2008-10-14T15:44:52+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.topics.get?rev=1223995492&do=diff Description Returns a list of topics attached to this forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/topics(.xml/.json)[?start={start}&maxresults={maxresults}] Parameters Required Name Type Description required forum string The forum to return topics for. optional maxresults string The max number of results to retreive (Default 200) start string The position to start from (Default 0) Example Request <http://api.cix… text/html 2008-10-14T15:54:45+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.topicthread.get?rev=1223996085&do=diff Description Returns a subset or all of the messages in a thread. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/thread(.xml/.json)[?start={start}&maxresults={maxresults}] text/html 2008-10-14T15:45:12+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.topicthreads.get?rev=1223995512&do=diff Description Returns a list of root messages in a topic. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/threads(.xml/.json)[?start={start}&maxresults={maxresults}] Parameters Required Name Type Description required forum string The forum containing the topic. topic string The topic to list threads for. optional maxresults string The max number of results to retreive (Default 200) start string The position to start fr… text/html 2008-10-15T16:03:18+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.withdraw.get?rev=1224082998&do=diff Description Withdraws a message from the system. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/withdraw(.xml/.json) Parameters Required Name Type Description required forum string The forum containing the topic. topic string The topic to list threads for. msgid string The message ID of the message to find the root of. Example Request <http://api.cixonline.com/v1.0/cix.svc/forums/cix.customer/8feedback/10/… text/html 2008-07-15T16:00:53+01:00 http://help.cixonline.co.uk/doku.php/cix.api:forum.withdraw?rev=1216134053&do=diff Description Withdraws a message if the user is either a moderator of the forum, or the author of the message. If the user is both a moderator and the author, the message will be marked as having been withdrawn by the author. Endpoint <http://api.cixonline.com/v1.0/cix.svc/forums/>{forum}/{topic}/{msgid}/withdraw(.xml/.json) text/html 2008-07-21T11:07:49+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.del?rev=1216634869&do=diff Description Remove a friendship. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/friends/>{user}/delete(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string The oauth timest… text/html 2008-07-21T11:10:56+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.details.del?rev=1216635056&do=diff Description Remove a relationship detail from a friendship. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/friends/details/>{id}/delete(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_… text/html 2008-07-21T11:13:36+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.details.post?rev=1216635216&do=diff Description Add a relationship detail to a friendship. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/friends/details/post>(.xml/json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp str… text/html 2008-10-20T13:19:36+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.detailsadd.post?rev=1224505176&do=diff Description To add details to a friend you must first populate and post a FriendDetailAdd object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends/details/add>(.xml/.json) Parameters Required Name Type Description required new friend detail FriendDetailAdd A populated FriendDetailAdd object Example Request <http://api.cixonline.com/v1.0/cix.svc/friends/details/add.xml> text/html 2008-10-20T13:29:01+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.detailsrem.get?rev=1224505741&do=diff Description Remove details form a friend. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends/details/>{id}/rem(.xml/.json) Parameters Required Name Type Description required id string The id of the detail to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/friends/details/10/rem.xml> text/html 2008-10-17T16:26:12+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.get?rev=1224257172&do=diff Description Gets a list of friends with details. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/friends.xml> text/html 2008-10-20T13:35:45+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.remove.get?rev=1224506145&do=diff Description Remove a friend from the users friend list. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends/>{user}/rem(.xml/.json) Parameters Required Name Type Description required user string The user to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/friends/charlie/rem.xml> text/html 2008-10-20T13:42:51+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.requestmake.get?rev=1224506571&do=diff Description Make a new friend request. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends/>{user}/request(.xml/.json) Parameters Required Name Type Description required user string The user to make a request to. Example Request <http://api.cixonline.com/v1.0/cix.svc/friends/charlie/request.xml> text/html 2008-10-20T11:48:22+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.requestrespond.get?rev=1224499702&do=diff Description Accept or reject a friend request. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends/>{user}/{bool}/respond(.xml/.json) Parameters Required Name Type Description required user string The user that made the request. bool boolean 1 to accept, 0 to reject Example Request <http://api.cixonline.com/v1.0/cix.svc/friends/charlie/1/respond.xml> text/html 2008-10-20T11:37:37+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.requests.get?rev=1224499057&do=diff Description Returns a list of requests made or recived by the user. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/friends/requests>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/user/friends/requests>(.xml/.json) text/html 2008-07-21T11:19:28+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.requests.make.get?rev=1216635568&do=diff Description Add a friend request. Endpoint <http://api.cixonline.com/v1.0/cix.svc//user/friends/>{user}/request(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string The oauth tim… text/html 2008-07-21T11:21:32+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.requests.respond.get?rev=1216635692&do=diff Description Accept or decline a friend request. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/friends/>{user}/{bool}/respond(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp … text/html 2008-07-21T11:26:08+01:00 http://help.cixonline.co.uk/doku.php/cix.api:friends.user.get?rev=1216635968&do=diff Description Get a list of friends, with details of a specified user. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{user}/friends(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_tim… text/html 2008-11-21T14:48:46+01:00 http://help.cixonline.co.uk/doku.php/cix.api:generate.sig?rev=1227278926&do=diff This is a copy of the GenerateSignature and GenerateSignatureBase functions we are using. public string GenerateSignature(Uri url, string consumerKey, string consumerSecret, string token, string tokenSecret, string httpMethod, string timeStamp, string nonce, SignatureTypes signatureType) { string signatureBase = GenerateSignatureBase(url, consumerKey, consumerSecret, token, tokenSecret, httpMethod, timeStamp, nonce, HMACSHA1SignatureType); HMACSHA1 hmacsha1 = new HMACSHA1(); hmacsha1.Ke… text/html 2008-10-22T09:50:47+01:00 http://help.cixonline.co.uk/doku.php/cix.api:getting.started?rev=1224665447&do=diff Tips on how to start developing using the CIX FORUMS API. text/html 2008-05-02T17:28:05+01:00 http://help.cixonline.co.uk/doku.php/cix.api:home?rev=1209745685&do=diff The CIX API is currently still in development. text/html 2008-10-16T11:54:14+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.forumnew.post?rev=1224154454&do=diff Description To create a forum you must first populate and post a Forum object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/forumnew>(.xml/.json) Parameters Required Name Type Description required new forum Forum A populated Forum object Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/forumnew.xml> text/html 2008-10-16T12:15:52+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.forumupdate.post?rev=1224155752&do=diff Description To update a forum you must first populate and post a Forum object, with the updated details. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/forumupdate>(.xml/.json) Parameters Required Name Type Description required forum object Forum A populated Forum object Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/forumupdate.xml> text/html 2008-10-16T13:34:47+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.moderatoradd.get?rev=1224160487&do=diff Description Adds a new moderator to the forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/>{forum}/{user}/modadd(.xml/.json) Parameters Required Name Type Description required forum string The forum being moderated. required user string The user to add. Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/charlie/modadd.xml> text/html 2008-10-16T13:37:33+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.moderatorrem.get?rev=1224160653&do=diff Description Removes a moderator from the forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/>{forum}/{user}/modrem(.xml/.json) Parameters Required Name Type Description required forum string The forum being moderated. required user string The user to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/charlie/modrem.xml> text/html 2008-10-16T13:40:15+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.participantadd.get?rev=1224160815&do=diff Description Adds a participant to the forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/>{forum}/{user}/partadd(.xml/.json) Parameters Required Name Type Description required forum string The forum being moderated. required user string The user to add. Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/charlie/partadd.xml> text/html 2008-10-16T13:41:33+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.participantrem.get?rev=1224160893&do=diff Description Removes a participant from the forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/>{forum}/{user}/partrem(.xml/.json) Parameters Required Name Type Description required forum string The forum being moderated. required user string The user to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/charlie/partrem.xml> text/html 2008-10-16T13:48:35+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.ruleadd.post?rev=1224161315&do=diff Description To create a new rule you must first populate and post a Rule object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/ruleadd>(.xml/.json) Parameters Required Name Type Description required new rule Rule A populated Rule object Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/ruleadd.xml> text/html 2008-10-16T14:07:18+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.rulerem.get?rev=1224162438&do=diff Description Removes a rule based on it's ID. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/>{forum}/{id}/rulerem(.xml/.json) Parameters Required Name Type Description required forum string The forum being moderated. id string The id of the rule to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/10/rulerem.xml> text/html 2008-10-22T14:43:55+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.rules.get?rev=1224683035&do=diff Description Gets a list of rules in a forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/>{forum}/rules(.xml/.json) Parameters Required Name Type Description required forum string The forum to return rules for. Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/cix.customer/rules.xml> text/html 2008-10-16T14:00:15+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.ruleupdate.post?rev=1224162015&do=diff Description To update a rule you must first populate and post a Rule object, with updated values. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/ruleupdate>(.xml/.json) Parameters Required Name Type Description required rule object Rule A populated Rule object Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/ruleupdate.xml> text/html 2008-10-16T12:18:52+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.topicnew.post?rev=1224155932&do=diff Description To create a forum topic you must first populate and post a Topic object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/topicnew>(.xml/.json) Parameters Required Name Type Description required new topic Topic A populated Topic object Example Request <http://api.cixonline.com/v1.0/cix.svc/moderator/topicnew.xml> text/html 2008-10-16T12:27:39+01:00 http://help.cixonline.co.uk/doku.php/cix.api:mod.topicupdate.post?rev=1224156459&do=diff Description To update a forum topic you must first populate and post a Topic object, with the updated details. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/moderator/topicupdate>(.xml/.json) text/html 2008-07-18T10:50:35+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.add?rev=1216374635&do=diff Needs removing text/html 2008-07-18T11:17:15+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.inbox.get?rev=1216376235&do=diff needs removing text/html 2008-06-24T11:35:33+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.inbox.rem?rev=1214303733&do=diff Description Remove a message stored in a users inbox. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/personalmessage/rem_inbox>(.xml/.json)?msgID={msgID} Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. … text/html 2008-07-18T11:34:22+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.inbox.toggleread?rev=1216377262&do=diff needs removing text/html 2008-07-18T11:39:22+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.outbox.get?rev=1216377562&do=diff needs removing text/html 2008-06-24T11:36:35+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.outbox.rem?rev=1214303795&do=diff Description Remove a message stored in a users outbox. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/personalmessage/rem_outbox>(.xml/.json)?msgID={msgID} Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token.… text/html 2008-07-18T11:03:55+01:00 http://help.cixonline.co.uk/doku.php/cix.api:personalmessage.reply?rev=1216375435&do=diff Needs removing text/html 2008-10-20T16:44:42+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.add.post?rev=1224517482&do=diff Description Post a message into a users personal message inbox on CIX. The new message needs to be formated as a PMessageAdd object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/add>(.xml/.json) text/html 2008-10-20T16:29:47+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.get?rev=1224516587&do=diff Description Returns the messages in a personal message conversation. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/>{msgid}/message(.xml/.json) Parameters Required Name Type Description required msgid string The id of the firt message in a conversation. Example Request <http://api.cixonline.com/v1.0/cix.svc/personalmessage/>{msgid}/message.xml text/html 2008-07-18T14:18:52+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.inbox.del?rev=1216387132&do=diff Description Remove a message from a users inbox. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/personalmessage/inbox/>{msgid}/delete(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_ti… text/html 2008-10-20T16:19:17+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.inbox.get?rev=1224515957&do=diff Description Get a list of converstaion threads in the users personal message inbox. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/inbox>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/personalmessage/inbox.xml> text/html 2008-10-21T11:46:52+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.inbox.toggleread.get?rev=1224586012&do=diff Description Mark a converstaion thread from the users personal message inbox as read or unread. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/>{msgid}/{bool}/toggleread(.xml/.json) text/html 2008-10-21T11:31:57+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.inboxrem.get?rev=1224585117&do=diff Description Remove a converstaion thread from the users personal message inbox. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/inbox/>{msgid}/rem(.xml/.json) Parameters Required Name Type Description required msgid string The id of the thread to delete. Example Request <http://api.cixonline.com/v1.0/cix.svc/personalmessage/inbox/10/rem.xml> text/html 2008-07-18T14:18:12+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.outbox.del?rev=1216387092&do=diff Description Remove a message from a users outbox. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/personalmessage/outbox/>{msgid}/delete(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_… text/html 2008-10-20T17:04:09+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.outbox.get?rev=1224518649&do=diff Description Get a list of converstaion threads in the users personal message outbox. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/outbox>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/personalmessage/outbox.xml> text/html 2008-10-21T11:35:02+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.outboxrem.get?rev=1224585302&do=diff Description Remove a converstaion thread from the users personal message outbox. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/outbox/>{msgid}/rem(.xml/.json) Parameters Required Name Type Description required msgid string The id of the thread to delete. Example Request <http://api.cixonline.com/v1.0/cix.svc/personalmessage/outbox/10/rem.xml> text/html 2008-07-18T14:19:52+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.post?rev=1216387192&do=diff Description Create a new conversation. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/personalmessage/post>(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string The oauth t… text/html 2008-10-20T17:08:28+01:00 http://help.cixonline.co.uk/doku.php/cix.api:pmessage.reply.post?rev=1224518908&do=diff Description Post a reply to a users personal message inbox on CIX. The new message needs to be formated as a PMessageReply object. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/personalmessage/reply>(.xml/.json) text/html 2008-10-27T11:30:29+01:00 http://help.cixonline.co.uk/doku.php/cix.api:resources?rev=1225107029&do=diff .Net Library Wrapper This library contains all methods for v1.0 of the API. It handles oAuth authentication for you. Download library Download demo source View demo text/html 2010-09-07T10:41:26+01:00 http://help.cixonline.co.uk/doku.php/cix.api:rest_methods?rev=1283852486&do=diff The article contains extended documentation about the CIX API. With the API, you can access all data on CIX necessary to build CIX readers, utilities etc. REST Interface The API uses a REST-like interface. This means that our CIX API method calls are made over the internet by sending HTTP GET or POST requests to the CIX API REST server . Nearly any computer language can be used to communicate over HTTP with the REST server. text/html 2008-10-20T14:33:39+01:00 http://help.cixonline.co.uk/doku.php/cix.api:starred.add.post?rev=1224509619&do=diff Description Adds a new starred message pointer for the user, a populated StarAdd object must be sent with the post request. Requires OAuth authentification. Method POST Endpoint <http://api.cixonline.com/v1.0/cix.svc/starred/add>(.xml/.json) text/html 2008-07-18T14:23:04+01:00 http://help.cixonline.co.uk/doku.php/cix.api:starred.del?rev=1216387384&do=diff Description Remove a message from a users starred list. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/starred/>{forum}/{topic}/{msgid}/del(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oa… text/html 2008-10-20T14:08:46+01:00 http://help.cixonline.co.uk/doku.php/cix.api:starred.get?rev=1224508126&do=diff Description List the user starred messages. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/starred>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/starred.xml> text/html 2008-07-18T14:22:45+01:00 http://help.cixonline.co.uk/doku.php/cix.api:starred.post?rev=1216387365&do=diff Description Add a message to a users starred list. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/starred/post>(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timestamp string The oau… text/html 2008-10-20T14:42:59+01:00 http://help.cixonline.co.uk/doku.php/cix.api:starred.remove.get?rev=1224510179&do=diff Description Removes a star from the users starred list. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/starred/>{forum}/{topic}/{msgid}/rem(.xml/.json) Parameters Required Name Type Description required user string The user to remove. Example Request <http://api.cixonline.com/v1.0/cix.svc/friends/cix.customer/8feedback/10/rem.xml> text/html 2008-10-21T12:20:42+01:00 http://help.cixonline.co.uk/doku.php/cix.api:tags.byforum.get?rev=1224588042&do=diff Description Returns the tags related to the forum. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/tags/>{forum}/byforum(.xml/.json) Parameters Required Name Type Description required forum string The name of the forum to return tags for. Example Request <http://api.cixonline.com/v1.0/cix.svc/tags/cix.customer/byforum.xml> text/html 2008-10-21T12:28:47+01:00 http://help.cixonline.co.uk/doku.php/cix.api:tags.bytopic.get?rev=1224588527&do=diff Description Returns the tags related to the forum topic. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/tags/>{forum}/{topic}/bytopic(.xml/.json) Parameters Required Name Type Description required forum string The name of the forum to return tags for. topic string The name of the forum topic to return tags for. Example Request <http://api.cixonline.com/v1.0/cix.svc/tags/cix.customer/8feedback/bytopic.xml> text/html 2008-10-21T12:33:27+01:00 http://help.cixonline.co.uk/doku.php/cix.api:tags.userbyforum.get?rev=1224588807&do=diff Description Returns the tags related to the forum added by the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/tags/>{forum}/userbyforum(.xml/.json) Parameters Required Name Type Description required forum string The name of the forum to return tags for. Example Request <http://api.cixonline.com/v1.0/cix.svc/tags/cix.customer/userbyforum.xml> text/html 2008-10-21T12:34:39+01:00 http://help.cixonline.co.uk/doku.php/cix.api:tags.userbytopic.get?rev=1224588879&do=diff Description Returns the tags related to the forum topic added by the current user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/tags/>{forum}/{topic}/userbytopic(.xml/.json) Parameters Required Name Type Description required forum string The name of the forum to return tags for. topic string The name of the forum topic to return tags for. Example Request <http://api.cixonline.com/v1.0/cix.svc/tags/cix.customer/8feedback/userbytopic.xml> text/html 2008-07-21T12:24:03+01:00 http://help.cixonline.co.uk/doku.php/cix.api:tags.users.byforum.get?rev=1216639443&do=diff Description Get a list of the users tags for a specified forum. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/tags/>{forum}/get(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth token. oauth_timesta… text/html 2008-07-22T10:01:59+01:00 http://help.cixonline.co.uk/doku.php/cix.api:tags.users.bytopic.get?rev=1216717319&do=diff Description Get a list of the users tags for a specified forum/topic. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/tags/>{forum}/topics/{topic}/get(.xml/.json) Parameters Required Name Type Description required oath_consumer_key string The consumer key associated with the calling application. oauth_signature_method string The signature method used to sign the request. oauth_signature string The oauth signature, as described in the authentication guide. oauth_token string The oauth… text/html 2008-10-23T12:42:59+01:00 http://help.cixonline.co.uk/doku.php/cix.api:testing.oauth?rev=1224762179&do=diff This is an example of how to use a third party Auth client test tool to call to retrieve an access token pair from the CIX API. Get a request token Endpoint = <http://api.cixonline.com/v1.0/cix.svc/getrequesttoken> Enter your consumerkey and secret text/html 2008-07-21T11:59:23+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.alerts.active?rev=1216637963&do=diff Needs removing text/html 2008-07-21T11:55:07+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.alerts.add?rev=1216637707&do=diff Needs removing text/html 2008-07-21T11:52:41+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.alerts.get?rev=1216637561&do=diff Needs removing text/html 2008-07-21T11:57:44+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.alerts.rem?rev=1216637864&do=diff Needs removing text/html 2008-10-17T14:20:38+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.cosysync.get?rev=1224249638&do=diff Description Syncronises the use users Forums pointers with the CoSy pointers. This is a one way process and does not effect the CoSy pointers. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/cosysync>(.xml/.json) text/html 2008-10-16T16:32:50+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.forums.get?rev=1224171170&do=diff Description Returns a list of forums the logged on user is joined to. Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/forums>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/user/forums.xml> text/html 2008-10-17T11:54:10+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.forumtopics.get?rev=1224240850&do=diff Description Returns the topics for a forum and includes the users read status. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{forum}/topics(.xml/.json) Parameters Required Name Type Description required forum string The forum to containing the topics. Example Request <http://api.cixonline.com/v1.0/cix.svc/user/cix.customer/topics.xml> text/html 2008-07-21T11:11:27+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friendrelationships.add?rev=1216635087&do=diff Needs removing text/html 2008-07-21T11:08:57+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friendrelationships.rem?rev=1216634937&do=diff Needs Removing text/html 2008-07-21T11:17:08+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friendrequests.add?rev=1216635428&do=diff Needs removing text/html 2008-07-21T11:14:06+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friendrequests.get?rev=1216635246&do=diff Needs removing text/html 2008-07-21T11:20:03+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friendrequests.respond?rev=1216635603&do=diff Needs removing text/html 2008-06-19T16:26:21+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friends.add?rev=1213889181&do=diff This page needs deleting. text/html 2008-10-17T16:31:00+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friends.get?rev=1224257460&do=diff Description Gets a list of friends with details. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{user}/friends(.xml/.json) Parameters Required Name Type Description Required user string The user to return friends for. Example Request <http://api.cixonline.com/v1.0/cix.svc/user/nigelgo/friends.xml> text/html 2008-07-21T11:05:58+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friends.rem?rev=1216634758&do=diff Needs removing text/html 2008-06-19T16:23:45+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.friends.requests.get?rev=1213889025&do=diff this page needs deleting text/html 2008-10-17T14:03:11+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.mugshot.get?rev=1224248591&do=diff Description Returns a user mugshot as a stream. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{user}/mugshot(.xml/.json) Parameters Required Name Type Description required user string The user to return a mugshot for. Example Request <http://api.cixonline.com/v1.0/cix.svc/user/charlie/mugshot.xml> text/html 2008-10-17T12:21:12+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.nextpriority.post?rev=1224242472&do=diff Description Returns the location of the users next priority unread message. A Pointer object must be submited in the post with the users current position. All the pointer's values can be blank in which case the first unread message will be returned. Otherwise just the MsgID can be blank in which case the pointer return will be for the next unread from the submit forum topic, or both the topic and msgid can be blank meaning the pointer will be from the position of the submitted forum. text/html 2008-10-17T12:21:34+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.nextunread.post?rev=1224242494&do=diff Description Returns the location of the users next unread message. A Pointer object must be submited in the post with the users current position. All the pointer's values can be blank in which case the first unread message will be returned. Otherwise just the MsgID can be blank in which case the pointer return will be for the next unread from the submit forum topic, or both the topic and msgid can be blank meaning the pointer will be from the position of the submitted forum. text/html 2008-10-16T14:59:43+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.profile.get?rev=1224165583&do=diff Description Returns the profile details for a user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/profile>(.xml/.json) Parameters Required Name Type Description Example Request <http://api.cixonline.com/v1.0/cix.svc/user/profile.xml> text/html 2008-10-17T12:36:05+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.recentposts.get?rev=1224243365&do=diff Description Returns a list of a users most recent posts in open forums (max 20 results). A user can opt to disable this report. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{user}/recentposts(.xml/.json) text/html 2009-10-26T12:33:26+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.scratchpad.get?rev=1256560406&do=diff Description Gets the next x number of messages for a custom client. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{client}/{max}/{back}/scratchpad(.xml/.json) Parameters Required Name Type Description yes client string The name of your given client. yes max int The number of messages to return. yes back int Retrieve x messages from new topics. Usually set to 0. Example Request <http://api.cixonline.com/v1.0/cix.svc/user/ci… text/html 2010-09-07T10:50:23+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.setpointersback.get?rev=1283853023&do=diff Description Sets the pointers back x number of days for a custom client. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{client}/{back}/setpointersback(.xml/.json) Parameters Required Name Type Description yes client string The name of your given client. yes back int The days to set the pointers back for a given client. Example Request <http://api.cixonline.com/v1.0/cix.svc/user/cixtoast/5/setpointersback>(.xml/.json) text/html 2008-07-18T12:09:49+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.stared.add?rev=1216379389&do=diff Needs removing text/html 2008-07-18T12:04:32+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.stared.get?rev=1216379072&do=diff Needs Removing text/html 2008-07-18T12:28:06+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.stared.rem?rev=1216380486&do=diff needs removing text/html 2008-10-17T09:10:12+01:00 http://help.cixonline.co.uk/doku.php/cix.api:user.userprofile.get?rev=1224231012&do=diff Description Returns the profile for a specified user. Requires OAuth authentification. Method GET Endpoint <http://api.cixonline.com/v1.0/cix.svc/user/>{user}/profile(.xml/.json) Parameters Required Name Type Description required user string The user to return a profile for. Example Request <http://api.cixonline.com/v1.0/cix.svc/user/charlie/profile.xml>