Resource URL

/rates

Parameters

Table of allowed paramaters.

_page	unsigned int	The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limit	unsigned int	The maximum number of resources to return. Default is 10 and maximum is 50.
_offset	unsigned int	The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with `_page`.
_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields paramater; see included examples.

id	unsigned int	Unique identifier for the rate.
title	string	The rate title
charged	double	The amount charged.
standing	string	The rates standing status. This can be: active or inactive.
object	string	The object of the rate. This can be: staff, issue, component, job or contract_period.

Sample Response

GET /rates.json?_fields=standing,charged&_limit=2

{
   "response" : [
      {
         "standing" : "inactive",
         "charged" : "150.00",
         "title" : "ALi test rate",
         "id" : "18"
      },
      {
         "standing" : "active",
         "charged" : "150.00",
         "title" : "Default",
         "id" : "19"
      }
   ],
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}