API Reference

Events

Send a test invite

Event API (v2)

Download OpenAPI description

EventApi.json

EventApi.yaml

Servers

Mock server

https://developer.spotnana.com/_mock/openapi/eventapi/

Staging URL

https://apis.spotnana.com/

Events

APIs to create and manage events.

Operations

Create event

Request

Create a draft event.

Bodyapplication/json

namestringrequired

Name of the event

descriptionstring

Description of the event

documentsArray of objects(Document)

Documents attached for an event

startDateTimeobject(DateTimeLocal)

Local date and time represented in the ISO 8601 standard.

endDateTimeobject(DateTimeLocal)

Local date and time represented in the ISO 8601 standard.

locationobject(EventLocation)required

Location for an event

location.addressobject(PostalAddress)

Postal Address Details

location.coordinatesobject(Latlng)

Latitude and Longitude for a Location

contactsArray of objects(UserId)

Contacts for the event

bookingGuidelinesArray of AirBookingGuidelineWrapper (object) or HotelBookingGuidelineWrapper (object) or CarBookingGuidelineWrapper (object) or RailBookingGuidelineWrapper (object)(EventBookingGuideline)

A list of booking guideline for the event.

allowedBookingTypesArray of strings(EventAllowedBookingType)

Allowed booking types for the event group

Items Enum"AIR""HOTEL""CAR""RAIL"

externalIdstring

External Id for the event

Example: "qwert123"

eventCustomFieldResponsesArray of objects(CustomFieldResponse)

List of custom field responses for the event.

parentEventIdstring

Optional parent event's id.

Example: "56789012"

companyIdobject(CompanyId)

Company ID

bookingStylestring(EventBookingStyle)

The booking style for the event's participants.

Enum"SELF_SERVE""AGENT_MANAGED"

referenceUsersArray of objects(UserId)

Event group reference user ids

travelerTypesArray of strings(Persona)

Allowed traveler types for the event

Items Enum"UNKNOWN_PERSONA""EMPLOYEE""GUEST""PERSONAL""RELATIVE""ADHOC"

Example: ["EMPLOYEE"]

curl -i -X POST \
  https://developer.spotnana.com/_mock/openapi/eventapi/v2/events \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "documents": [
      {
        "url": "https://s3.amazonaws.com/bucket-name/folder-name/file-name",
        "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "documentMetadata": {
          "documentType": "VISA",
          "entityType": "PNR",
          "entityId": "123124",
          "entityMetadata": {
            "pnrMetadata": {
              "flightMetadata": {
                "flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
              }
            },
            "invoiceMetadata": {
              "invoiceNumber": "SPOT-0001",
              "invoiceType": "FARE_INVOICE"
            },
            "travelType": "AIR"
          },
          "name": "BoardingPass.pdf"
        }
      }
    ],
    "startDateTime": {
      "iso8601": "2017-07-21T17:32"
    },
    "endDateTime": {
      "iso8601": "2017-07-21T17:32"
    },
    "location": {
      "address": {
        "addressLines": [
          "Golden Gate Bridge"
        ],
        "administrativeArea": "CA",
        "administrativeAreaName": "California",
        "description": "San Francisco Home",
        "isDefault": true,
        "languageCode": "en",
        "locality": "San Francisco",
        "locationCode": "LAX",
        "organization": "Spotnana",
        "postalCode": "94130",
        "continentCode": "AF",
        "recipients": [
          "string"
        ],
        "regionCode": "US",
        "regionName": "America",
        "revision": 1,
        "sortingCode": "Jamaica",
        "sublocality": "string",
        "timezone": "America/Los_Angeles",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      },
      "coordinates": {
        "latitude": 77.1025,
        "longitude": 28.7041
      }
    },
    "contacts": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "bookingGuidelines": [
      {
        "numGuestsAllowed": 1,
        "airBookingGuideLine": {
          "allowedAirports": [
            {
              "airportCode": "WRA",
              "airportName": "Warder Airport",
              "cityName": "Werder",
              "countryName": "Ethiopia",
              "countryCode": "ET",
              "zoneName": "Africa/Addis_Ababa",
              "stateCode": "CA"
            }
          ],
          "arrivalBookingWindow": {
            "startDateTime": {
              "iso8601": "2017-07-21T17:32"
            },
            "endDateTime": {
              "iso8601": "2017-07-21T17:32"
            }
          },
          "departureBookingWindow": {
            "startDateTime": {
              "iso8601": "2017-07-21T17:32"
            },
            "endDateTime": {
              "iso8601": "2017-07-21T17:32"
            }
          },
          "allowedFlightGuidelines": [
            {
              "allowedFlightType": "ROUND_TRIP",
              "numberOfLegs": 2
            }
          ]
        }
      }
    ],
    "allowedBookingTypes": [
      "AIR"
    ],
    "externalId": "qwert123",
    "eventCustomFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ],
    "parentEventId": "56789012",
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "bookingStyle": "SELF_SERVE",
    "referenceUsers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "travelerTypes": [
      "EMPLOYEE"
    ]
  }'

