AddRelationships

Adds Center, Group, or Interest relationships to one or more Constituent records.

Usage

This operation is a specialized version of the Update operation. It is provided as a logical complement to the RemoveRelationships operation.

Specify one or more CenterId, GroupId, and/or InterestId values to associate with the Constituent record when calling this operation.

Request Parameters

PartitionId
nonNegativeInteger
The system-generated unique identifier of a constituent partition
Force
boolean
Specify true to override synchronization collisions. Default is false.
Record
Record
A value is required
Multiple values allowed
A constituent record containing at least ConsId, MemberId and PrimaryEmail for identification purposes.

Response Parameters

The response may contain zero or more response elements

ResultCode
RecordResultCode
OK if the operation was successful on the corresponding element in the request, or an appropriate error code otherwise
Message
string
A short readable status message associated with the result code
Record
Record
A constituent record containing at least ConsId, MemberId and PrimaryEmail for identification purposes.

Example SOAP request

 

 <?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'>
  <soapenv:Header>
    <ns3:Session xmlns:ns3='urn:soap.convio.com' soapenv:mustUnderstand='0'>
      <ns3:SessionId>c55d8f07700b4aa8401e2b9c4d4262efa6da30d8:JSESSIONID=abcKuVJBroiHpeNByWZ3r:10000100:2008-12-01T18:13:46.019Z</ns3:SessionId>
    </ns3:Session>
  </soapenv:Header>
  <soapenv:Body>
    <ns3:AddRelationships xmlns:ns3='urn:soap.convio.com'>
      <ns3:PartitionId>123</ns3:PartitionId>
      <ns3:Record xmlns:ns1='urn:object.soap.convio.com' 
	     xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' 
	     xsi:type='ns1:Constituent'>
        <ns1:PrimaryEmail>albus@hogwarts.edu</ns1:PrimaryEmail>
        <ns1:CenterId>1001</ns1:CenterId>
        <ns1:CenterId>1002</ns1:CenterId>
        <ns1:InterestId>1001</ns1:InterestId>
        <ns1:InterestId>1002</ns1:InterestId>
        <ns1:InterestId>1003</ns1:InterestId>
        <ns1:InterestId>1005</ns1:InterestId>
        <ns1:InterestId>1007</ns1:InterestId>
        <ns1:InterestId>1011</ns1:InterestId>
        <ns1:GroupId>1010</ns1:GroupId>
        <ns1:GroupId>1011</ns1:GroupId>
        <ns1:GroupId>1015</ns1:GroupId>
      </ns3:Record>
    </ns3:AddRelationships>
  </soapenv:Body>
</soapenv:Envelope>

      

Example SOAP response

 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <AddRelationshipsResponse xmlns="urn:soap.convio.com" 
	     xmlns:ens="urn:object.soap.convio.com" 
	     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <Result>
            <ResultCode>OK</ResultCode>
            <Message>User updated.</Message>
            <Record xsi:type="ens:Constituent">
               <ens:ConsId>1001082</ens:ConsId>
               <ens:MemberId xsi:nil="true"/>
               <ens:PrimaryEmail>albus@hogwarts.edu</ens:PrimaryEmail>
            </Record>
         </Result>
      </AddRelationshipsResponse>
   </soap:Body>
</soap:Envelope>

      

Leave a Comment

Nickname
Comment
Enter this word: