Show Search Result REST Endpoint

Ben Tiedt — Tue, 19 Nov 2019 20:24:45 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:24:45

URLs

GET api.ashx/v2/search/{id}.xml (or .json)

SHOW a search result.

Request Parameters

Name	Type	Description	Required	Default	Options
Id	`string`	Id	Required

Example Requests

C# REST SDK

This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.

var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.GetToDynamic(2, "search/{id}.json", false, new RestGetOptions {
	PathParameters = new System.Collections.Specialized.NameValueCollection {
		{ "id", "id" }
	}
});

Widget Javascript

This example uses the [[rest JavaScript API Module|rest JavaScript API]] to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/search/{id}.json',
	data: { 
		'id': 'id'
	},
	success: function(response) {

	}
});

cURL

This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.

curl -H "Rest-User-Token: ENCODED_TOKEN" -X GET https://mysite.com/api.ashx/v2/search/id.xml

Example Responses

JSON

{
  "SearchResult": {
    "Id": "id",
    "ContentId": "contentid",
    "Title": "title",
    "Url": "url",
    "Date": "2012-01-04T00:00:00",
    "ContentType": "contenttype",
    "Body": "body",
    "BestMatch": "bestmatch",
    "BestMatchTitle": "bestmatchtitle",
    "SearchFields": [
      {
        "Name": "name",
        "Value": "value"
      },
      {
        "Name": "name",
        "Value": "value"
      }
    ],
    "SectionId": 6,
    "ThreadId": 25,
    "WikiId": 8,
    "Tags": [
      {
        "Value": "value"
      },
      {
        "Value": "value"
      }
    ],
    "Group": {
      "AvatarUrl": "avatarurl",
      "DateCreated": "2012-05-02T00:00:00",
      "Description": "description",
      "Key": "key",
      "Name": "name",
      "ParentGroupId": 4,
      "Url": "url",
      "TotalMembers": 7,
      "HasGroups": true,
      "GroupCount": 27,
      "GroupType": "grouptype",
      "EnableGroupMessages": true,
      "EnableContact": true,
      "SearchUniqueId": "searchuniqueid",
      "IsEnabled": true,
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
      "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
      "Container": {
        "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
        "HtmlName": "htmlname",
        "Url": "url",
        "AvatarUrl": "avatarurl"
      },
      "Id": 32
    },
    "Users": [
      {
        "MembershipType": "membershiptype",
        "IsDirectMember": true,
        "IsRoleMember": true,
        "Group": {
          "AvatarUrl": "avatarurl",
          "DateCreated": "2012-06-04T00:00:00",
          "Description": "description",
          "Key": "key",
          "Name": "name",
          "ParentGroupId": 52,
          "Url": "url",
          "TotalMembers": 19,
          "HasGroups": true,
          "GroupCount": 112,
          "GroupType": "grouptype",
          "EnableGroupMessages": true,
          "EnableContact": true,
          "SearchUniqueId": "searchuniqueid",
          "IsEnabled": true,
          "ExtendedAttributes": [
            {
              "Key": "key",
              "Value": "value"
            },
            {
              "Key": "key",
              "Value": "value"
            }
          ],
          "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
          "Container": {
            "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
            "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
            "HtmlName": "htmlname",
            "Url": "url",
            "AvatarUrl": "avatarurl"
          },
          "Id": 61
        },
        "AvatarUrl": "avatarurl",
        "DisplayName": "displayname",
        "ProfileUrl": "profileurl",
        "Username": "username",
        "CurrentStatus": {
          "Author": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 18,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "e3715662-2528-4ba1-84a7-bfcd9d548f80"
            },
            "Id": 76
          },
          "Body": "body",
          "CreatedDate": "2011-05-28T00:00:00",
          "ReplyCount": 6,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2011-12-09T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 25,
            "Url": "url",
            "TotalMembers": 8,
            "HasGroups": true,
            "GroupCount": 4,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
              "ContainerTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 7
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
          "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
          "Url": "url",
          "IsPublished": true,
          "Content": {
            "CreatedByUser": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
            "ContentTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
            "CreatedDate": "2012-03-29T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
              "ApplicationTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "6cdcf200-3bad-476d-af45-97b52545c337"
        },
        "Id": 27
      },
      {
        "MembershipType": "membershiptype",
        "IsDirectMember": true,
        "IsRoleMember": true,
        "Group": {
          "AvatarUrl": "avatarurl",
          "DateCreated": "2012-04-19T00:00:00",
          "Description": "description",
          "Key": "key",
          "Name": "name",
          "ParentGroupId": 32,
          "Url": "url",
          "TotalMembers": 52,
          "HasGroups": true,
          "GroupCount": 19,
          "GroupType": "grouptype",
          "EnableGroupMessages": true,
          "EnableContact": true,
          "SearchUniqueId": "searchuniqueid",
          "IsEnabled": true,
          "ExtendedAttributes": [
            {
              "Key": "key",
              "Value": "value"
            },
            {
              "Key": "key",
              "Value": "value"
            }
          ],
          "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
          "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
          "Container": {
            "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
            "ContainerTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
            "HtmlName": "htmlname",
            "Url": "url",
            "AvatarUrl": "avatarurl"
          },
          "Id": 112
        },
        "AvatarUrl": "avatarurl",
        "DisplayName": "displayname",
        "ProfileUrl": "profileurl",
        "Username": "username",
        "CurrentStatus": {
          "Author": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 61,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
            },
            "Id": 18
          },
          "Body": "body",
          "CreatedDate": "2012-01-16T00:00:00",
          "ReplyCount": 76,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2012-01-04T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 6,
            "Url": "url",
            "TotalMembers": 25,
            "HasGroups": true,
            "GroupCount": 8,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 4
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
          "Url": "url",
          "IsPublished": true,
          "Content": {
            "CreatedByUser": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
            "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
            "CreatedDate": "2012-05-02T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
              "ApplicationTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "fe65240b-044c-4292-9946-f10e0361ecff"
        },
        "Id": 7
      }
    ],
    "IndexedAt": "2012-06-04T00:00:00",
    "GuidId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
    "ApplicationId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
    "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
    "ContentTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
    "IsContent": true,
    "IsApplication": true,
    "IsContainer": true,
    "ViewHtml": "viewhtml",
    "PreviewHtml": "previewhtml",
    "Content": {
      "CreatedByUser": {
        "AvatarUrl": "avatarurl",
        "DisplayName": "displayname",
        "ProfileUrl": "profileurl",
        "Username": "username",
        "CurrentStatus": {
          "Author": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 27,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "6cdcf200-3bad-476d-af45-97b52545c337",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "6cdcf200-3bad-476d-af45-97b52545c337"
            },
            "Id": 32
          },
          "Body": "body",
          "CreatedDate": "2011-05-28T00:00:00",
          "ReplyCount": 52,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2011-12-09T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 19,
            "Url": "url",
            "TotalMembers": 112,
            "HasGroups": true,
            "GroupCount": 61,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
              "ContainerTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 18
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
          "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
          "Url": "url",
          "IsPublished": true,
          "Content": {
            "CreatedByUser": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
            "ContentTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
            "CreatedDate": "2012-03-29T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
              "ApplicationTypeId": "6cdcf200-3bad-476d-af45-97b52545c337",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4"
        },
        "Id": 76
      },
      "ContentId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
      "ContentTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
      "CreatedDate": "2012-04-19T00:00:00",
      "HtmlName": "htmlname",
      "HtmlDescription": "htmldescription",
      "Url": "url",
      "AvatarUrl": "avatarurl",
      "Application": {
        "ApplicationId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "ApplicationTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
        "HtmlName": "htmlname",
        "HtmlDescription": "htmldescription",
        "Url": "url",
        "AvatarUrl": "avatarurl",
        "Container": {
          "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "ContainerTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        }
      }
    }
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}