Set Note

Description

Set/update a note on one of your contacts.

HTTP Method

POST

Path

/friends/{objectId}/note

Authentication

Requires an authenticated user.

Parameters

Table 31.  Parameters for " Set Note "

NameTypeValue TypeDescription
objectIdPATHlongThe id of the object to set the note to
noteFORMStringThe note to set on the contact.

Error Codes

130006 ( Object )

The oject Id specified does not exist.

150001 ( Common )

The endpoint requires an authenticated account

30000 ( Friends )

An unhandled exception has occured.

30002 ( Friends )

Trying to access the data of a user that is not your friend.

30009 ( Friends )

Don't have the permission to execute this request

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="success" type="tns:Status" default="FAILURE" minOccurs="0"/>
        <xs:element name="error" type="tns:Error" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="Error">
    <xs:sequence>
      <xs:element name="code" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="Status">
    <xs:restriction base="xs:string">
      <xs:enumeration value="SUCCESS"/>
      <xs:enumeration value="FAILURE"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://xsd.poken.com">
	<success>SUCCESS</success>
</response>