Forum.Participants.get

Forum.Participants.get

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 XML

<Parts xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>790</Count> 
  <Start>0</Start> 
  <Users> 
    <Part> 
      <Name>charlie</Name> 
    </Part> 
    <Part> 
      <Name>mat</Name> 
    </Part> 
  </Users> 
</Parts>

Example Return JSON

{
  "Count":790,
  "Start":0,
  "Users":[
    {"Name":"charlie"},
    {"Name":"mat"}
  ]
}

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.