Event API (v2)

Download OpenAPI description
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/eventapi/

Events

APIs to create and manage events.

Operations

Set traveler RSVP

Request

Update the RSVP status and the RSVP response for a traveler.

Path
eventIdstringrequired

Event ID

Example: 6926658168
travelerIdstring(uuid)required

Traveler User ID

Example: f49d00fe-1eda-4304-ba79-a980f565281d
Bodyapplication/json
typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
eventRsvpStatestring(EventRsvpState)

Allowed event rsvp states for a user

Enum"ADDED""INVITED""INVITE_ACCEPTED""INVITE_DECLINED""REMOVED"
eventRsvpResponseobject(EventRsvpResponse)

Event rsvp response

curl -i -X POST \
  https://apis.spotnana.com/v2/events/6926658168/travelers/f49d00fe-1eda-4304-ba79-a980f565281d/rsvp \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "GENERIC",
    "eventRsvpState": "ADDED",
    "eventRsvpResponse": {
      "air": {
        "notNeeded": true
      },
      "hotel": {
        "notNeeded": true
      },
      "car": {
        "notNeeded": true
      },
      "rail": {
        "notNeeded": true
      }
    }
  }'

Responses

OK

Response
No content

Get traveler RSVP

Request

Get the RSVP status and the RSVP response for a traveler.

Path
eventIdstringrequired

Event ID

Example: 6926658168
travelerIdstring(uuid)required

Traveler User ID

Example: f49d00fe-1eda-4304-ba79-a980f565281d
curl -i -X GET \
  https://apis.spotnana.com/v2/events/6926658168/travelers/f49d00fe-1eda-4304-ba79-a980f565281d/rsvp \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
userIdobject(UserId)

User identifier

eventRsvpStatestring(EventRsvpState)

Allowed event rsvp states for a user

Enum"ADDED""INVITED""INVITE_ACCEPTED""INVITE_DECLINED""REMOVED"
eventRsvpResponseobject(EventRsvpResponse)

Event rsvp response

invitedAtobject(DateTimeOffset)

ISO8601 UTC Date Time

airBookingStatusstring(BookingStatusType)

Booking status of the travel.

Enum"BOOKED""NOT_BOOKED""OPTED_OUT"
railBookingStatusstring(BookingStatusType)

Booking status of the travel.

Enum"BOOKED""NOT_BOOKED""OPTED_OUT"
carBookingStatusstring(BookingStatusType)

Booking status of the travel.

Enum"BOOKED""NOT_BOOKED""OPTED_OUT"
hotelBookingStatusstring(BookingStatusType)

Booking status of the travel.

Enum"BOOKED""NOT_BOOKED""OPTED_OUT"
Response
application/json
{ "userId": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "eventRsvpState": "ADDED", "eventRsvpResponse": { "air": {}, "hotel": {}, "car": {}, "rail": {} }, "invitedAt": { "iso8601": "2017-07-21T17:32Z" }, "airBookingStatus": "BOOKED", "railBookingStatus": "BOOKED", "carBookingStatus": "BOOKED", "hotelBookingStatus": "BOOKED" }

Send invite

Request

Send event invites to the travelers via email. The invites can be sent to all travelers using a single API call, or you can send invites to specific travelers.

Path
eventIdstringrequired

Event ID

Example: 6926658168
Bodyapplication/json
typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
userIdsArray of objects(UserId)
curl -i -X POST \
  https://apis.spotnana.com/v2/events/6926658168/invite/send \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "GENERIC",
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

OK

Response
No content