Responses

Bodyapplication/json

idstring

Response

application/json

{
  "id": "string"
}

Get event

Request

Get event details for the specified event ID.

Path

eventIdstringrequired

Event ID

Example: 6926658168

curl -i -X GET \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

eventobject(Event)

Event details

Response

application/json

{
  "event": {
    "id": "string",
    "name": "string",
    "description": "string",
    "startDateTime": { … },
    "endDateTime": { … },
    "location": { … },
    "group": { … },
    "status": "DRAFT",
    "companyId": { … },
    "runningStatus": "UPCOMING",
    "paymentSources": [ … ],
    "numTravelers": 1,
    "customFieldResponses": [ … ],
    "externalId": "qwert123"
  }
}

Delete a draft event

Request

Delete a draft (i.e., unpublished) event. A deleted event cannot be accessed or viewed again.

Path

eventIdstringrequired

Event ID

Example: 6926658168

curl -i -X DELETE \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

application/json

{
  "debugIdentifier": "string",
  "errorMessages": [
    { … }
  ]
}

Get event by external ID

Request

Get event details using the event's externalId. External IDs are unique identifiers which can be set based on the company's preference.

Query

externalIdstringrequired

External ID

Example: externalId=6926658168

companyIdstring(uuid)required

Company ID

Example: companyId=f49d00fe-1eda-4304-ba79-a980f565281d

curl -i -X GET \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/read-by-external-id?companyId=f49d00fe-1eda-4304-ba79-a980f565281d&externalId=6926658168' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

eventobject(Event)

Event details

Response

application/json

{
  "event": {
    "id": "string",
    "name": "string",
    "description": "string",
    "startDateTime": { … },
    "endDateTime": { … },
    "location": { … },
    "group": { … },
    "status": "DRAFT",
    "companyId": { … },
    "runningStatus": "UPCOMING",
    "paymentSources": [ … ],
    "numTravelers": 1,
    "customFieldResponses": [ … ],
    "externalId": "qwert123"
  }
}

Add travelers to an event

Request

Add the list of travelers to be invited to the event.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

userIdsArray of objects(UserId)

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/travelers/add' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

Bodyapplication/json

addedUserIdsArray of objects(UserId)

Response

application/json

{
  "addedUserIds": [
    { … }
  ]
}

Remove travelers from an event

Request

Remove travelers from an event. This endpoint allows you to remove up to 10 travelers per API call.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

userIdsArray of objects(UserId)[ 1 .. 10 ] items

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/travelers/remove' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

Bodyapplication/json

removedUserIdsArray of objects(UserId)

Response

application/json

{
  "removedUserIds": [
    { … }
  ]
}

List events

Request

List all the events that match the specified criteria in the request.

Bodyapplication/json

listEventTypestring

Type of events

Enum"UPCOMING""PAST_OR_COMPLETED""CANCELLED_EVENT"

Example: "UPCOMING"

filtersArray of EventUserFilterWrapper (object) or EventStatusFilterWrapper (object) or EventNameFilterWrapper (object) or EventDateRangeFilterWrapper (object) or EventCompanyFilterWrapper (object) or EventParentFilterWrapper (object) or EventTypeFilterWrapper (object)(EventFilter)

List events filters

offsetinteger>= 0

Indicates from where in the list of events the server should start.

Default 0

Example: 2

limitinteger<= 100

