User.NextPriority.post

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.

Requires OAuth authentification.

Method

POST

Endpoint

Parameters

Required Name Type Description
required pointer object Pointer The users current position.

Example Request

Example Return XML

<Pointer xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Forum>cix.customer</Forum> 
  <ID>3178</ID> 
  <Topic>8feedback</Topic> 
</Pointer>

Example Return JSON

{
  "Forum":"cix.customer",
  "ID":"3178",
  "Topic":"8feedback"
}

Error Codes

Code Description
400 Bad request. Check input parameters.
401 Authentication failed. Missing required parameter : {parameter name}.
401 Signature expired. Either the timestamp or the nonce have expired or are invalid.
 
cix.api/user.nextpriority.post.txt · Last modified: 2008/10/17 11:21 by charlie
 
Except where otherwise noted, content on this wiki is licensed under the following license:Public Domain
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Debian Driven by DokuWiki