Trips

The Trip Object

You can save trip categories for reuse in statements.

EXAMPLE OBJECT

{
  "trip_category": {
    "id": 12,
    "name": "Travelling",
    "rate": "10.0",
    "formatted_rate": "10.00",
    "created_at": "2014-07-21T11:04:58Z"
  }
}

Attributes

Create a New Trip

DEFINITION
POST https://[subdomain].hiveage.com/api/categories/trips

EXAMPLE JSON REQUEST
$ curl https://[subdomain].hiveage.com/api/categories/trips\
  -H "Accept: application/json" \
  -u 6ZQHxidcLHnkcsnDbfM5: \
  -d trip_category[name]="Travelling" \
  -d trip_category[rate]="10.00" \


EXAMPLE RESPONSE
{
  "trip_category": {
    "id": 12,
    "name": "Travelling",
    "rate": "10.0",
    "formatted_rate": "10.00",
    "created_at": "2014-07-21T11:04:58Z"
  }
}

Attributes

Return

Returns the trip object.

Retrieve a Trip

Retrieve a trip object with a specified ID.

DEFINITION
GET https://[subdomain].hiveage.com/api/categories/trips/[id]

EXAMPLE JSON REQUEST
$ curl https://[subdomain].hiveage.com/api/categories/trips/[id]\
  -H "Accept: application/json" \
  -u 6ZQHxidcLHnkcsnDbfM5: \

EXAMPLE RESPONSE
{
  "trip_category": {
    "id": 12,
    "name": "Travelling",
    "rate": "10.0",
    "formatted_rate": "10.00",
    "created_at": "2014-07-21T11:04:58Z"
  }
}

Arguments

Returns

Returns a trip JSON object if a valid trip category ID was provided. Returns an error otherwise.

Update a Trip

Update a trip category.

DEFINITION
PUT https://[subdomain].hiveage.com/api/categories/trips/[id]

EXAMPLE JSON REQUEST
$ curl https://[subdomain].hiveage.com/api/categories/trips/[id]\
  -H "Accept: application/json" \
  -u 6ZQHxidcLHnkcsnDbfM5: \
  -d trip_category[name]="Development" \
  -d trip_category[rate]="20.0" \

EXAMPLE RESPONSE
{
  "trip_category": {
    "id": 12,
    "name": "Travelling",
    "rate": "20.0",
    "formatted_rate": "10.00",
    "created_at": "2014-07-21T11:04:58Z"
  }
}

Arguments

Returns

Returns a updated trip JSON object if a valid trip ID was specified. Returns an error otherwise.

Delete a Trip

Deleting a trip object permanently.

DEFINITION
DELETE https://[subdomain].hiveage.com/api/categories/trips/[id]

EXAMPLE REQUEST
$ curl https://[subdomain].hiveage.com/api/categories/trips/[id]\
  -H "Accept: application/json" \
  -u 6ZQHxidcLHnkcsnDbfM5: \

SAMPLE JSON RESPONSE
{
  "trip_category": {
    "deleted": true,
    "id": "13"
  }
}

Arguments

Returns an object with a deleted parameter on success.

List All Trips

Returns a list of trips. The trips are returned sorted alphabetically.

DEFINITION
GET https://[subdomain].hiveage.com/api/categories/trips

EXAMPLE REQUEST
$ curl https://[subdomain].hiveage.com/api/categories/trips\
  -H "Accept: application/json" \
  -u 6ZQHxidcLHnkcsnDbfM5: \

SAMPLE JSON RESPONSE
{
  "trip_categories": [{
    "id": 13,
    "name": "Travelling",
    "rate": "20.0",
    "formatted_rate": "10.00",
    "created_at": "2014-07-21T11:04:58Z"
  }
  {...},
  {...}]
}

The results will be paginated. You can use the following optional parameters to traverse the results.

Arguments