Sub URL: /jsonsdk/SiteAccountManagement/getSiteAccounts

Type: POST

Description: This REST API returns the information related to the specified accounts aggregated by the consumer. 

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

 

memSiteAccIds[0] This is an array of memSiteAccIds which are internal identifiers for a consumer's specific accounts associated with some sites. For example, each memSiteAccID would uniquely identify Mr. John Doe's accounts in IQ Bank that can be accessed using a specific User ID, say "JohnDoe". Yes 10268903
memSiteAccIds[1] Another memSiteAccId for which the details are to be retrieved. Yes 10280553

Returns

This returns an array of  SiteAccountInfo objects where each SiteAccountInfo encapsulates the information related to the specified account aggregated by the consumer. When the memSiteAccIds parameter is left null or empty, this API returns all the accounts aggregated by the consumer.

Exceptions

Name Description
InvalidUserContextException If the user context specified is null or invalid
InvalidConversationCredentialsException If the specified user does not have a valid session.
IllegalArgumentValueException If one or more identifiers passed are invalid that is not present in the system or not related to this user.

Sample JSON Response

This API returns an array of SiteAccountInfo objects.

{
        "siteAccountId": 10280553,
        "isCustom": false,
        "credentialsChangedTime": 1376473666,
        "siteRefreshInfo": {
            "siteRefreshStatus": {
                "siteRefreshStatusId": 1,
                "siteRefreshStatus": "REFRESH_TRIGGERED"
            },
            "siteRefreshMode": {
                "refreshModeId": 2,
                "refreshMode": "NORMAL"
            },
            "updateInitTime": 1376473666,
            "nextUpdate": 1376474566,
            "code": 801,
            "noOfRetry": 0
        },
        "siteInfo": {
            "popularity": 0,
            "siteId": 16441,
            "orgId": 1148,
            "defaultDisplayName": "Dag Site",
            "defaultOrgDisplayName": "USOrgname",
            "contentServiceInfos": [
                {
                    "contentServiceId": 20559
                },
                {
                    "contentServiceId": 20560
                },
                {
                    "contentServiceId": 20561
                },
                {
                    "contentServiceId": 20562
                },
                {
                    "contentServiceId": 20549
                },
                {
                    "contentServiceId": 20563
                },
                {
                    "contentServiceId": 20564
                }
            ],
            "enabledContainers": [
                {
                    "containerName": "bank",
                    "assetType": 1
                },
                {
                    "containerName": "bills",
                    "assetType": 0
                },
                {
                    "containerName": "credits",
                    "assetType": 2
                },
                {
                    "containerName": "insurance",
                    "assetType": 2
                },
                {
                    "containerName": "stocks",
                    "assetType": 1
                },
                {
                    "containerName": "loans",
                    "assetType": 2
                },
                {
                    "containerName": "miles",
                    "assetType": 0
                }
            ],
            "baseUrl": "http://192.168.210.152:9090/dag/index.do",
            "defaultHelpText": "help",
            "loginForms": [],
            "isHeld": true,
            "isCustom": false,
            "siteSearchVisibility": true
        },
        "created": "2013-08-14T15:17:46+0530",
        "retryCount": 0
    }