Service Guides for PublicationIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use PublicationIQ.

Get Alpha Browser Menu

The Get Alpha Browser Menu endpoint allows you to retrieve an alpha browser menu associated with your profile, a locale and a menu id. A locale is either a language or a language in combination with a country. For example, English - United States is 1033. The menu id is used for filtering menus in position. The menu id must be a value greater than or equal to 65 and less than or equal to 90.

To Get an Alpha Browser Menu (example):

Gather the following information for the request:

  • The EBSCO customer profile in the form of customerid.groupid.profileid.
  • The locale id number.
  • The menu id.

Request

GET https://sandbox.ebsco.io/pf/pfaccount/PROFILE/alphabrowser/menu/1033?menuid=65

Response

200 OK

{
  "position 0": [
    {
      "menuId": 0,
      "characters": "0-9",
      "order": 0,
      "count": 5048
    },
    {
      "menuId": 65,
      "characters": "A",
      "order": 1,
      "count": 60280
    },
    {
      "menuId": 66,
      "characters": "B",
      "order": 2,
      "count": 40361
    },
    {
      "menuId": 67,
      "characters": "C",
      "order": 3,
      "count": 92199
    },
    {
      "menuId": 68,
      "characters": "D",
      "order": 4,
      "count": 32777
    },
    {
      "menuId": 69,
      "characters": "E",
      "order": 5,
      "count": 43189
    },
    {
      "menuId": 70,
      "characters": "F",
      "order": 6,
      "count": 32648
    },
    {
      "menuId": 71,
      "characters": "G",
      "order": 7,
      "count": 27795
    },
    {
      "menuId": 72,
      "characters": "H",
      "order": 8,
      "count": 32994
    },
    {
      "menuId": 73,
      "characters": "I",
      "order": 9,
      "count": 40778
    },
    {
      "menuId": 74,
      "characters": "J",
      "order": 10,
      "count": 15691
    },
    {
      "menuId": 75,
      "characters": "K",
      "order": 11,
      "count": 8389
    },
    {
      "menuId": 76,
      "characters": "L",
      "order": 12,
      "count": 29370
    },
    {
      "menuId": 77,
      "characters": "M",
      "order": 13,
      "count": 54556
    },
    {
      "menuId": 78,
      "characters": "N",
      "order": 14,
      "count": 25798
    },
    {
      "menuId": 79,
      "characters": "O",
      "order": 15,
      "count": 17261
    },
    {
      "menuId": 80,
      "characters": "P",
      "order": 16,
      "count": 60316
    },
    {
      "menuId": 81,
      "characters": "Q",
      "order": 17,
      "count": 3731
    },
    {
      "menuId": 82,
      "characters": "R",
      "order": 18,
      "count": 35890
    },
    {
      "menuId": 83,
      "characters": "S",
      "order": 19,
      "count": 66957
    },
    {
      "menuId": 84,
      "characters": "T",
      "order": 20,
      "count": 37815
    },
    {
      "menuId": 85,
      "characters": "U",
      "order": 21,
      "count": 16169
    },
    {
      "menuId": 86,
      "characters": "V",
      "order": 22,
      "count": 12007
    },
    {
      "menuId": 87,
      "characters": "W",
      "order": 23,
      "count": 26019
    },
    {
      "menuId": 88,
      "characters": "X",
      "order": 24,
      "count": 363
    },
    {
      "menuId": 89,
      "characters": "Y",
      "order": 25,
      "count": 2942
    },
    {
      "menuId": 90,
      "characters": "Z",
      "order": 26,
      "count": 1863
    }
  ],
  "position 1": [
    {
      "menuId": 6500000,
      "characters": "A",
      "order": 0,
      "count": 60280
    },
    {
      "menuId": 6500065,
      "characters": "AA",
      "order": 1,
      "count": 224
    },
    {
      "menuId": 6500066,
      "characters": "AB",
      "order": 2,
      "count": 1253
    },
    {
      "menuId": 6500067,
      "characters": "AC",
      "order": 3,
      "count": 4187
    },
    {
      "menuId": 6500068,
      "characters": "AD",
      "order": 4,
      "count": 11527
    },
    {
      "menuId": 6500069,
      "characters": "AE",
      "order": 5,
      "count": 537
    },
    {
      "menuId": 6500070,
      "characters": "AF",
      "order": 6,
      "count": 1768
    },
    {
      "menuId": 6500071,
      "characters": "AG",
      "order": 7,
      "count": 1852
    },
    {
      "menuId": 6500072,
      "characters": "AH",
      "order": 8,
      "count": 77
    },
    {
      "menuId": 6500073,
      "characters": "AI",
      "order": 9,
      "count": 955
    },
    {
      "menuId": 6500074,
      "characters": "AJ",
      "order": 10,
      "count": 34
    },
    {
      "menuId": 6500075,
      "characters": "AK",
      "order": 11,
      "count": 264
    },
    {
      "menuId": 6500076,
      "characters": "AL",
      "order": 12,
      "count": 5050
    },
    {
      "menuId": 6500077,
      "characters": "AM",
      "order": 13,
      "count": 4151
    },
    {
      "menuId": 6500078,
      "characters": "AN",
      "order": 14,
      "count": 7982
    },
    {
      "menuId": 6500079,
      "characters": "AO",
      "order": 15,
      "count": 38
    },
    {
      "menuId": 6500080,
      "characters": "AP",
      "order": 16,
      "count": 3372
    },
    {
      "menuId": 6500081,
      "characters": "AQ",
      "order": 17,
      "count": 261
    },
    {
      "menuId": 6500082,
      "characters": "AR",
      "order": 18,
      "count": 6007
    },
    {
      "menuId": 6500083,
      "characters": "AS",
      "order": 19,
      "count": 3696
    },
    {
      "menuId": 6500084,
      "characters": "AT",
      "order": 20,
      "count": 2497
    },
    {
      "menuId": 6500085,
      "characters": "AU",
      "order": 21,
      "count": 3690
    },
    {
      "menuId": 6500086,
      "characters": "AV",
      "order": 22,
      "count": 396
    },
    {
      "menuId": 6500087,
      "characters": "AW",
      "order": 23,
      "count": 146
    },
    {
      "menuId": 6500088,
      "characters": "AX",
      "order": 24,
      "count": 93
    },
    {
      "menuId": 6500089,
      "characters": "AY",
      "order": 25,
      "count": 48
    },
    {
      "menuId": 6500090,
      "characters": "AZ",
      "order": 26,
      "count": 96
    }
  ]
}

For more information on the GET alpha browser menu resource, please refer to our interactive or service reference documentation.