[HTTP GET] ~/campaigns/{campaignId}/reports/rsvpevent

Description: Get an RSVPEvents Report for a specific Campaign

Request Information

URI Parameters

NameDescriptionTypeAdditional information
campaignId

the specific Campaign Id

 integer

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A RSVPEvent Report

Response Content : RSVPEventReport

NameDescriptionTypeAdditional information
Id

The ID of the RSVP Event

 integer

None.
Name

The Name of the RSVP Event

 string

None.
StartDate

When the RSVP Event was started

 date

None.
EndDate

When the RSVP Event ended

 date

None.
Registered

How many contacts registered for the Event

 integer

None.
Unregistered

How many contacts unregistered for the Event

 integer

None.
Declined

How many contacts declined to attend this event

 integer

None.
Attended

How many contacts attended the Event

 integer

None.
TotalRespondents

How many Respondents in total

 integer

None.
Confirmed

How many contacts confirmed attendance for the Event

 integer

None.
RegistrationRate

What % of invites Registered

 decimal number

None.
UnRegistrationRate

what % of Invites Unregistered

 decimal number

None.
DeclinedRate

What % of Contacts declined to attend

 decimal number

None.
ConfirmationRate

What % of Contacts Confirmed their attendance

 decimal number

None.
AttendanceRate

What % of Contacts attended the Event

 decimal number

None.

Response Codes:

  • 200 - OK
    • The specified Campaign's RSVP Reports were retrieved and returned successfully.
  • 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.
  • 404 - NotFound
    • The specified Campaign or it's RSVP reports were not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "StartDate": "2024-05-06T05:26:47.3819329+01:00",
  "EndDate": "2024-05-06T05:26:47.3819329+01:00",
  "Registered": 5,
  "Unregistered": 6,
  "Declined": 7,
  "Attended": 8,
  "TotalRespondents": 9,
  "Confirmed": 10,
  "RegistrationRate": 11.1,
  "UnRegistrationRate": 12.1,
  "DeclinedRate": 13.1,
  "ConfirmationRate": 14.1,
  "AttendanceRate": 15.1
}

application/csp-report

Sample: 
{"Id":1,"Name":"sample string 2","StartDate":"2024-05-06T05:26:47.3819329+01:00","EndDate":"2024-05-06T05:26:47.3819329+01:00","Registered":5,"Unregistered":6,"Declined":7,"Attended":8,"TotalRespondents":9,"Confirmed":10,"RegistrationRate":11.1,"UnRegistrationRate":12.1,"DeclinedRate":13.1,"ConfirmationRate":14.1,"AttendanceRate":15.1}

application/xml, text/xml

Sample: 
<RSVPEventReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Reports">
  <AttendanceRate>15.1</AttendanceRate>
  <Attended>8</Attended>
  <ConfirmationRate>14.1</ConfirmationRate>
  <Confirmed>10</Confirmed>
  <Declined>7</Declined>
  <DeclinedRate>13.1</DeclinedRate>
  <EndDate>2024-05-06T05:26:47.3819329+01:00</EndDate>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Registered>5</Registered>
  <RegistrationRate>11.1</RegistrationRate>
  <StartDate>2024-05-06T05:26:47.3819329+01:00</StartDate>
  <TotalRespondents>9</TotalRespondents>
  <UnRegistrationRate>12.1</UnRegistrationRate>
  <Unregistered>6</Unregistered>
</RSVPEventReport>