infoodle API documentation

Return a specific event

GET /events/event/{eventid}/{eventdate}

Get the full details regarding a specific event

This allows for authenticated call - which shows events for the authenticated user, or non-authenticated calls which shows only public events, i.e. events that are visible on the iternet.

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

OK
Hide response attributes Show response attributes object
- id integer
  
  ID of the event
- date string
- dayNumber integer
- dayNumberTh string
- dayNameAbbr string
- dayName string
- monthNameAbbr string
- monthName string
- yearNumber integer
- setupTime24hr string
- startTime24hr string
- endTime24hr string
- packDownTime24hr string
- setupTimeFriendly string
- startTimeFriendly string
- endTimeFriendly string
- packDownTimeFriendly string
- show_as_current string
  
  If this event is on now, then value is Y
- title string
- allDay integer
  
  1 if its an all day event, 0 otherwise
- description string
- passRequired string
  
  When COVID pass details are available, whether this is a COVID pass required event
- locationsDecode array[object]
  
  Hide locationsDecode attributes Show locationsDecode attributes
  
  id integer
  
  name string
  
  address string
- webLink string
- colorCode string
- nextEvent string
  
  For repeating events, when the next one will be
- questions object
  
  Hide questions attribute Show questions attribute
  
  All Events array[object]
  
  The title "All Events" is fixed. This object can be repeated for each location with the location name as the object name
  
  Hide All Events attributes Show All Events attributes
  
  locationName string
  
  Which location this applies to
  
  question string
  
  The question asked
  
  answer string
  
  The answer for this event
  
  show string
  
  whether to show it or not
  
  Values are Y or N.
- hasRoster string
  
  Whether there is a roster associated with this event
  
  Values are Y or N.
- hasLiveEvent string
  
  Whether there is a live event setup for this event
- invitees array[object]
  
  List of the groups classed as invitees
  
  Hide invitees attributes Show invitees attributes
  
  group_id integer
  
  name string
  
  Name of the group
  
  isadmin string
  
  If the logged in person is an administrator of the group
  
  Values are Y or N.
  
  canadmin string
  
  Whether the logged in person has permission to administer this event for the invitee group
  
  Values are Y or N.
  
  attendanceCapacity number
  
  Whether there is a capacity limit on this event for this group
- inviteesHasAdmin string
  
  If the logged in person is an administrator of the group
  
  Values are Y or N.
- inviteesHasCanAdmin string
  
  Whether the logged in person has permission to administer this event for the invitee group
  
  Values are Y or N.
- availableInvitees array[object]
  
  List of the groups classed as invitees
  
  Hide availableInvitees attributes Show availableInvitees attributes
  
  id integer
  
  name string

GET /events/event/{eventid}/{eventdate}

curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/events/event/{eventid}/{eventdate} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": 68,
  "date": "2022-06-01",
  "dayNumber": 42,
  "dayNumberTh": "1st",
  "dayNameAbbr": "Wed",
  "dayName": "Wednesday",
  "monthNameAbbr": "Jun",
  "monthName": "June",
  "yearNumber": 2022,
  "setupTime24hr": "09:00",
  "startTime24hr": "09:00",
  "endTime24hr": "600",
  "packDownTime24hr": "600",
  "setupTimeFriendly": "9am",
  "startTimeFriendly": "9am",
  "endTimeFriendly": "10am",
  "packDownTimeFriendly": "10am",
  "show_as_current": "N",
  "title": "Daily Catchup Meeting",
  "allDay": 0,
  "description": "string",
  "passRequired": "N",
  "locationsDecode": [
    {
      "id": 1,
      "name": "Conference Room",
      "address": "1 High Stret, London, SW1A 1AA"
    }
  ],
  "webLink": "https://www.google.com",
  "colorCode": "f5324e",
  "nextEvent": "2022-01-09",
  "questions": {
    "All Events": [
      {
        "locationName": "All Events",
        "question": "Catering",
        "answer": "Included in the price",
        "show": "Y"
      }
    ]
  },
  "hasRoster": "Y",
  "hasLiveEvent": "N",
  "invitees": [
    {
      "group_id": 1,
      "name": "Staff",
      "isadmin": "Y",
      "canadmin": "Y",
      "attendanceCapacity": 50
    }
  ],
  "inviteesHasAdmin": "Y",
  "inviteesHasCanAdmin": "Y",
  "availableInvitees": [
    {
      "id": 1,
      "name": "Staff"
    }
  ]
}