Bedful Tags

Tags represent categories on the bedful booking system. They are sometimes used for filtering units or sites. Each site or unit can have many tags, and you'll find them listed on the site record when you expand it. You can also fetch tag information separately if required.

Get Tag

Use GET /tags/:id to fetch information on one tag.

curl https://devapi.bedful.com/tags/1 \
-u BEDFUL_KEY: 

Parameters available

• id : specified in the url

This will return JSON like this for the matched tag, or a 404 error if no tag is found for the given id.

 {
  "id": 1,
  "parent_id": 0,
  "dotted_ids": "1",
  "name": "Geography",
  "summary": "Geography",
  "keywords": "keywords",
  "display_order": 1,
  "url": "geography"
}

Tag Fields

• ID: The unique id of the tag
• ParentID: the id of the parent tag (0 if none)
• DottedIDs: A string representation of the tag hierarchy above this tag
• Name: The name of the tag
• Summary: A description of the tag
• Keywords: Words to match in searches
• Display Order: The order this tag is to be presented in
• URL: The url fragment used to construct tag URLs

Get Tags

Use GET /tags to fetch information on more than one tag.

curl https://devapi.bedful.com/tags \
-u BEDFUL_KEY: 

Parameters available

• url : filter on the tag url fragment
• parent_id: filter on the parent id of the tag
• root_tag_id: filter on the highest ancestor of this tag
• id: filter on multiple tag ids (comma separated)

This will return JSON like this for the matched tags, or an empty list if no tags are found.

{
  "tags": [
  {
  "id": 2,
  "parent_id": 0,
  "dotted_ids": "2",
  "name": "Kind",
  "summary": "Category",
  "keywords": "",
  "display_order": 1,
  "url": "category"
  }, {
  "id": 1,
  "parent_id": 0,
  "dotted_ids": "1",
  "name": "Geography",
  "summary": "Geography",
  "keywords": "",
  "display_order": 1,
  "url": "geography"
  }
  ], 
  "parent_tags": []
}