Friends.get

Description

Gets a list of friends with details. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

Required Name Type Description

Example Request

Example Return XML

<FriendSet xmlns="http://schemas.datacontract.org/2004/07/CIX.API.Contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Count>3</Count> 
  <Friends> 
    <Friend> 
      <Details> 
        <FriendDetail> 
          <Detail>API test</Detail> 
          <ID>83</ID> 
        </FriendDetail> 
      </Details> 
      <ID>38</ID> 
      <Name>mat</Name> 
    </Friend> 
    <Friend> 
      <Details /> 
      <ID>96</ID> 
      <Name>gmdavies</Name> 
    </Friend> 
    <Friend> 
      <Details> 
        <FriendDetail> 
          <Detail>We work/worked at the Media Center, Huddersfield.</Detail> 
          <ID>85</ID> 
        </FriendDetail> 
      </Details> 
      <ID>163</ID> 
      <Name>charlie</Name> 
    </Friend> 
  </Friends> 
  <Start>0</Start> 
</FriendSet>

Example Return JSON

{
  "Count":3,
  "Friends":[
    {"Details":[
      {"Detail":"API test","ID":83}
    ],"ID":38,"Name":"mat"},
    {"Details":[
    ],"ID":96,"Name":"gmdavies"},
    {"Details":[
      {"Detail":"We work\/worked at the Media Center, Huddersfield.","ID":85}
    ],"ID":163,"Name":"charlie"}
  ],
  "Start":0
}

Error Codes

Code Description
401 Authentication failed. Missing required parameter : {parameter name}.
401 Signature expired. Either the timestamp or the nonce have expired or are invalid.
 
cix.api/friends.get.txt · Last modified: 2008/10/17 15:26 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