STstarcitizenwiki
Comm-Links

Comm-Link Search (Deprecated)

Changed on

Deprecated. Use GET /api/comm-links?filter[title]={value} for title search. This endpoint will be removed in a future version.

post/api/comm-links/search

Request

  • Base URL
    https://api.star-citizen.wiki
  • URL
    https://api.star-citizen.wiki/api/comm-links/search
  • Auth
    none declared

Query parameters

localestring

Locale code for translated fields. Supported values depend on available translations (e.g. en, de, zh).

includestring[]

Available Comm-Link includes

filter[channel]string
Example:Engineering

Exact match on channel name (see GET /api/comm-links/filters for valid values)

filter[series]string
Example:Around the Verse

Exact match on series name (see GET /api/comm-links/filters for valid values)

filter[category]string
Example:General

Exact match on category name (see GET /api/comm-links/filters for valid values)

Request body

keywordstring

Search term for partial title match (min 3 characters)

querystring

Search term for partial title match or numeric CIG ID (min 1 character)

Example request

{
  "keyword": "Banu Merchantman",
  "query": "This Week in Star Citizen"
}

Response

Search results for Comm-Links

Example response

{
  "data": [
    {
      "id": 12663,
      "title": "This Week in Star Citizen",
      "channel": "Engineering",
      "category": "General",
      "series": "Around the Verse",
      "images": [
        {
          "name": "Starshipbridge.jpg",
          "rsi_url": "/media/bluo97w6u7n1ur/source/Starshipbridge.jpg",
          "size": 1504015,
          "mime_type": "image/jpeg"
        }
      ],
      "images_count": 5,
      "links": [
        {
          "href": "http://robertsspaceindustries.com/forums/",
          "text": "forums"
        }
      ],
      "links_count": 3,
      "comment_count": 42,
      "created_at_human": "1 hour ago"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 30,
    "to": 30,
    "total": 150,
    "path": "https://api.star-citizen.wiki/api/vehicles"
  }
}

Changes

  • 778c43a31df2Revision changes
    • info

      added the optional property /// to the response with the status

  • af03a6ba771dRevision changes
    • breaking

      the response's property type changed from array to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id 2efd50e02ba871c509078dcf08701557 removed and replaced with searchCommLinksDeprecated

    • info

      api tag RSI-Website removed

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status