Resource URL
Returns an array of rates.
| Code Block |
|---|
|
GET /rates
ANY /rates?_method=get |
Parameters
Table of allowed paramatersparameters.
| _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 parameter; 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. |
|---|
Fields that can be object indicate the field can be requested as a resource. For example.
| Code Block |
|---|
|
GET /workflows?_fields=owner |
would return the owner's staff id. Where as,
| Code Block |
|---|
|
GET /workflows?_fields=owner(email) |
...
...
Sample Response
| Code Block |
|---|
|
GET /workflowsrates.json?_fields=date_created,owner()standing,charged&_limit=32 |
| Code Block |
|---|
|
{
"response" : [
{
"ownerstanding" : {
"firstname" : "Geoff"inactive",
"idcharged" : "1000150.00",
"surnametitle" : "McQueen"ALi },
"date_created" : "0"test rate",
"id" : "51",
18"
"title" : "Workflow: 0-0-0000"
},
{
"ownerstanding" : {
"firstname" : "Michael"active",
"idcharged" : "9",
"surname" : "Jaques"
}150.00",
"date_created" : "0",
"id" : "60",
"title" : "Workflow: 0-0-0000"
},
{
"owner" : {
"firstname" : "Geoff",
Default",
"id" : "1000",
"surname" : "McQueen"
},
"date_created" : "0",
"id" : "133",
"title" : "Workflow: 0-0-000019"
}
],
"meta" : {
"status" : "ok",
"message" : "Everything executed as expected."
}
} |