Maximum number of results to be fetched for the query.

Default 10

Example: 2

curl -i -X POST \
  https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "listEventType": "UPCOMING",
    "filters": [
      {
        "userFilter": {
          "userId": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          }
        }
      }
    ],
    "offset": 2,
    "limit": 2
  }'

Responses

Bodyapplication/json

eventsArray of objects(Event)

List of events

paginationParamsobject(OffsetBasedPaginationResponseParams)

Pagination parameters for response.

Response

application/json

{
  "events": [
    { … }
  ],
  "paginationParams": {
    "totalNumResults": 0
  }
}

Publish event

Request

Publish a draft event.

Path

eventIdstringrequired

Event ID

Example: 6926658168

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/publish' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

idstring

Response

application/json

{
  "id": "string"
}

Edit basic details of an event

Request

Edit the basic information of an event such as the event name, description, date and time, location, and contacts.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

namestringrequired

Name of the event

descriptionstring

Description of the event

documentsArray of objects(Document)

Documents attached for an event

startDateTimeobject(DateTimeLocal)

Local date and time represented in the ISO 8601 standard.

endDateTimeobject(DateTimeLocal)

Local date and time represented in the ISO 8601 standard.

locationobject(EventLocation)required

Location for an event

location.addressobject(PostalAddress)

Postal Address Details

location.coordinatesobject(Latlng)

Latitude and Longitude for a Location

contactsArray of objects(UserId)

Contacts for the event

bookingStylestring(EventBookingStyle)

The booking style for the event's participants.

Enum"SELF_SERVE""AGENT_MANAGED"

referenceUsersArray of objects(UserId)

Event group reference user ids

travelerTypesArray of strings(Persona)

Allowed traveler types for the event

Items Enum"UNKNOWN_PERSONA""EMPLOYEE""GUEST""PERSONAL""RELATIVE""ADHOC"

Example: ["EMPLOYEE"]

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/edit-basic-info' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "documents": [
      {
        "url": "https://s3.amazonaws.com/bucket-name/folder-name/file-name",
        "documentId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "documentMetadata": {
          "documentType": "VISA",
          "entityType": "PNR",
          "entityId": "123124",
          "entityMetadata": {
            "pnrMetadata": {
              "flightMetadata": {
                "flightId": "CgNERU4SA1NGTxoKNTQ1NzI5ODcxMQ"
              }
            },
            "invoiceMetadata": {
              "invoiceNumber": "SPOT-0001",
              "invoiceType": "FARE_INVOICE"
            },
            "travelType": "AIR"
          },
          "name": "BoardingPass.pdf"
        }
      }
    ],
    "startDateTime": {
      "iso8601": "2017-07-21T17:32"
    },
    "endDateTime": {
      "iso8601": "2017-07-21T17:32"
    },
    "location": {
      "address": {
        "addressLines": [
          "Golden Gate Bridge"
        ],
        "administrativeArea": "CA",
        "administrativeAreaName": "California",
        "description": "San Francisco Home",
        "isDefault": true,
        "languageCode": "en",
        "locality": "San Francisco",
        "locationCode": "LAX",
        "organization": "Spotnana",
        "postalCode": "94130",
        "continentCode": "AF",
        "recipients": [
          "string"
        ],
        "regionCode": "US",
        "regionName": "America",
        "revision": 1,
        "sortingCode": "Jamaica",
        "sublocality": "string",
        "timezone": "America/Los_Angeles",
        "coordinates": {
          "latitude": 77.1025,
          "longitude": 28.7041
        }
      },
      "coordinates": {
        "latitude": 77.1025,
        "longitude": 28.7041
      }
    },
    "contacts": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "bookingStyle": "SELF_SERVE",
    "referenceUsers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "travelerTypes": [
      "EMPLOYEE"
    ]
  }'

Responses

Bodyapplication/json

idstring

Response

application/json

{
  "id": "string"
}

Update event booking guidelines

Request

Update the booking guidelines for an event. You can update booking guidelines such as maximum number of guests allowed to accompany a traveler, arrival and departure window for the event, payment methods, and allowed travel types.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

A list of booking guideline for the event.

One of:

Booking details allowed for the event

bookingGuidelines[].airBookingGuideLineobject(AirBookingGuideline)

