# Get event summaries

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

Endpoint: POST /v2/events/summaries
Version: v2
Security: Bearer

## Request fields (application/json):

  - `userId` (object)
    User id

  - `userId.id` (string, required)

  - `companyId` (object)
    Company id

  - `tripIds` (array)
    List of Spotnana trip IDs
    Example: ["6926658168"]

## Response 200 fields (application/json):

  - `tripEventSummaries` (array)
    List of Event summaries for trips

  - `tripEventSummaries.tripId` (string)
    Spotnana trip ID
    Example: "6926658168"

  - `tripEventSummaries.travelerEventSummary` (object)
    Event summary for a traveler

  - `tripEventSummaries.travelerEventSummary.id` (string, required)
    Event ID
    Example: "12345"

  - `tripEventSummaries.travelerEventSummary.type` (string)
    Event Type
    Enum: "GENERIC", "PROGRAM", "PROGRAM_SESSION", "PROGRAM_TRIP"

  - `tripEventSummaries.travelerEventSummary.name` (string)
    Name of the event
    Example: "My event"

  - `tripEventSummaries.travelerEventSummary.description` (string)
    Description of the event
    Example: "This is an event description"

  - `tripEventSummaries.travelerEventSummary.startDateTime` (object)
    Local date and time in ISO 8601 format.

  - `tripEventSummaries.travelerEventSummary.startDateTime.iso8601` (string, required)
    Example: "2017-07-21T17:32"

  - `tripEventSummaries.travelerEventSummary.endDateTime` (object)
    Local date and time in ISO 8601 format.

  - `tripEventSummaries.travelerEventSummary.location` (object)
    Location for an event

  - `tripEventSummaries.travelerEventSummary.location.address` (object)
    Postal Address Details

  - `tripEventSummaries.travelerEventSummary.location.address.addressLines` (array, required)
    Address lines
    Example: ["Golden Gate Bridge"]

  - `tripEventSummaries.travelerEventSummary.location.address.administrativeArea` (string)
    Code of administrative area. For example: DL for Delhi, India.
Highest administrative subdivision which is used for postal
addresses of a country or region.
For example, this can be a state, a province, an oblast, or a prefecture.
Specifically, for Spain this is the province and not the autonomous
community (e.g. "Barcelona" and not "Catalonia").
Many countries don't use an administrative area in postal addresses. E.g.
in Switzerland this should be left unpopulated.
    Example: "CA"

  - `tripEventSummaries.travelerEventSummary.location.address.administrativeAreaName` (string)
    Name of administrative area. This is full name corresponding to administrativeArea. 
Like Delhi for DL area code. For some places, code and name maybe same as well like Tokyo.
    Example: "California"

  - `tripEventSummaries.travelerEventSummary.location.address.description` (string)
    Address description
    Example: "San Francisco Home"

  - `tripEventSummaries.travelerEventSummary.location.address.isDefault` (boolean)
    Whether this address is default address in case multiple addresses are specified.
    Example: true

  - `tripEventSummaries.travelerEventSummary.location.address.languageCode` (string)
    BCP-47 language code of the contents of this address (if known). This is often the UI 
language of the input form or is expected to match one of the languages used in the 
address' country/region, or their transliterated equivalents.
This can affect formatting in certain countries, but is not critical to the correctness 
of the data and will never affect any validation or other non-formatting related operations.
Examples: "zh-Hant", "ja", "ja-Latn", "en".
    Example: "en"

  - `tripEventSummaries.travelerEventSummary.location.address.locality` (string)
    Generally refers to the city/town portion of the address.
    Example: "San Francisco"

  - `tripEventSummaries.travelerEventSummary.location.address.locationCode` (string)
    IATA 3-letter location code. See https://www.iata.org/en/services/codes.
    Example: "LAX"

  - `tripEventSummaries.travelerEventSummary.location.address.organization` (string)
    The name of the organization at the address.
    Example: "Spotnana"

  - `tripEventSummaries.travelerEventSummary.location.address.postalCode` (string)
    Postal code of the address. This is a required field when setting for a user/legal entity/company etc.
    Example: "94130"

  - `tripEventSummaries.travelerEventSummary.location.address.continentCode` (string)
    2 letter continent code of the continent this address falls in.
    Example: "AF"

  - `tripEventSummaries.travelerEventSummary.location.address.recipients` (array)
    The recipient at the address.

  - `tripEventSummaries.travelerEventSummary.location.address.regionCode` (string, required)
    Region code of the country/region of the address.
    Example: "US"

  - `tripEventSummaries.travelerEventSummary.location.address.regionName` (string)
    Region name of the country/region of the address.
    Example: "America"

  - `tripEventSummaries.travelerEventSummary.location.address.revision` (integer)
    Example: 1

  - `tripEventSummaries.travelerEventSummary.location.address.sortingCode` (string)
    Additional, country-specific, sorting code. This is not used
