Permalink
Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
94 lines (61 sloc) 2.07 KB

Categories (Tasks, Deals)

The categories API is identical for both Task categories, and Deal categories, with the only difference being the URL. For Task categories, the API should be prefixed with task_categories, and for Deal categories, deal_categories. In the documentation that follows, the generic #{type}_categories will be used, but you should replace that with the category collection you wish to query.

For the full XML representation of categories, check out the data reference.

Get category

  • GET /#{type}_categories/#{id}.xml return a single category record.

Response:

<#{type}-category>
  <id type="integer"></id>
  <name></name>
  <color></color>
  <account-id type="integer"></account-id>
  <created-at type="datetime"></created-at>
  <updated-at type="datetime"></updated-at>
  <elements-count type="integer"></elements-count>
</#{type}-category>

Get categories

  • GET /#{type}_categories.xml returns all categories.

Response:

<#{type}-categories type="array">
  <#{type}-category>
    ...
  </#{type}-category>
  ...
</#{type}-categories>

Create category

  • POST /#{type}_categories.xml create a new category.

Request:

<#{type}-category>
  <name>#{name}</name>
  <color>#{hex-color}</color>
</#{type}-category>

Color is optional. If provided, it should be a web color in hexadecimal format, e.g., ffcc33. Defaults to 000000 (black).

Response:

Status: 201 Created
Location: https://example.highrisehq.com/#{type}_categories/#{new-id}.xml

Update category

  • PUT /#{type}_categories/#{id}.xml update (rename) an existing category

Request:

<#{type}-category>
  <name>#{name}</name>
</#{type}-category>

Response:

Status: 200 OK

Destroy category

  • DELETE /#{type}_categories/#{id}.xml destroys a category.

Response:

Status: 200 OK