/get/region/{id} - Get region by ID

Overview

The /get/region/{id} endpoint retrieves detailed information about a specific geographic region by its ID.

Purpose

• Fetch region information including title, description, and metadata
• Get list of resorts within the region
• Access region images and branding
• Retrieve region icon for UI display

Endpoint

GET /get/region/{id}

Parameters

Path parameters

id (string, required)

The region's WordPress ID. Can be provided with or without the "1_" prefix.

Formats:

• {wp_id} - WordPress ID only (e.g., "123")
• 1_{wp_id} - Legacy format with site prefix (e.g., "1_123")

Examples:

• id=123 - Region with WordPress ID 123
• id=1_123 - Same region using legacy format (prefix is stripped)

Validation: Must be numeric or in format "1{number}". The "1" prefix is automatically removed if present.

---

Query parameters

sourceFields (string, optional)

Return only specific fields from the _source object using dot notation (comma-separated).

Purpose: Optimize response payload size by requesting only needed fields

Examples:

• sourceFields=title,subtitle,description
• sourceFields=title,resorts
• sourceFields=title,images,region_icon

---

Response format

Success response structure

{
  "_index": "fnugg_blog",
  "_type": "region",
  "_id": "1_123",
  "_version": 1,
  "found": true,
  "_source": {
    "id": 123,
    "title": "Trysil",
    "subtitle": "Norges største alpinområde",
    "description": "Trysil er den mest populære skidestinasjon i Norge med over 70 nedfarter og moderne fasiliteter...",
    "type": "region",
    "resorts": [14, 89, 102],
    "images": [
      {
        "url": "https://example.com/region-image.jpg",
        "caption": "Utsikt over Trysil",
        "width": 1920,
        "height": 1080
      }
    ],
    "region_icon": {
      "url": "https://example.com/icons/trysil-icon.svg",
      "type": "svg"
    },
    "automatic": ""
  }
}

Error response (not found)

{
  "error": "Region with ID '999' was not found.",
  "error_key": "region_not_found",
  "id": "999"
}

---

Response fields

Top level fields

• _index (string): Index name, always "fnugg_blog"
• _type (string): Type name, always "region"
• _id (string): Region's ID in format "1_{wp_id}"
• _version (integer): Document version, always 1
• found (boolean): Whether region was found, always true on success
• _source (object): The region data object

_source fields

Basic information

• id (integer): Region's WordPress ID (without "1_" prefix)
• title (string): Region name
• subtitle (string): Short descriptive tagline
• description (string): Full description of the region
• type (string): Content type, always "region"

Related Data

• resorts (array): Array of resort site_ids within this region
  • Each element is an integer representing a resort's site_id

Media

• images (array): Region photos

  • Each object may contain: url (string), caption (string), width (integer), height (integer)

• region_icon (object): Region icon/logo for branding

  • url (string): Icon file URL
  • type (string): File type (e.g., "svg", "png")

Legacy Fields

• automatic (string): Legacy field, always empty string

---

Example requests

Get complete region data

GET /get/region/123

Returns all fields for region with WordPress ID 123.

---

Get region with legacy ID format

GET /get/region/1_123

Returns same result as above (the "1_" prefix is automatically stripped).

---

Get region with specific fields only

GET /get/region/123?sourceFields=title,subtitle,resorts

Returns only title, subtitle, and list of resort IDs.

---

Get region basic info

GET /get/region/123?sourceFields=title,description,images

Returns basic information with images for display purposes.

---

Use cases

1. Display region detail page: Fetch complete region data for a detail view
2. List resorts by region: Use the resorts array to fetch all resorts in a region
3. Region navigation: Use sourceFields=title,subtitle,region_icon for navigation menus
4. Regional statistics: Combine with resort data using the resorts array
5. SEO metadata: Use sourceFields=title,description,images for page metadata
6. Region comparison: Fetch multiple regions with filtered fields

---

Notes

• The id parameter accepts both formats: 123 or 1_123 (legacy format)
• The "1_" prefix is always stripped if provided, as all regions belong to site_id 1
• Regions not found will return a 200 status with error object
• The resorts array contains site_ids that can be used with /get/resort/{id} or /search?include=...
• The images array may be empty if the region has no images
• The region_icon is used for branding and UI purposes (logos, navigation icons)
• The automatic field is a legacy field and always contains an empty string
• The subtitle provides a short tagline or description suitable for preview cards
• The description field may contain HTML markup depending on the source content
• The sourceFields parameter uses dot notation to access nested fields (e.g., region_icon.url)