Getting all the available user profile icons

Request

To enable the user to select an icon image (avatar) for their profile, the client application needs to get all the available profile icon images so it can display them to the user.

To get all the profile images, send a GET request to:

CODE

https://<host>:<port>/imagemetadata/v1/profile

Headers

token– request authentication token
x-correlation-id – identifier for logging, to correlate messages across a call flow

Mandatory arguments

None

Optional arguments

None

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

Example

A successful request returns a payload that looks like this:

JSON

{
    "count": 2,
    "results": [
        {
            "resourceId": "smileyface",
            "aspect": "1x1",
            "uri": "image-service/discrete/OpfProfile/smileyface/default-locale/OpfProfile_1x1_master",
            "imageId": "OpfProfile_smileyface_1x1_master"
        },
        {
            "resourceId": "angryface",
            "aspect": "1x1",
            "uri": "image-service/discrete/OpfProfile/angryface/default-locale/OpfProfile_1x1_master",
            "imageId": "OpfProfile_angryface_1x1_master"
        }
    ]
}