in most regions. Where it is used, the value is either a string like
"CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
alone, representing the "sector code" (Jamaica), "delivery area indicator"
(Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
    Example: "Jamaica"

  - `tripEventSummaries.travelerEventSummary.location.address.sublocality` (string)
    Sublocality of the address. This can be neighborhoods, boroughs, districts.

  - `tripEventSummaries.travelerEventSummary.location.address.timezone` (string)
    Time zone of the address.
    Example: "America/Los_Angeles"

  - `tripEventSummaries.travelerEventSummary.location.address.coordinates` (object)
    Map coordinates of the address.

  - `tripEventSummaries.travelerEventSummary.location.address.coordinates.latitude` (number, required)
    Latitude of the Location
    Example: 77.1025

  - `tripEventSummaries.travelerEventSummary.location.address.coordinates.longitude` (number, required)
    Longitude of the Location
    Example: 28.7041

  - `tripEventSummaries.travelerEventSummary.location.coordinates` (object)
    Latitude and Longitude for a Location

  - `tripEventSummaries.travelerEventSummary.documents` (array)
    List of documents associated with this event for the traveler

  - `tripEventSummaries.travelerEventSummary.documents.url` (string, required)
    S3 location of the document.
    Example: "https://s3.amazonaws.com/bucket-name/folder-name/file-name"

  - `tripEventSummaries.travelerEventSummary.documents.documentId` (string, required)
    Unique identifier of the document.
    Example: "f49d00fe-1eda-4304-ba79-a980f565281d"

  - `tripEventSummaries.travelerEventSummary.documents.documentMetadata` (object, required)
    Metadata related to document.

  - `tripEventSummaries.travelerEventSummary.documents.documentMetadata.documentType` (string, required)
    Document type.
    Enum: "BOARDING_PASS", "CONFIRMATION", "INVOICE", "VISA", "MISCELLANEOUS", "OTHERS", "TASK_PROCESSOR", "EVENT_COVER_IMAGE", "LOGO_IMAGE"

  - `tripEventSummaries.travelerEventSummary.documents.documentMetadata.entityType` (string, required)
    Entity type against which the document is to uploaded.
    Enum: "PNR", "COMPANY", "AIR_ITINERARY", "EVENT", "LOCATION_IMAGE"

  - `tripEventSummaries.travelerEventSummary.documents.documentMetadata.entityId` (string, required)
    Entity Id for the given entity type.
    Example: "123124"

  - `tripEventSummaries.travelerEventSummary.documents.documentMetadata.entityMetadata` (any, required)

  - `tripEventSummaries.travelerEventSummary.documents.documentMetadata.name` (string, required)
    Document name.
    Example: "BoardingPass.pdf"

  - `tripEventSummaries.travelerEventSummary.bookingGuidelines` (array)
    Booking details allowed for the event for the traveler

  - `tripEventSummaries.travelerEventSummary.allowedBookingTypes` (array)
    Allowed booking types for the event for the traveler
    Enum: "AIR", "HOTEL", "CAR", "RAIL"

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp` (object)
    User rsvp for the event

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.userId` (object)
    User identifier

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.userId.id` (string, required)

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpState` (string)
    Allowed event rsvp states for a user
    Enum: "ADDED", "INVITED", "INVITE_ACCEPTED", "INVITE_DECLINED", "REMOVED"

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse` (object)
    Event rsvp response

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.air` (object)
    Air rsvp response

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.air.notNeeded` (boolean)
    Whether air booking is needed by the traveler or not
    Example: true

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.hotel` (object)
    Hotel rsvp response

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.hotel.notNeeded` (boolean)
    Whether hotel booking is needed by the traveler or not
    Example: true

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.car` (object)
    Car rsvp response

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.car.notNeeded` (boolean)
    Whether car booking is needed by the traveler or not
    Example: true

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.rail` (object)
    Rail rsvp response

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.eventRsvpResponse.rail.notNeeded` (boolean)
    Whether rail booking is needed by the traveler or not
    Example: true

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.invitedAt` (object)
    ISO8601 UTC Date Time

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.airBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.railBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.carBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `tripEventSummaries.travelerEventSummary.eventUserRsvp.hotelBookingStatus` (string)
    Booking status of the travel.
    Enum: "BOOKED", "NOT_BOOKED", "OPTED_OUT"

  - `tripEventSummaries.travelerEventSummary.contactInfoList` (array)
    Event contacts for the traveler

  - `tripEventSummaries.travelerEventSummary.contactInfoList.email` (string)
    Business email of the user
    Example: "a@spotnana.com"

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name` (object, required)
    Full name containing first, middle, last (family) names, and suffix.

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name.family1` (string, required)
    Last (family) name.
    Example: "Gandas"

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name.family2` (string)
    Example: "FamilyTwo"

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name.given` (string, required)
    First (given) name.
    Example: "Vichitr"

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name.middle` (string)
    Middle name.
    Example: "Kumar"

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name.suffix` (string)
    Suffix used with the name. For example SR or JR.
    Enum: "NAME_SUFFIX_UNKNOWN", "SR", "JR", "MD", "PHD", "II", "III", "IV", "DO", "ATTY", "V", "VI", "ESQ", "DC", "DDS", "VM", "JD", "SECOND", "THIRD"

  - `tripEventSummaries.travelerEventSummary.contactInfoList.name.preferred` (string)
    Informal preferred name added by traveler. This is not used on any PNR or tickets
    Example: "Don"

  - `tripEventSummaries.travelerEventSummary.companyId` (object)
    Identifier of an object

  - `tripEventSummaries.travelerEventSummary.runningStatus` (string)
    Running status of an event
    Enum: "IN_PROGRESS", "UPCOMING", "COMPLETED"

  - `tripEventSummaries.travelerEventSummary.status` (string)
    Status of an event
    Enum: "DRAFT", "PUBLISH", "CANCELLED"

  - `tripEventSummaries.travelerEventSummary.isRemovedParticipant` (boolean)
    Whether the traveler is part of the event.

  - `tripEventSummaries.travelerEventSummary.inviteEmailConfig` (object)
    Configuration for event invite/reminder emails

  - `tripEventSummaries.travelerEventSummary.inviteEmailConfig.emailExcludeCoordinatorInfo` (boolean)
    Whether to exclude coordinator information in emails sent to travelers.
    Example: true

  - `tripEventSummaries.travelerEventSummary.contacts` (array)
    Event contacts for the traveler

## Response 400 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.