Sub URL: /jsonsdk/ItemManagement/addItemForContentService1
Type: POST
Description: This REST 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).
Input Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| cobSessionToken | This is the cobrand session token received from the coblogin call. | Yes | |
| userSessionToken | This is the user session token received from the login call. | Yes | |
| contentServiceId | The identifier of the content service associated with the member item being added. | Yes | 11195 |
| credentialFields.enclosedType | This is the type of credentialFields. The values could be com.yodlee.common.FieldInfoMultiFixed (which encapsulates a name-value pair setting for a multivalued field, where the multiple values assumed are a fixed number) or com.yodlee.common.FieldInfoSingle (which encapsulates a name-value pair setting for a single valued field). | Yes | com.yodlee.common. FieldInfoSingle |
| credentialFields[0].displayName | This is the name displayed for the field. | Yes | Username |
| credentialFields[0].fieldType.typeName | This is the type of the field. The possible values are TEXT, IF_PASSWORD, OPTIONS, CHECKBOX, RADIO, IF_LOGIN, URL, HIDDEN, IMAGE_URL, CONTENT_URL, CUSTOM and CLUDGE. | Yes | TEXT |
| credentialFields[0].helpText | This is the identifier for help text provided for this field. | 22069 | |
| credentialFields[0].maxlength | This is the maximum length allowed for the value. | 40 | |
| credentialFields[0].name | This is the internal name of the field. | Yes | LOGIN |
| credentialFields[0].size | This is the size of the field. | 20 | |
| credentialFields[0].value | This is the value for the field. | Yes | sha5.Investment1 |
| credentialFields[0].valueIdentifier | This is the value identifier that uniquely identifies the field. | Yes | LOGIN |
| credentialFields[0].valueMask | This is the display mask to be set for the value of this field. | Yes | LOGIN_FIELD |
| credentialFields[0] .isEditable | This indicates whether the value is editable for this field. | Yes | true |
| credentialFields[1].displayName | This is the name displayed for the field. | Yes | Password |
| credentialFields[1].fieldType.typeName | This is the type of field. The possible values are TEXT, IF_PASSWORD, OPTIONS, CHECKBOX, RADIO, IF_LOGIN, URL, HIDDEN, IMAGE_URL, CONTENT_URL, CUSTOM, and CLUDGE. | Yes | IF_PASSWORD |
| credentialFields[1].helpText | This is the identifier for the help text provided for this field. | No | 22068 |
| credentialFields[1].maxlength | This is the maximum length allowed for the value. | No | 40 |
| credentialFields[1].name | This is the internal name of the field. | Yes | PASSWORD |
| credentialFields[1].size | This is the size of the field. | 20 | |
| credentialFields[1].value | This is the value for the field. | Yes | Investment1 |
| credentialFields[1].valueIdentifier | This is the value identifier that uniquely identifies the field. | Yes | PASSWORD |
| credentialFields[1].valueMask | This is the display mask to be set for the value of this field. | Yes | LOGIN_FIELD |
| credentialFields[1] .isEditable | This indicates whether the value is editable for this field. | Yes | true |
| shareCredentialsWithinSite | If the member item being added has the same credentials as an already existing member item belonging to the same site, then the credentials are shared between the two member items. Therefore, when the credentials are updated for one of these member items, the change will be reflected in the other member item also. To disable this behavior, this flag must be set to false. Currently the system supports the value of true only. | Yes | true |
| startRefreshItemOnAddition | If this is set to true, a refresh is initiated for the added item. | Yes | true |
Returns
This returns a long value indicating the identifier of the item being added.
Exceptions
| Name | Description |
|---|---|
| InvalidCobrandConversationCredentialsException | If the specified cobrandContext is 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. |
Sample JSON Response
This API returns itemId as String value. Note that the response will be unformatted and not be in JSON format.
{
"primitiveObj":10031727
}