Skip to main content

Get Navigation [GET]

Overview​

Supply a valid token and site name to retrieve you active site navigation JSON data.

Parameters​

ParameterTypeDescription
Tokenstring (query)Token supplied during on-boarding or can be generated from within RCMAdmin.
SiteNamestring (query)This is the site name used to describe your regional version of the website, as supplied in the feeds to RCM.

Example Value​

200 response
{
  "responseTime": "string",
  "token": "string",
  "errors": [
    "string"
  ],
  "navigation": {
    "navigationName": "string",
    "navigationItems": [
      {
        "navigationId": 0,
        "title": "string",
        "url": "string",
        "position": 0,
        "navigationLinks": [
          {
            "navigationLinkId": 0,
            "parentNavigationLinkId": 0,
            "navigationId": 0,
            "title": "string",
            "column": 0,
            "position": 0,
            "url": "string",
            "image": "string",
            "isHeader": true,
            "bold": true,
            "italic": true,
            "underline": true,
            "navigationLinks": [
              null
            ]
          }
        ]
      }
    ]
  },
  "trackingData": {
    "pageId": 0,
    "ruleId": 0
  }
}

Response​

Description:
navigation returned

200 response
{
  "success": true,
  "errors": [
    "string"
  ],
  "importTaskId": 0
}