Announcement Categories

Non-hierarchical taxonomy used to categorize announcements.

Get a collection

GET /announcement_categories HTTP/1.1

Query string parameters

All query string parameters are optional.

callback string

Wraps the response in a callback function of the given name. Use this parameter to facilitate JSONP requests.

excluded_ids comma-separated list of IDs

Returns announcement categories, except those with the given IDs.

ids comma-separated list of IDs

Return announcement categories with the given IDs.

order_by comma-separated list

Sort announcement categories by one or more ORDER_BY and ORDER parameter pairs. Options:

• ORDER:
  • asc: order from lowest to highest values
  • desc: order from highest to lowest values
• ORDER_BY:
  • id: order by announcement category ID
  • list: order by the order of IDs given in the ids parameter
  • name: order by term name
  • weight: order by term weight

Format: ORDER_BY|ORDER[,ORDER_BY|ORDER,...]

Default value: name|asc

page integer

Return announcement categories from a specific page of a collection.

Default value: 1

per_page integer

Number of announcement categories to return per page of a collection. Maximum: 100

Default value: 5

slug comma-separated list

Return announcement categories matching the given slug(s).

Response

In the example response, embedded announcement categories are truncated for illustrative purposes. In the real-world version of the response, "...announcement category object..." is an entire announcement category resource.

{
   "_embedded": {
      "announcement_categories": [
         "...announcement category object...",
         "...announcement category object...",
         "...announcement category object...",
         "...announcement category object...",
         "...announcement category object..."
      ]
   },
   "_links": {
      "find": {
         "href": "/announcement_categories/{?id}",
         "templated": true
      },
      "next": {
         "href": "/announcement_categories?page=3"
      },
      "prev": {
         "href": "/announcement_categories?page=1"
      },
      "self": {
         "href": "/announcement_categories?page=2"
      }
   },
   "page": 1,
   "per_page": 5,
   "return_count": 5,
   "total_available": 100
}

Attributes

_embedded hash

Embedded resources.

Toggle child attributes

_embedded.announcement_categories[] array

An array of announcement category objects.

_links hash

Links to resources associated with the announcement category collection.

Toggle child attributes

_links.find link object

A templated link that can be used to find a specific resource in the collection.

Toggle child attributes

_links.find.href string

URI of the link.

_links.find.templated boolean

Identifies the href as a templated URI.

_links.next link object

A link to the next set of resources in the collection. If there is not a next page, this link will not be present.

Toggle child attributes

_links.next.href string

URI of the link.

_links.prev link object

A link to the previous set of resources in the collection. If there is not a previous page, this link will not be present.

Toggle child attributes

_links.prev.href string

URI of the link.

_links.self link object

A link that identifies the current resource.

Toggle child attributes

_links.self.href string

URI of the link.

page integer

The page number of the returned collection.

per_page integer

The number of announcement categories requested per page.

return_count integer

Number of announcement categories returned.

total_available integer

Total number of announcement categories available in the collection.

Get one

GET /announcement_categories/:id HTTP/1.1

Endpoint parameters

id integer required

The unique identifier of the announcement category.

Response

{
   "_embedded": {},
   "_links": {
      "self": {
         "href": "/announcement_categories/3323"
      }
   },
   "id": 3323,
   "name": "Health+Wellness",
   "slug": "health-wellness",
   "type": "announcement_category"
}

Attributes

_embedded hash

Embedded resources.

_links hash

Links to resources associated with the announcement category.

Toggle child attributes

_links.self link object

A link that identifies the current resource.

Toggle child attributes

_links.self.href string

URI of the link.

id integer

Unique identifier of the announcement category.

name string

The nice name of the announcement category.

slug string

The name of the announcement category used in URLs.

type string

Type of resource.

Get a subcollection

A subcollection is a collection of objects contained within an announcement category.

GET /announcement_categories/:id/:subcollection HTTP/1.1

Endpoint parameters

id integer

The unique identifier of the announcement category.

subcollection string

The name of the subcollection to retrieve. Options: announcements

Query string parameters

To filter the subcollection, see the list of available parameters associated with the chosen subcollection:

• announcements

Response

See the response associated with the chosen subcollection:

• announcements