Build Version:

GET highlighttypes

Gets a list of highlight types.

Request Information

» Filters

Name	Description	Usage
name	This will filter the request by name.	GET highlighttypes?filter=name~{operator}~{value}

» Sorting

Name	Description	Usage
highlightTypeId	This will sort the response by highlight type ID.	GET highlighttypes?sort=highlighttypeid
name	This will sort the response by name.	GET highlighttypes?sort=name

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET highlighttypes?page=index~{value}
size	The size of the page when retrieving paged results.	GET highlighttypes?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "HighlightTypes": [
    {
      "Description": "Default Highlight",
      "HighlightTypeId": 1,
      "Name": "Default Highlight"
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}