Update connection

Description

Update an object/identity connection properties like note, keywords, favorite, status...If you don't want to update on connection property, just don't provide it in the request if is optional.If there is no connection already created, one is created and the properties are stored to it.

HTTP Method

POST

Path

/object/{objectId}/connection

Authentication

Requires an authenticated user.

Parameters

Table 39.  Parameters for " Update connection "

NameTypeValue TypeDescription
objectIdPATHlongThe id of the object to set the note to
noteFORMString(optional) The note to set for the connection to the object.
keywordsFORMString(optional) A keyword or a ';' or ',' or '.' separated list of keywords.
favoriteFORMBoolean(optional) Set a connection as favorite
markUsedFORMBoolean(optional) Set it on 'true' to update the status of the connection

Error Codes

130018 ( Object )

No connection found between the account and the object

150000 ( Common )

An unhandled exception has occured.

150001 ( Common )

The endpoint requires an authenticated account

150002 ( Common )

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>