addItemForContentService1

Sub URL: /ItemManagement/addItemForContentService1

Description: This SOAP API adds the member item for a specific Content Service. (i.e., John Doe wants to aggregate his banking accounts held in IQ Bank). This API is called after getting a login form for that particular Content Service. The credentials information is populated for the fields present in login form and then this API is invoked to add all the financial accounts in that container (i.e., John Doe's banking accounts).

Method Signature

long addItemForContentService1(UserContext userContext,
                               long contentServiceId,
                               List credentialFields,
                               boolean shareCredentialsWithinSite,
                               boolean startRefreshItemOnAddition)
                               throws CoreExceptionFault,
                                      InvalidConversationCredentialsExceptionFault,
                                      IncompleteArgumentExceptionFault,
                                      IllegalArgumentValueExceptionFault,
                                      InvalidUserContextExceptionFault,
                                      IllegalArgumentTypeExceptionFault,
                                      ContentServiceNotFoundExceptionFault,
                                      StaleConversationCredentialsExceptionFault

Input Parameters

Name Description
userContext The UserContext of the user.
contentServiceId The identifier of the ContentService associated with the Member Item being added.
credentialFields A list of credential fields for the given ContentService. Each element in this list must be a FieldInfo instance.
shareCredentialsWithinSite To be set as true to share the credentials when the Member Item that is added has the same credentials as an existing Member Item belonging to the same site. Currently the system supports the value of true only.
startRefreshOnAddition To be set as true to initiate refresh for the added item.

Exceptions

Name Description
InvalidUserContextException If the user context specified is null or invalid.
InvalidConversationCredentialsException If the specified user does not have a valid session.
ContentServiceNotFoundException If the Content Service identifier specified does not exist.
IllegalArgumentTypeException If any of the credentialFields List elements are not of the correct type.
IllegalArgumentValueException If the credentialFields List is null or any value in the List is null.
IncompleteArgumentException If the credentialFields is specified, but one or more name/value pairs are missing.

Returns

This call returns the identifier of the Item that is being added.