API - Update Event Subscription

Update  Event Subscription

This API can be used to update custom properties of event subscription and update subscription status (from Active to Cancelled)

API Details

Signature of API call

connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);

See details about invoking API in general

Parameter 1 - URI

enrollmentService.do

Parameter 2 - UserName

Username of any site administrator

Parameter 3 - Request Parameters

Name Value
dispatch

updateEventSubscription

subscriptionId

event subscription Id

subscriptionStatus

Subscription status that will be updated. Only allowed value is  'CANCELLED'

customUpdPropMap['property1Name'],

customUpdPropMap['property2Name'],

customUpdPropMap['property3Name']

...

...

Custom property values to be updated at event subscription level. Each property name should be passed as "customUpdPropMap['name of property']"

These custom properties must be first defined in microsite, using the Site Admin->Custom Properties->Event Participant properties.

 

Response

1. Response on successfully adding user to group

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

<response code="0">
    <msgs>
         <msg>
             <code>0</code>
             <value><![CDATA[Success]]></value>
         </msg>
    </msgs>

</response>

 

2. Response for unauthorized access

HTTP Response Code = HttpServletResponse.SC_UNAUTHORIZED

Response XML

<response code="-1">
    <msgs>
         <msg>
             <code>0005</code>
             <value><![CDATA[You are not allowed to perform this action.]]></value>
         </msg>
    </msgs>
</response>

 

Code Snippet

    /*  Check API Call for detail generic code */
    Map<String, String> parameters = new HashMap<String, String>();
    parameters.put("subscriptionId", "81154232-7e81-11e4-b5ad-fb29daca6745");

    parameters.put("subscriptionStatus", "CANCELLED");
    parameters.put("dispatch", "updateEventSubscription");

    parameters.put("customUpdPropMap['property1Name']","property1Value");
    parameters.put("customUpdPropMap['property2Name']","property2Value");
   
    String retStr = connection.invokeApi("enrollmentService.do", "chenry", parameters);
    System.out.println(retStr);


Rating: