Forum.Message.get

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

Example Return XML

<Message xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Author>xxx</Author> 
  <Body>Welcome to cix.customer/8feedback...</Body> 
  <DateTime>31/05/2008 15:10:11</DateTime> 
  <Depth>0</Depth> 
  <Forum>cix.customer</Forum> 
  <ID>2</ID> 
  <Priority>false</Priority> 
  <ReplyTo>0</ReplyTo> 
  <RootID>2</RootID> 
  <Starred>false</Starred> 
  <Status>R</Status> 
  <Topic>8feedback</Topic> 
</Message>

Example Return JSON

{
  "Author":"xxx",
  "Body":"Welcome to cix.customer\/8feedback...",
  "DateTime":"31\/05\/2008 15:10:11","Depth":0,"Forum":"cix.customer","ID":2,
  "Priority":false,"ReplyTo":0,"RootID":2,"Starred":false,
  "Status":"R","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/forum.message.get.txt · Last modified: 2008/10/14 15:20 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