APIs to create and manage events.
Location for an event
A list of booking guideline for the event.
Allowed booking types for the event group
List of custom field responses for the event.
The booking style for the event's participants.
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" ] }'
curl -i -X GET \ 'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "event": { "id": "string", "name": "string", "description": "string", "startDateTime": { … }, "endDateTime": { … }, "location": { … }, "group": { … }, "status": "DRAFT", "companyId": { … }, "runningStatus": "UPCOMING", "paymentSources": [ … ], "numTravelers": 1, "customFieldResponses": [ … ], "externalId": "qwert123" } }
curl -i -X DELETE \ 'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
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>'
{ "event": { "id": "string", "name": "string", "description": "string", "startDateTime": { … }, "endDateTime": { … }, "location": { … }, "group": { … }, "status": "DRAFT", "companyId": { … }, "runningStatus": "UPCOMING", "paymentSources": [ … ], "numTravelers": 1, "customFieldResponses": [ … ], "externalId": "qwert123" } }
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" } ] }'
{ "addedUserIds": [ { … } ] }
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" } ] }'
{ "removedUserIds": [ { … } ] }
Type of events
List events filters
Indicates from where in the list of events the server should start.
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 }'
{ "events": [ { … } ], "paginationParams": { "totalNumResults": 0 } }
curl -i -X POST \ 'https://developer.spotnana.com/_mock/openapi/eventapi/v2/events/{eventId}/publish' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Location for an event
The booking style for the event's participants.
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" ] }'