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

Bulk edit/modify events.

Request

Edit the basic info and booking guidelines in bulk for events.

Bodyapplication/json
eventsToUpdateArray of objects(UpdateEventRequestItem)[ 1 .. 20 ] items

A list of events with the required updates

curl -i -X POST \
  https://apis.spotnana.com/v2/events/bulk-edit \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "eventsToUpdate": [
      {
        "eventId": "56789012",
        "eventBasicInfo": {
          "name": "string",
          "type": "GENERIC",
          "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": {
                  "invoiceMetadata": {}
                },
                "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"
            }
          ],
          "referenceUsers": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            }
          ],
          "travelerTypes": [
            "EMPLOYEE"
          ],
          "bookingStyle": "SELF_SERVE",
          "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
          "allowTravelersPolicy": "ALLOWED",
          "emailPreferences": {
            "bucketTypes": [
              "BOOKING_CONFIRMATIONS"
            ],
            "isEnabled": false,
            "toEmails": [
              "example@email.com"
            ],
            "ccEmails": [
              "example@email.com"
            ],
            "bccEmails": [
              "example@email.com"
            ]
          }
        },
        "eventBookingGuidelines": {
          "bookingGuidelines": [
            {
              "numGuestsAllowed": 1,
              "airBookingGuideLine": {
                "allowedAirports": [
                  null
                ],
                "arrivalBookingWindow": {},
                "departureBookingWindow": {},
                "allowedFlightGuidelines": [
                  null
                ]
              }
            }
          ],
          "allowedBookingTypes": [
            "AIR"
          ],
          "paymentMappings": [
            {
              "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
              "accessTypeAttributes": {
                "travelTypeFilter": {
                  "travelTypes": []
                }
              }
            }
          ],
          "eventType": "GENERIC"
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
updateEventsResponseArray of objects(UpdateEventResponse)required

List of events update response.

updateEventsResponse[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
updateEventsResponse[].​statusstring(OperationStatus)required

Generic operation/execution status.

Enum"SUCCESS""FAILED""PARTIAL_SUCCESS"
updateEventsResponse[].​messagestring

Details about success or failure reason.

Example: "Updated successfully"
Response
application/json
{ "updateEventsResponse": [ {} ] }

Bulk delete draft events

Request

API to bulk delete draft events.

Bodyapplication/jsonrequired
deleteEventListArray of objects(DeleteEventRequest)[ 1 .. 100 ] itemsrequired

List of events to be deleted.

deleteEventList[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
deleteEventList[].​typestring(EventType)

Type of an event

Enum"GENERIC""PROGRAM""PROGRAM_SESSION""PROGRAM_TRIP"
curl -i -X POST \
  https://apis.spotnana.com/v2/events/bulk-delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "deleteEventList": [
      {
        "id": "56789012",
        "type": "GENERIC"
      }
    ]
  }'

Responses

Bulk delete response with event statuses

Bodyapplication/json
deleteEventResponsesArray of objects(DeleteEventResponse)required

List of events delete response.

deleteEventResponses[].​idstringrequired

Unique identifier for the event.

Example: "56789012"
deleteEventResponses[].​statusstring(OperationStatus)required

Generic operation/execution status.

Enum"SUCCESS""FAILED""PARTIAL_SUCCESS"
deleteEventResponses[].​messagestring

Details about success or failure reason.

Example: "Deleted successfully"
Response
application/json
{ "deleteEventResponses": [ {} ] }