infoodle

Poll for new form entries

GET /formentries/poll/{fromthisid}/{returncount}
O auth2

Poll for new form entries where the ID is greater than the supplied fromthisid parameter. Returns up to returncount entries. Only form entries that the authenticated user has permission to view are included.

Path parameters

  • fromthisid integer Required

    The ID that is previous to the one to start from e.g. if IDs are 1,2,3 fromthisid as 1 will return 2,3

  • returncount integer Required

    The number of IDs to return. Return count of 0 returns no items

    Minimum value is 0, maximum value is 30.

Responses

  • 200 application/json

    IDs and items found matching the required parameters

    Hide response attributes Show response attributes object
    • totalitemsavailable integer

      The total number of items in the whole data set regardless of the fromthisid parameter

    • firstid integer

      The first ID of the whole data set

    • finalid integer

      The last ID of the whole data set

    • returnlastid integer

      The last ID of the data set matching the criteria

    • items array[integer]

      A list of the IDs. The number returned matches the returncount parameter

      At least 1 but not more than 30 elements.
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
    • error string
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
    • error string
GET /formentries/poll/{fromthisid}/{returncount} 
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/formentries/poll/4/30' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "totalitemsavailable": 67,
  "firstid": 1,
  "finalid": 259,
  "returnlastid": 33,
  "items": [
    42
  ]
}
Response examples (401) 
{
  "error": "Unauthorised"
}
Response examples (403) 
{
  "error": "Invalid Permission"
}