Pagination
Accela API supports offset-based pagination.
The following are the parameters used in HTTP request.
Paging Request Parameter | Description |
---|---|
offset |
The offset start of each page by the number specified. Start offset: 0 Default offset: 0 |
limit |
The number of items that are returned in each page. Note this is an upper limit; if there are not enough items to return, less than this number is returned. Default limit: 25 Max limit: 1000 |
Request Sample
GET https://apis.accela.com/v4/records/?offset=0&limit=5
The following is the response paging information.
Paging Key | Description |
---|---|
hasMore | true if there are more items available beyond current paged response. |
offset |
The requested offset value. |
limit |
The requested limit value. |
Response Sample
See the page response information at the bottom of the following example:
{
"result": [
{
"name": "CityScan Service Request",
"id": "ISLANDTON-14CAP-00000-000BR",
"type": {
"module": "ServiceRequest",
"type": "Buildings and Property",
"value": "ServiceRequest/Buildings and Property/Working Without Permit/NA",
"category": "NA",
"text": "Working Without Permit",
"group": "ServiceRequest",
"subType": "Working Without Permit",
"id": "ServiceRequest-Buildings.cand.cProperty-Working.cWithout.cPermit-NA"
},
"description": "6",
"status": {
"value": "Submitted",
"text": "Submitted"
},
"undistributedCost": 0,
"serviceProviderCode": "ISLANDTON",
"statusDate": "2014-08-04 08:04:43",
"totalJobCost": 0,
"shortNotes": "CityScan Service Request",
"initiatedProduct": "AV360",
"createdBy": "DEVELOPER",
"module": "ServiceRequest",
"customId": "SR-2014-00151",
"recordClass": "COMPLETE",
"openedDateFrom": "2014-08-04 00:00:00",
"trackingId": 287524530,
"value": "14CAP-00000-000BR",
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
},
{
"name": "CityScan Service Request",
"id": "ISLANDTON-14CAP-00000-000BY",
"type": {
"module": "ServiceRequest",
"type": "Buildings and Property",
"value": "ServiceRequest/Buildings and Property/Fence Dispute/NA",
"category": "NA",
"text": "Fence Dispute",
"group": "ServiceRequest",
"subType": "Fence Dispute",
"id": "ServiceRequest-Buildings.cand.cProperty-Fence.cDispute-NA"
},
"description": "7",
"status": {
"value": "Submitted",
"text": "Submitted"
},
"undistributedCost": 0,
"serviceProviderCode": "ISLANDTON",
"statusDate": "2014-08-04 08:09:25",
"totalJobCost": 0,
"shortNotes": "CityScan Service Request",
"initiatedProduct": "AV360",
"createdBy": "DEVELOPER",
"module": "ServiceRequest",
"customId": "SR-2014-00158",
"recordClass": "COMPLETE",
"openedDateFrom": "2014-08-04 00:00:00",
"trackingId": 214338233,
"value": "14CAP-00000-000BY",
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
},
{
"name": "CityScan Service Request",
"id": "ISLANDTON-14CAP-00000-000BW",
"type": {
"module": "ServiceRequest",
"type": "Signage",
"value": "ServiceRequest/Signage/Illegal Sign/NA",
"category": "NA",
"text": "Illegal Sign",
"group": "ServiceRequest",
"subType": "Illegal Sign",
"id": "ServiceRequest-Signage-Illegal.cSign-NA"
},
"description": "16",
"status": {
"value": "Submitted",
"text": "Submitted"
},
"undistributedCost": 0,
"serviceProviderCode": "ISLANDTON",
"statusDate": "2014-08-04 08:09:18",
"totalJobCost": 0,
"shortNotes": "CityScan Service Request",
"initiatedProduct": "AV360",
"createdBy": "DEVELOPER",
"module": "ServiceRequest",
"customId": "SR-2014-00156",
"recordClass": "COMPLETE",
"openedDateFrom": "2014-08-04 00:00:00",
"trackingId": 211450606,
"value": "14CAP-00000-000BW",
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
},
{
"name": "CityScan Service Request",
"id": "ISLANDTON-14CAP-00000-000BT",
"type": {
"module": "ServiceRequest",
"type": "Buildings and Property",
"value": "ServiceRequest/Buildings and Property/Junk on Property/NA",
"category": "NA",
"text": "Junk on Property",
"group": "ServiceRequest",
"subType": "Junk on Property",
"id": "ServiceRequest-Buildings.cand.cProperty-Junk.con.cProperty-NA"
},
"description": "23",
"status": {
"value": "Submitted",
"text": "Submitted"
},
"undistributedCost": 0,
"serviceProviderCode": "ISLANDTON",
"statusDate": "2014-08-04 08:08:45",
"totalJobCost": 0,
"shortNotes": "CityScan Service Request",
"initiatedProduct": "AV360",
"createdBy": "DEVELOPER",
"module": "ServiceRequest",
"customId": "SR-2014-00153",
"recordClass": "COMPLETE",
"openedDateFrom": "2014-08-04 00:00:00",
"trackingId": 247605157,
"value": "14CAP-00000-000BT",
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
},
{
"name": "CityScan Service Request",
"id": "ISLANDTON-14CAP-00000-000BX",
"type": {
"module": "ServiceRequest",
"type": "Signage",
"value": "ServiceRequest/Signage/Illegal Sign/NA",
"category": "NA",
"text": "Illegal Sign",
"group": "ServiceRequest",
"subType": "Illegal Sign",
"id": "ServiceRequest-Signage-Illegal.cSign-NA"
},
"description": "11",
"status": {
"value": "Submitted",
"text": "Submitted"
},
"undistributedCost": 0,
"serviceProviderCode": "ISLANDTON",
"statusDate": "2014-08-04 08:09:22",
"totalJobCost": 0,
"shortNotes": "CityScan Service Request",
"initiatedProduct": "AV360",
"createdBy": "DEVELOPER",
"module": "ServiceRequest",
"customId": "SR-2014-00157",
"recordClass": "COMPLETE",
"openedDateFrom": "2014-08-04 00:00:00",
"trackingId": 210759724,
"value": "14CAP-00000-000BX",
"totalFee": 0,
"totalPay": 0,
"balance": 0,
"booking": false,
"infraction": false,
"misdemeanor": false,
"offenseWitnessed": false,
"defendantSignature": false,
"publicOwned": false
}
],
"status": 200,
"page": {
"offset": 0,
"limit": 5,
"hasmore": true
}
}