Air related guidelines

bookingGuidelines[].numGuestsAllowedinteger

Number of guests allowed to be booked for this booking

Example: 1

allowedBookingTypesArray of strings(EventAllowedBookingType)

Allowed booking types for the event group

Items Enum"AIR""HOTEL""CAR""RAIL"

paymentMappingsArray of objects(PaymentAccessMapping)

Mappings i.e. access level, travel type information etc.

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/edit-booking-guidelines' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bookingGuidelines": [
      {
        "numGuestsAllowed": 1,
        "airBookingGuideLine": {
          "allowedAirports": [
            {
              "airportCode": "WRA",
              "airportName": "Warder Airport",
              "cityName": "Werder",
              "countryName": "Ethiopia",
              "countryCode": "ET",
              "zoneName": "Africa/Addis_Ababa",
              "stateCode": "CA"
            }
          ],
          "arrivalBookingWindow": {
            "startDateTime": {
              "iso8601": "2017-07-21T17:32"
            },
            "endDateTime": {
              "iso8601": "2017-07-21T17:32"
            }
          },
          "departureBookingWindow": {
            "startDateTime": {
              "iso8601": "2017-07-21T17:32"
            },
            "endDateTime": {
              "iso8601": "2017-07-21T17:32"
            }
          },
          "allowedFlightGuidelines": [
            {
              "allowedFlightType": "ROUND_TRIP",
              "numberOfLegs": 2
            }
          ]
        }
      }
    ],
    "allowedBookingTypes": [
      "AIR"
    ],
    "paymentMappings": [
      {
        "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "accessTypeAttributes": {
          "travelTypeFilter": {
            "travelTypes": [
              {
                "travelType": "AIR",
                "isRequired": true,
                "allowPostPaidBookings": false,
                "metadata": {
                  "vendors": []
                }
              }
            ]
          }
        }
      }
    ]
  }'

Responses

Bodyapplication/json

idstring

Response

application/json

{
  "id": "string"
}

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

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://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/travelers/{travelerId}/rsvp' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventRsvpState": "ADDED",
    "eventRsvpResponse": {
      "air": {
        "notNeeded": true
      },
      "hotel": {
        "notNeeded": true
      },
      "car": {
        "notNeeded": true
      },
      "rail": {
        "notNeeded": true
      }
    }
  }'

Responses

Response

application/json

{
  "debugIdentifier": "string",
  "errorMessages": [
    { … }
  ]
}

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://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/travelers/{travelerId}/rsvp' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

userIdsArray of objects(UserId)

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/invite/send' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userIds": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

Response

application/json

{
  "debugIdentifier": "string",
  "errorMessages": [
    { … }
  ]
}

Send a test invite

Request

Send a test event invite to the API caller. This endpoint can be used to preview the invite before sending it to the travelers.

Path

eventIdstringrequired

Event ID

Example: 6926658168

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/invite/test' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

application/json

{
  "debugIdentifier": "string",
  "errorMessages": [
    { … }
  ]
}

Get event summaries

Request

View summaries of specific events. This endpoint retrieves a list of traveler event summaries based on specified userId, companyId, and tripIds.

Bodyapplication/jsonrequired

userIdobject(UserId)

User identifier

companyIdobject(CompanyId)

Company ID

tripIdsArray of strings

List of Spotnana trip IDs

Example: ["6926658168"]

curl -i -X POST \
  https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/summaries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "tripIds": [
      "6926658168"
    ]
  }'

Responses

Bodyapplication/json

tripEventSummariesArray of objects(TripEventSummary)

List of Event summaries for trips

Response

application/json

{
  "tripEventSummaries": [
    { … }
  ]
}

Get allowed payment sources

Request

Get the payment sources that are associated with the userId of the event coordinator.

Query

userIdstring(uuid)required

ID of the event coordinator

Example: userId=f49d00fe-1eda-4304-ba79-a980f565281d

curl -i -X GET \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/payment-sources?userId=f49d00fe-1eda-4304-ba79-a980f565281d' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

paymentSourcesArray of objects(PaymentSourceInfo)required

List of payment sources

paymentSources[].idstring(uuid)required

Unique identifier identifying this payment source

Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

