View on GitHub

ickstream-docs

Public documentation about the ickStream Music Platform

Finds all changes done in the current user account

Request:

{
    "jsonrpc": 2.0,
    "id": < A unique number used to correlate requests with responses, see JSON-RPC specification for more information >,
    "method": "findAccountChanges",
    "params": {
        "offset": <Optional, numeric index of first item to retrieve >
        "count": <Optional, number of items to retrieve >
    }
}

Response:

{
    "jsonrpc": 2.0,
    "id": < The request identity >
    "result": {
        "offset": <numeric index of the first item which is part of this response,
                           this is set based on the "offset" parameter provided in the request >
        "count": < number of items in this response, if "count" has been specified in request it is the maximum value of this item >,
        "countAll": <Total number of account changes available for current user>,
        "items": [
            {
                "id": < Unique identity for this change >,
                "occurrenceTimestamp": < Timestamp which indicates when the change occurred, as unix epoch >
                "type": < Indication of which type of change this represents >
                "text": < Textual representation of this item >,
                "itemAttributes" < Optional, structure with detailed attributes related to this change >

            },
            ...
        ]
    }
}

Some important things to note:

The itemAttributes structure looks different depending of the type attribute value.

{
    "deviceId": < Identity of the device >
    "deviceModel": < Model of the device >
    "deviceName": < Name of the device >
}
{
    "previousDeviceId": < Previous identity of the device >
    "previousDeviceName": < Previous name of the device >
    "deviceId": < Identity of the device >
    "deviceModel": < Model of the device >
    "deviceName": < Name of the device >
}
{
    "serviceId": < Identity of the service >
    "serviceName": < Name of the service >
}
{
    "type": < Type of identity >
    "identity": < The unique identity, for example an e-mail address if type=email >
}

No itemAttributes structure

Category:Cloud Core Protocol