CMS Tool API schema

Public API version 1.4.51.

Event Attendee

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

Endpoint URL

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

`/api/eventAttendee`

Read and update event attendees.

GET

List records, or retrieve one by appending its ID to the path.

Query parameters

Name	Type	Example	Notes
`id`	int	`123`	Filter results by id.
`eventid`	int	`123`	Filter results by eventid.
`attendeename`	text	`example`	Filter results by attendeename.
`attendeestatus`	text	`example`	Filter results by attendeestatus.
`includeEventInfo`	boolean	`true`	Include event info in the response. Accepts true or 1.
`offset`	int	`123`	Skip this many matching records before returning results.
`pageSize`	int	`123`	Limit the number of records returned; accepted values are 1 through 999, with 200 used otherwise.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

Name	Type	Example	Notes
`id`	int	`123`	Set the id value.
`eventid`	int	`123`	Set the eventid value.
`attendeename`	text	`example`	Set the attendeename value.
`attendeestatus`	text	`example`	Set the attendeestatus value.
`attendeembrid`	int	`123`	Set the attendeembrid value.
`mbr_email`	text	`customer@example.com`	Set the mbr email value.

`/api/eventAttendee/statusMetaData`

Read available attendee statuses.

GET

Read available attendee statuses.

Data definitions

Field	Type	Description
`attendeesent1weekreminder`	timestamp	Date and time the one week reminder email was sent. Blank when not yet sent.
`eventid`	int	ID of the event booked (events.eventid).
`attendeename`	text	Name of the attendee.
`attendeesent1dayreminder`	timestamp	Date and time the one day reminder email was sent. Blank when not yet sent.
`attendeembrid`	int	Member ID of the member who made the booking (member.mbr_id).
`attendeecount`	int	Number of places this booking takes.
`attendeenote`	text	The attendee's free text comments given when booking.
`attendeeanswera`	text	The attendee's answer to the event's booking question A.
`attendeestatus`	text	Booking status: Booked (default), Paid, Standby, Tentative, InCart or X-Cancelled. Booked, Paid, Tentative and Standby count towards the event's places taken.
`attendeeanswerc`	text	The attendee's answer to the event's booking question C.
`attendeebookedon`	timestamp	Date and time the booking was made.
`attendeeanswerb`	text	The attendee's answer to the event's booking question B.
`attendeeid`	serial	Unique attendee booking ID.

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
}

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.