[HTTP POST] ~/events/{eventId}/attendances
Description: Create an EventAttendance Record for a specific event
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| eventId |
The specific Event's Id |
integer |
Required |
Body Parameters
The Attendance Record to persist
EventAttendance| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The Id of the Event Attendance |
integer |
None. |
| EventId |
The Id of the Event the EventAttendance belongs to |
integer |
None. |
| ContactId |
The ID of the Contact the EventAttendance Record belongs to |
string |
None. |
| Comments |
Comments about this EventAttendance Record |
string |
None. |
| Registered |
Has the Contact registered for the event |
boolean |
None. |
| RegisteredDate |
The DateTime the Contact registered for the Event |
date |
None. |
| Declined |
Has the Contact Declined to attend the Event |
boolean |
None. |
| DeclinedDate |
The DateTime the Contact declined to attend the Event |
date |
None. |
| Unregistered |
Has the Contact Unregistered from the Event |
boolean |
None. |
| UnregisteredDate |
The DateTime the contact unregistered for the Event |
date |
None. |
| Confirmed |
Has the Contact confirmed their attendance at the Event |
boolean |
None. |
| ConfirmationDate |
The DateTime the Contact confirmed their attendance at the Event |
date |
None. |
| Attended |
Has the contact Attended the event |
boolean |
None. |
| AttendanceComments |
Comments about the Contact's Attendance at the Event |
string |
None. |
Formats
application/json, text/json
{
"Id": 1,
"EventId": 2,
"ContactId": "sample string 3",
"Comments": "sample string 4",
"Registered": true,
"RegisteredDate": "2024-05-05T22:26:46.0162532+01:00",
"Declined": true,
"DeclinedDate": "2024-05-05T22:26:46.0162532+01:00",
"Unregistered": true,
"UnregisteredDate": "2024-05-05T22:26:46.0162532+01:00",
"Confirmed": true,
"ConfirmationDate": "2024-05-05T22:26:46.0162532+01:00",
"Attended": true,
"AttendanceComments": "sample string 9"
}
application/csp-report
{"Id":1,"EventId":2,"ContactId":"sample string 3","Comments":"sample string 4","Registered":true,"RegisteredDate":"2024-05-05T22:26:46.0162532+01:00","Declined":true,"DeclinedDate":"2024-05-05T22:26:46.0162532+01:00","Unregistered":true,"UnregisteredDate":"2024-05-05T22:26:46.0162532+01:00","Confirmed":true,"ConfirmationDate":"2024-05-05T22:26:46.0162532+01:00","Attended":true,"AttendanceComments":"sample string 9"}
application/xml, text/xml
<EventAttendance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO"> <AttendanceComments>sample string 9</AttendanceComments> <Attended>true</Attended> <Comments>sample string 4</Comments> <ConfirmationDate>2024-05-05T22:26:46.0162532+01:00</ConfirmationDate> <Confirmed>true</Confirmed> <ContactId>sample string 3</ContactId> <Declined>true</Declined> <DeclinedDate>2024-05-05T22:26:46.0162532+01:00</DeclinedDate> <EventId>2</EventId> <Id>1</Id> <Registered>true</Registered> <RegisteredDate>2024-05-05T22:26:46.0162532+01:00</RegisteredDate> <Unregistered>true</Unregistered> <UnregisteredDate>2024-05-05T22:26:46.0162532+01:00</UnregisteredDate> </EventAttendance>
Response Information
Description
Successful Response - OK (200):
Response Content : EventAttendance
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The Id of the Event Attendance |
integer |
None. |
| EventId |
The Id of the Event the EventAttendance belongs to |
integer |
None. |
| ContactId |
The ID of the Contact the EventAttendance Record belongs to |
string |
None. |
| Comments |
Comments about this EventAttendance Record |
string |
None. |
| Registered |
Has the Contact registered for the event |
boolean |
None. |
| RegisteredDate |
The DateTime the Contact registered for the Event |
date |
None. |
| Declined |
Has the Contact Declined to attend the Event |
boolean |
None. |
| DeclinedDate |
The DateTime the Contact declined to attend the Event |
date |
None. |
| Unregistered |
Has the Contact Unregistered from the Event |
boolean |
None. |
| UnregisteredDate |
The DateTime the contact unregistered for the Event |
date |
None. |
| Confirmed |
Has the Contact confirmed their attendance at the Event |
boolean |
None. |
| ConfirmationDate |
The DateTime the Contact confirmed their attendance at the Event |
date |
None. |
| Attended |
Has the contact Attended the event |
boolean |
None. |
| AttendanceComments |
Comments about the Contact's Attendance at the Event |
string |
None. |
Response Codes:
-
200 - OK
- The EventAttendance Record was created returned successfully.
-
400 - BadRequest
- The AttendanceRecord's Contact does not exist, or the attendance record is empty/incorrectly formatted.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
{
"Id": 1,
"EventId": 2,
"ContactId": "sample string 3",
"Comments": "sample string 4",
"Registered": true,
"RegisteredDate": "2024-05-05T22:26:46.0318343+01:00",
"Declined": true,
"DeclinedDate": "2024-05-05T22:26:46.0318343+01:00",
"Unregistered": true,
"UnregisteredDate": "2024-05-05T22:26:46.0318343+01:00",
"Confirmed": true,
"ConfirmationDate": "2024-05-05T22:26:46.0318343+01:00",
"Attended": true,
"AttendanceComments": "sample string 9"
}
application/csp-report
{"Id":1,"EventId":2,"ContactId":"sample string 3","Comments":"sample string 4","Registered":true,"RegisteredDate":"2024-05-05T22:26:46.0318343+01:00","Declined":true,"DeclinedDate":"2024-05-05T22:26:46.0318343+01:00","Unregistered":true,"UnregisteredDate":"2024-05-05T22:26:46.0318343+01:00","Confirmed":true,"ConfirmationDate":"2024-05-05T22:26:46.0318343+01:00","Attended":true,"AttendanceComments":"sample string 9"}
application/xml, text/xml
<EventAttendance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO"> <AttendanceComments>sample string 9</AttendanceComments> <Attended>true</Attended> <Comments>sample string 4</Comments> <ConfirmationDate>2024-05-05T22:26:46.0318343+01:00</ConfirmationDate> <Confirmed>true</Confirmed> <ContactId>sample string 3</ContactId> <Declined>true</Declined> <DeclinedDate>2024-05-05T22:26:46.0318343+01:00</DeclinedDate> <EventId>2</EventId> <Id>1</Id> <Registered>true</Registered> <RegisteredDate>2024-05-05T22:26:46.0318343+01:00</RegisteredDate> <Unregistered>true</Unregistered> <UnregisteredDate>2024-05-05T22:26:46.0318343+01:00</UnregisteredDate> </EventAttendance>