Partial Response

Partial Response

The Accela API supports partial response which allows developers to select the fields to be returned in the JSON response.

Usage

In the request URI, add the fields parameter containing comma-separated names of the fields to be returned in the response.

Note: Only the first level field names under the “result” node in Json response are supported.

Note: The field “id” is always returned, whether or not the “id” field name is specified in the “fields” parameter.

Note: Field names are case-sensitive in the “fields” parameter value.

Request Sample

GET https://apis.accela.com/v4/records/?fields=status,openedDate&limit=2

Response Sample

{
   "status": 200,
   "page": {
   "offset": 0,
   "limit": 2,
   "hasmore": true
   },
   "result": [
      {
      "id": "BPTDEV-DUB14-00000-0002E",
      "openedDate": "2014-03-13T07:00:00Z",
      "status": {
      "value": "Received",
      "text": "Received"
      }
      },
      {
      "id": "BPTDEV-DUB14-00000-0002F",
      "openedDate": "2014-03-13T07:00:00Z",
      "status": {
      "value": "Received",
      "text": "Received"
      }
   }
   ]
}