infoodle

Return a specific event, and the household members of logged in person

GET /events/myfamily/{eventid}/{eventdate}
O auth2

To identify all the the household members for the logged in use along with basic event details for use when checking a household into an event

Path parameters

  • eventid integer Required

    The ID of the event

  • eventdate string Required

    The date of the event to retrieve, YYYY-MM-DD format. Date is local time

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • members array[object]
      Hide members attributes Show members attributes object
      • userId integer
      • firstname string
      • middlename string
      • lastname string
      • nickName string
      • gender string

        Values are Male, Female, or ORGANISATION.

      • householdname string
      • isOrganisation string

        Values are Y or N.

      • passExpiryDate string

        If pass expiry is enabled.

      • person_image string

        Base64 encoded image of person

      • checkInStatus array[object]

        A list of groups this user has been checked in to for this event

        Hide checkInStatus attributes Show checkInStatus attributes object
        • groupId integer
        • status integer

          Whether this person is checked into this group or not. 1 : Checked in

      • checkin_groups array[object]

        List of groups mapped with the events invited groups that this user is a part of

        Hide checkin_groups attribute Show checkin_groups attribute object
        • id integer
    • groups array[object]

      List of groups that can be checked into this event, the invitees

      Hide groups attributes Show groups attributes object
      • id integer
      • name string
    • event object
      Hide event attributes Show event attributes object
      • title string
      • date string

        Date of this event

      • checkinOk integer

        Whether this event is ready for check in now. It maybe a future or past event which cant be checked in to at this time.

        Values are 1 or 0.
GET /events/myfamily/{eventid}/{eventdate} 
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/events/myfamily/{eventid}/{eventdate}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "members": [
    {
      "userId": 2157478,
      "firstname": "John",
      "middlename": "string",
      "lastname": "Smith",
      "nickName": "Johnny",
      "gender": "Male",
      "householdname": "infoodle Ltd",
      "isOrganisation": "N",
      "passExpiryDate": "2022-06-30",
      "person_image": "234lkjf3l4kjwelkfmwf......",
      "checkInStatus": [
        {
          "groupId": 500,
          "status": 1
        }
      ],
      "checkin_groups": [
        {
          "id": 530
        }
      ]
    }
  ],
  "groups": [
    {
      "id": 530,
      "name": "Staff Team"
    }
  ],
  "event": {
    "title": "Weekly Staff Meeting",
    "date": "2022-06-06",
    "checkinOk": 0
  }
}