...
| _limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
|---|
| _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 parameter; see included examples. Underlined values are default.
| id | unsigned int | |
|---|
| name | string | |
|---|
| website | string | |
|---|
| standing | string | |
|---|
| status | unsigned int or object | |
|---|
| phone | string | |
|---|
| fax | string | |
|---|
| date_created | unsigned int | |
|---|
| date_modified | unsigned int | |
|---|
| comments | string | |
|---|
| contact | unsigned int or object | |
|---|
...
Sample Response
| Code Block |
|---|
|
GET /companies.json?_fields=contact |
would return the contacts id. Where as,
| Code Block |
|---|
|
GET /companies.json?_fields=contact() |
would return the contact's object, including any optional fields or objects within the parenthesis.
Sample Response
| Code Block |
|---|
|
GET /companiesfilters/4/run.json?_fields=contactaffiliation(status),standing&_limit=2 |
| Code Block |
|---|
|
{
"responsemeta" : [
{
"namemore_info" : "ADTOAhttps://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok",
"contactmessage" : {"Everything executed as expected.",
"emailstatus" : "rpepper@ihug.com.au"ok"
},
"response": [
"firstname" : "Ronald",{
"idaffiliation": {
: "1", "mobile" : "1234"0425,
239 666", "surnamestatus" : "Pepper IHUG"
1",
}, "standingid" : "active1",
"idemail" : "1email@example.com"
}, },
{ "nameid" : "1"Balgownie,
Veterinary Hospital", "name": "contactname a"
: { },
"email" : "mark@balgownievet.com.au", {
"firstnamename" : "Markname b",
"id" : "2",
"mobileaffiliation": {
: "", "surnameid" : "Allison2"
,
}, "standingemail" : "activeemail@example.com",
"id" : "2" }"status": "1",
], "meta" : { "more_infomobile" : "/public_api/docs/status/ok","
"status" : "ok", }
"message" : "Everything executed as}
expected." }]
} |