Getting all the user profiles for an account

Request

The client application needs to get all the user profiles for the logged-in account so it can display them to the user and allow them to select the one to be used.

To get all the user profiles, send a GET request to:

CODE

https://<host>:<port>/userprofiles/v1/user/userprofiles

Headers

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

Mandatory arguments

None

Optional arguments

Paging parameters (in query):

limit – the number of records to return
page – the page number to return (cannot be used without limit)
For example:
- ?limit=10 returns the first 10 records.
- ?limit=10&page=2 returns the second 10 records.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

A forbidden request returns an HTTP 403 status.

An invalid request returns an HTTP 404 status.

Example

A successful request returns a payload that looks like this:

JSON

{
  "totalRecords": 1,
  "resourceSet": [
    {
      "_id": "sh173d",
      "accountId": "aa11s1",
      "default": true,
      "name": "Kids",
      "childProfile": true,
      "pinPromptRequired": true,
      "preferredAudioLanguage": "eng",
      "preferredSubtitleLanguage": "eng",
      "ratingsThresholds": [
        {
          "ratingsBody": "FSK",
          "ratingsThreshold": "fsk12"
        }
      ],
      "iconName": "GrandParents",
      "additionalProperties": [
        {
          "name": "lastPPVPurchaseDate",
          "value": "2043-01-01T01:01:01.0001Z"
        }
      ]
    }
  ]
}