Highrise API

Cases

Cases use "kase" and "kases" in the XML to work around the problem of "case" being a reserved word in Ruby.

Show

GET /kases/#{id}.xml

Returns an existing case. If closed-at is set, it means that the case is closed. If it's not set, it's still open.

Response

Status: 200 OK

<kase>
  <id type="integer">1</id>
  <author-id type="integer"></author-id>
  <closed-at type="datetime"></closed-at>
  <created-at type="datetime"></created-at>
  <updated-at type="datetime">2007-03-19T22:34:22Z</updated-at>
  <name>A very important matter</name>
  <visible-to>Everyone</visible-to>
  <group-id type="integer"></group-id>
  <owner-id type="integer"></owner-id>
</kase>

List Open

GET /kases/open.xml

Returns a collection of cases that are visible to the authenticated user and have not been closed.

Response

Status: 200 OK

<kases>
  <kase>
    ...
  </kase>
  <kase>
    ...
  </kase>
</kases>

List Closed

GET /kases/closed.xml

Returns a collection of cases that are visible to the authenticated user and have been closed.

Response

Status: 200 OK

<kases>
  <kase>
    ...
  </kase>
  <kase>
    ...
  </kase>
</kases>

Create

POST /kases.xml

Creates a new case with the currently authenticated user as the author. By default, a new case is assumed to be visible to Everyone. You can also chose to make the company only visible to the creator using "Owner" as the value for the visible-to tag. Or "NamedGroup" and pass in a group-id tag too. If the account doesn't allow for more cases to be created, a "507 Insufficient Storage" response will be returned.

Request


<kase>
  <name>Another very important matter</name>
</kase>

Response

Status: 201 Created
Location: http://example.highrisehq.com/kases/#{new-kase-id}.xml

<kase>
  ...
</kase>

Update

PUT /kases/#{id}.xml

Updates an existing person with new details from the submitted XML. Contact data that includes an id will be updated, contact data that doesn't will be assumed to be new and created from scratch. A case is closed when the closed-at tag is passed.

Request

<kase>
  <name>Another very important matter</name>
  <closed-at type="datetime">2007-03-19T22:34:22Z</closed-at>
</kase>

Response

Status: 200 OK

Destroy

DELETE /kases/#{id}.xml

Destroys the case at the referenced URL.

Response

Status: 200 OK