paymentSources[].typestring(PaymentSourceType)

Type of Payment Source

Enum"CARD""VIRTUAL_CARD""REWARDS_PROGRAM""DELAYED_INVOICING""CUSTOM_PAYMENT_METHOD""VENDOR_PROGRAM_PAYMENT""UNUSED_CREDIT""CASH"

paymentSources[].paymentSourcePaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object) or PaymentSourceDescriptor (object)(PaymentSourceDescriptor)required

One of:

Wrapper for CardDescriptor

paymentSources[].paymentSource.cardDescriptorobject(CardDescriptor)

Descriptor for card payment source.

paymentSources[].statusstring(PaymentSourceStatus)

Status of the Payment Source.

Enum"ACTIVE""INCOMPLETE"

paymentSources[].mappingobject(PaymentSourceMapping)Deprecated

Mapping i.e. access level, travel type information etc.

Response

application/json

{
  "paymentSources": [
    { … }
  ]
}

Cancel event

Request

Cancel a published event. After you've canceled the event, it's recommended that you cancel the bookings using the Cancel PNR API.

Path

eventIdstringrequired

Event ID

Example: 6926658168

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

application/json

{
  "debugIdentifier": "string",
  "errorMessages": [
    { … }
  ]
}

Get travelers list

Request

Get a paginated list of travelers for an event, including each traveler's RSVP status, RSVP response, and tripId.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

offsetinteger>= 0

Indicates from where in the list of travelers the server should start.

Default 0

Example: 2

limitinteger[ 0 .. 100 ]

Maximum number of results to be fetched for the query.

Default 10

Example: 2

filtersArray of objects(EventTravelerFilter)

Filters for event travelers

curl -i -X POST \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/travelers-list' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 2,
    "limit": 2,
    "filters": [
      {
        "type": "string",
        "searchTerm": "name"
      }
    ]
  }'

Responses

Bodyapplication/json

travelerEventInfosArray of objects(TravelerEventInfo)

List of user rsvp responses & trip details

userGroupInfoobject(UserGroupInfo)

Details about group's users.

paginationParamsobject(OffsetBasedPaginationResponseParams)

Pagination parameters for response.

Response

application/json

{
  "travelerEventInfos": [
    { … }
  ],
  "userGroupInfo": {
    "userGroupCriteria": [ … ],
    "userIds": [ … ]
  },
  "paginationParams": {
    "totalNumResults": 0
  }
}

Update event custom field responses

Request

Update the response to a custom field question.

Path

eventIdstringrequired

Event ID

Example: 6926658168

Bodyapplication/json

eventCustomFieldResponsesArray of objects(CustomFieldResponse)required

List of custom field responses for an event.

eventCustomFieldResponses[].customFieldIdstring(uuid)required

The unique identifier for the custom field.

Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

eventCustomFieldResponses[].responseItemsArray of objects(CustomFieldResponseItem)

Responses selected by the event coordinator.

eventCustomFieldResponses[].travelerAccessstring(CustomFieldTravelerAccess)required

Traveler access for a custom field

Enum"HIDDEN""READ_ACCESS""WRITE_ACCESS"

curl -i -X PUT \
  'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/custom-field-responses' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventCustomFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ]
  }'

Responses

Response

application/json

{
  "debugIdentifier": "string",
  "errorMessages": [
    { … }
  ]
}

Event API (v2)

Events

Create event

RequestExpand all

Responses

Get event

Request

Responses

Delete a draft event

Request

Responses

Get event by external ID

Request

Responses

Add travelers to an event

RequestExpand all

Responses

Remove travelers from an event

RequestExpand all

Responses

List events

RequestExpand all

Responses

Publish event

Request

Responses

Edit basic details of an event

RequestExpand all

Responses

Update event booking guidelines

RequestExpand all

Responses

Set traveler RSVP

RequestExpand all

Responses

Get traveler RSVP

Request

Responses

Send invite

RequestExpand all

Responses

Send a test invite

Request

Responses

Get event summaries

RequestExpand all

Responses

Get allowed payment sources

Request

Responses

Cancel event

Request

Responses

Get travelers list

RequestExpand all

Responses

Update event custom field responses

RequestExpand all

Responses

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request