This method can be used to manually log a social share record for the specified constituent containing information supplied by the caller. This method requires the social UID of the constituent who has shared to a social network.
| Client Servlet |
Server Servlet |
HTTP Methods Supported |
Requires Authentication |
|
CRConsAPI
|
None.
|
GET, POST
|
No.
|
Client API Syntax
https://secure2.convio.net/organization/site/CRConsAPI?method=logSocialShare
&api_key=value
&v=value
[
¢er_id=value
]
[
&error_redirect=value
]
[
&redirect=value
]
[
&response_format=xml
| json
]
[
&sign_redirects=value
]
[
&source=value
]
[
&sub_source=value
]
[
&success_redirect=value
]
[
&suppress_response_codes=value
]
&share_url=value
&social_site=value
&social_uid=value
[
&share_id=value
]
Usage Notes
The logSocialShare method records that a URL was shared to a specified social
site with the specified social user ID. For best results, this method should be used in conjuction
with the user IDs provided as part of Open Authentication and Social Sharing.
Client API Parameters
- Common Client Parameters
-
See topic Common Parameters.
- share_url
-
Required. The Luminate Online URL that the share action was taken from.
Type xsd:anyURI.
- social_site
-
Required. The social site that a constituent is using.
Type xsd:string.
- social_uid
-
Required. The social user ID that, when combined with the social site, uniquely identifies this constituent.
Type xsd:string.
- share_id
-
Optional. The administrator defined tracking ID for this sharing opportunity.
Type xsd:string.
Response
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<logSocialShareResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>12345</id>
</logSocialShareResponse>
JSON response
{"logSocialShareResponse":{"id":"12345"}}