{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Viewing a specific event and its details","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"viewing-a-specific-event-and-its-details","__idx":0},"children":["Viewing a specific event and its details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following endpoints can be used to view a specific event and its"," ","associated details such as list of travelers, RSVP details, event dates, location, payment methods, and so on."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-event","__idx":1},"children":["Get event"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/eventapi#operation/getEvent"},"children":["Get event"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/events/{eventId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve event details such as the event name, date, location, event status, company details, number of travelers, payment sources, and custom field responses.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventId"]}," generated from step 1 of ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/event_creating_workflow"},"children":["creating and publishing an event"]}," workflow.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," Event details such as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", and so on."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-list-of-travelers-for-the-event","__idx":2},"children":["Get list of travelers for the event"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/eventapi#operation/listEventTravelers"},"children":["Get travelers list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/events/{eventId}/travelers-list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve the list of all travelers who were added to the event.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventId"]}," generated from step 1 of ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/event_creating_workflow"},"children":["creating and publishing an event"]}," workflow.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}," , ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," field can contain a value from 0 to 100 (i.e., you can view up to 100 travelers per API call). Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," field to paginate through the list if the number of travelers is more than 100.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," The list of travelers and their details such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]},", RSVP information and their trip details such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tripId"]},", and trip booking status.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Other APIs will use:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," (also referred to as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelerId"]}," in other event APIs)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-and-set-traveler-rsvp-details","__idx":3},"children":["Get and set traveler RSVP details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The RSVP status indicates whether the traveler has been added, invited, or removed from the event. A traveler’s RSVP status can represent one of the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added to the event"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed from the event"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Invited"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The RSVP response signifies which travel bookings the attendee is allowed to make (i.e., air, hotel, car and/or rail)."," ","The RSVP information can be both viewed (GET method) and updated (POST method) using the same API endpoint URL listed below."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/eventapi#operation/getUserEventRsvp"},"children":["Get traveler RSVP"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"(GET method)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/events/{eventId}/travelers/{travelerId}/rsvp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View the RSVP status and the RSVP response for a traveler.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventId"]}," from step 1 of the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/event_creating_workflow"},"children":["creating and publishing an event"]}," workflow and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelerId"]}," from ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/event_view_workflow#get-list-of-travelers-for-the-event"},"children":["get travelers list"]}," for the event.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventRsvpState"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventRsvpResponse"]}," of the traveler. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventRsvpResponse"]}," contains a boolean value indicating if the traveler is allowed to book for a selected service (i.e., air, car, rail, and/or hotel)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/eventapi#operation/setUserEventRsvp"},"children":["Set traveler RSVP"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"(POST method)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/events/{eventId}/travelers/{travelerId}/rsvp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update the RSVP status and the RSVP response for a traveler.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventId"]}," from step 1 of the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/event_creating_workflow"},"children":["creating and publishing an event"]}," workflow and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelerId"]}," from ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/event_view_workflow#get-list-of-travelers-for-the-event"},"children":["get travelers list"]}," for the event.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventRsvpState"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventRsvpResponse"]}," of the traveler."]}]}]}]}]}]},"headings":[{"value":"Viewing a specific event and its details","id":"viewing-a-specific-event-and-its-details","depth":1},{"value":"Get event","id":"get-event","depth":2},{"value":"Get list of travelers for the event","id":"get-list-of-travelers-for-the-event","depth":2},{"value":"Get and set traveler RSVP details","id":"get-and-set-traveler-rsvp-details","depth":2}],"frontmatter":{"toc":{"enable":true,"maxDepth":3},"seo":{"title":"Viewing a specific event and its details"}},"lastModified":"2024-11-06T13:52:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/spotnana/event_view_workflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}