MenuClose

Event Attendee - API Reference

Select API:

Event Attendee

Use the Event Attendee endpoint to get your event attendee information on your site.

End Point URL

https://api.cms-tool.net/webapps/api/eventAttendee

API Parameters and Filters

Name Description Example Optional Data type
data The JSON you would like to POST. This can be POST content also
data =
{
"eventid" : 123,
"attendeembrid" : 12345,
"attendeename" : "Name"
}
 Yes json object
id Search a specific event atteendee by the id id=123 Yes int

includeEventInfo

 Include this parameter to get event information in the return body

includeEventInfo="yes"

 Yes string

attendeename

 Filter results by attendee name

attendeename="test"

 Yes string

attendeestatus

 Filter results by attendee status. Example: Booked, Paid, Standby

attendeestatus="Booked"

 Yes string

Data Dictionary

Key Definition Type Format

Usage Instructions and Examples

Endpoint examples: 

  • https://api.cms-tool.net/webapps/api/eventAttendee?eventId=99
  • https://api.cms-tool.net/webapps/api/eventAttendee/9999
  • https://api.cms-tool.net/webapps/api/eventAttendee/statusMetaData 

Create a new event attendee

To create a new event attendee use POST method and do not provide any Id. You may use the event endpoint and member endpoint to get event id and attendeembrid.

You must include an eventid and attendeename for a new attendee. You should provide either a mbr_email or mbr_id for the attendee, so that this attendee will be linked with their member/user/customer record.

Example:

{
   "eventid" : 123,
   "mbr_email" : "test@example.com",
   "mbr_id" : 12345,
   "attendeename" : "Name"
}

Update an existing event attendee

You can also update an existing attendee's details or status. You must include an id. The rest of the parameters provided will be used to update the attendee. With updates you must provide the ID for the known attendee. There is no foreign key.

Example:

{
   "id": 12345,
   "attendeestatus": "Paid",
   ...
}

Status Meta Data

Return all valid status type meta data

End point: https://api.cms-tool.net/webapps/api/eventAttendee/statusMetaData 

{

   "endPoint": "eventattendee/statusMetaData",

   "data": [

       [

     "Booked",

           "Paid",

           "Standby",

           "X-Cancelled",

           "Tentative",

           "InCart"

       ]

   ],

   "success": true

}

Sample Object


{
"eventid":123123,
"attendeename":"John",
"mbr_id":112233,
"attendeembrid":112233,
"attendeecount":2,
"attendeestatus":"Booked",
"id":11111,
"attendeebookedon":"2021-12-15 12:16:45.683412",
"attendeeid":11111,
"cid":100000
}