getUserBanners

Returns a list of Home Banners (adverts) that are applicable to a User based on the aggregation of their User Profile data User Taxonomy data (using Country, Profession, and Specialty). See: https://healthinteract.tpondemand.com/entity/15688-sam-api-getuserbanners-to-retrieve-banner

NOTE: v2 (version=2) supports SPONSORS that have an App Logo x 1 and/or Splash Logos x 2.

Request

GET /rest/user/banners

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

Path Params: version - (long, required) the version of this API. Two versions are now supported as of 21-OCT-2025. version=1 is backwardly compatible and only returns banners of type=BAN (BANNERS). version=2 returns banners and sponsors type=BAN and SPN.

V1 curl --location 'https://test-services.interact.technology/rest//user/banners?version=1'
--header 'x-nextinteract-authtoken: gF7AaazKtRSP0kXKqXf79A=='

V2 curl --location 'https://test-services.interact.technology/rest//user/banners?version=2'
--header 'x-nextinteract-authtoken: gF7AaazKtRSP0kXKqXf79A=='

Response

200 OK

V1 Response - only banners returned. NOTE: the ommission of bannerTypeCode introduced in V2

[
  {
    "bannerUUID": "7305c2da-a6e8-4b2e-b78b-74e2b6b37e9e",
    "bannerName": "Test Banner 1",
    "bannerDescription": "Test Banner 1 Desc",
    "bannerURL": "http://www.somesite.com/1?it_method=homebanner&it_metadata_id=7305c2da-a6e8-4b2e-b78b-74e2b6b37e9e",
    "companyId": 123,
    "bannerExpiryDate": 1594276096709,
    "imagesRootURL": "http://www.aws.com/s3bucket/whatever/7305c2da-a6e8-4b2e-b78b-74e2b6b37e9e/root",
    "imageNames": {
      "desktop": "desktop.jpg",
      "phone-portrait": "phone-portrait.jpg",
      "phone-landscape": "phone-landscape.jpg",
      "tablet-portrait": "tablet-portrait.jpg",
      "tablet-landscape": "tablet-landscape.jpg"
    }
  },
  {
    "bannerUUID": "534de354-1211-4ed8-9cb2-9b0f28e0cf1a",
    "bannerName": "Test Banner 2",
    "bannerDescription": "Test Banner 2 Desc",
    "bannerURL": "http://www.somesite.com/2?it_method=homebanner&it_metadata_id=534de354-1211-4ed8-9cb2-9b0f28e0cf1a",
    "companyId": 456,
    "bannerExpiryDate": 1594276096717,
    "imagesRootURL": "http://www.aws.com/s3bucket/whatever/534de354-1211-4ed8-9cb2-9b0f28e0cf1a/root",
    "imageNames": {
      "desktop": "desktop.gif",
      "phone-portrait": "phone-portrait.gif",
      "phone-landscape": "phone-landscape.gif",
      "tablet-portrait": "tablet-portrait.gif",
      "tablet-landscape": "tablet-landscape.gif"
    }
  }
]

[
  {
    "bannerId": 34,
    "bannerUUID": "5b2cc84a-5817-4eb3-8d70-b9a5cbcfe45d",
    "bannerTypeCode": "BAN",
    "bannerName": "aaron pngs test",
    "bannerDescription": "DESC NOT USED",
    "bannerURL": "https://google.com?it_method=homebanner&it_metadata_id=5b2cc84a-5817-4eb3-8d70-b9a5cbcfe45d",
    "companyId": 4627,
    "bannerStartDate": 1659353700000,
    "bannerExpiryDate": 1761866700000,
    "bannerImageFormat": "png",
    "criteria": [
      {
        "countryCodes": [
          "AU"
        ],
        "professionId": 2,
        "specialtyIds": [
          2008
        ],
        "conditionIds": []
      }
    ]
  },
  {
    "bannerId": 167,
    "bannerUUID": "e257e2df-6e0a-461a-aee9-59a2cec7b21e",
    "bannerTypeCode": "SPN",
    "bannerName": "AMSL Aaron Test",
    "bannerDescription": "DESC NOT USED",
    "companyId": 2724,
    "bannerStartDate": 1761473160000,
    "bannerExpiryDate": 1767175560000,
    "bannerImageFormat": "png",
    "criteria": [
      {
        "countryCodes": [
          "AU"
        ],
        "professionId": 2,
        "specialtyIds": [
          2008
        ],
        "conditionIds": []
      }
    ]
  }
]

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSBannerServiceException	See Error Definitions
WSUserNotFoundException	See Error Definitions