API reference

Event templates

Update template's basic information

Template API (v2)

Download OpenAPI description

TemplateApi.json

TemplateApi.yaml

Servers

Staging URL

https://apis.spotnana.com/

Spotnana mock server

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

Event Templates

APIs to create and manage event templates.

Operations

Create an event template

Request

This endpoint creates an event template.

Bodyapplication/json

namestringrequired

Name of the event template

descriptionstring

Description of the event

locationobject(EventLocation)

Location for an event

allowedBookingTypesArray of strings(EventAllowedBookingType)

Allowed booking types for the event template

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

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

A list of booking guideline for the event.

customFieldV3ResponsesArray of objects(CustomFieldPrefilledResponse)

List of custom field responses for an event.

paymentMappingsArray of objects(PaymentAccessMapping)

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

companyIdobject(CompanyId)required

Company id

companyId.idstring(uuid)required

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

internalNotesstring

Internal notes of the event

Example: "Use travelers default as payment method."

referenceUsersArray of objects(UserId)

Event group reference user ids

travelerTypesArray of strings(Persona)non-emptyrequired

Allowed traveler types for the event

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

Example: ["EMPLOYEE"]

policyIdstring(uuid)

Policy associated with the event.

Example: "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"

bookingStylestring(EventBookingStyle)required

Whether the event bookings will be self served by the traveler or would be arranged by an agent for the traveler.

Enum"SELF_SERVE""AGENT_MANAGED"

externalIdstring

External Id for the event

Example: "qwert123"

allowTravelersPolicystring(AllowTravelersPolicy)

Apply travelers policy when it is less restrictive.

Enum"ALLOWED""NOT_ALLOWED"

emailPreferencesobject(BucketEmailPreferences)

Email communication preferences based on bucket types.

allowTravelersToRsvpstring(AllowTravelersToRsvp)

Allow travelers to rsvp for the event

Enum"ALLOWED""NOT_ALLOWED"

tripOverridesobject(TripOverrides)

Trip overrides for the event

inviteEmailConfigobject(InviteEmailConfig)

Configuration for event invite/reminder emails

customFieldResponsesArray of objects(CustomFieldResponse)Deprecated

Preselected custom field responses for the event template.

curl -i -X POST \
  https://apis.spotnana.com/v2/event-templates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "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
      }
    },
    "allowedBookingTypes": [
      "AIR"
    ],
    "bookingGuidelines": [
      {
        "numGuestsAllowed": 1,
        "airBookingGuideLine": {
          "allowedAirports": [
            {
              "airportCode": "WRA",
              "airportName": "Warder Airport",
              "cityName": "Werder",
              "countryName": "Ethiopia",
              "countryCode": "ET",
              "zoneName": "Africa/Addis_Ababa",
              "stateCode": "CA"
            }
          ],
          "allowedCityCodes": [
            "NYC"
          ],
          "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
            }
          ]
        }
      }
    ],
    "customFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ],
    "customFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "readOnly": true,
        "hidden": true,
        "selectedOptions": [
          {
            "name": "string",
            "description": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ],
    "paymentMappings": [
      {
        "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "accessTypeAttributes": {
          "travelTypeFilter": {
            "travelTypes": [
              {
                "travelType": "AIR",
                "isRequired": true,
                "allowPostPaidBookings": false,
                "metadata": {
                  "vendors": []
                }
              }
            ]
          }
        }
      }
    ],
    "companyId": {
      "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
    },
    "internalNotes": "Use travelers default as payment method.",
    "referenceUsers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "travelerTypes": [
      "EMPLOYEE"
    ],
    "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "bookingStyle": "SELF_SERVE",
    "externalId": "qwert123",
    "allowTravelersPolicy": "ALLOWED",
    "emailPreferences": {
      "bucketTypes": [
        "BOOKING_CONFIRMATIONS"
      ],
      "isEnabled": false,
      "toEmails": [
        "example@email.com"
      ],
      "ccEmails": [
        "example@email.com"
      ],
      "bccEmails": [
        "example@email.com"
      ]
    },
    "allowTravelersToRsvp": "ALLOWED",
    "tripOverrides": {
      "legalEntity": {
        "behavior": "OVERRIDE_ALLOWED",
        "legalEntityRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "costCenter": {
        "behavior": "OVERRIDE_ALLOWED",
        "costCenterRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "department": {
        "behavior": "OVERRIDE_ALLOWED",
        "departmentRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "userAttributes": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "attribute": {
            "fixedColumnName": "contingentType",
            "value": "FSTV"
          }
        }
      ],
      "rateCodeOverrides": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "supplier": "SABRE",
          "travelType": "AIR",
          "rateCodeIds": [
            "f49d00fe-1eda-4304-ba79-a980f565281d"
          ]
        }
      ]
    },
    "inviteEmailConfig": {
      "emailExcludeCoordinatorInfo": true
    }
  }'

Responses

Bodyapplication/json

idstring

Example: "some-id"

Response

application/json

{
  "id": "some-id"
}

Get event template

Request

This endpoint gets event template details for a given template ID.

Path

templateIdstringrequired

Template ID

Example: 6926658168

curl -i -X GET \
  https://apis.spotnana.com/v2/event-templates/6926658168 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

eventTemplateobject(EventTemplate)

The event template object.

Response

application/json

{
  "eventTemplate": {
    "id": "string",
    "name": "string",
    "description": "string",
    "location": { … },
    "paymentSources": [ … ],
    "companyId": { … },
    "customFieldResponses": [ … ],
    "customFieldV3Responses": [ … ],
    "group": { … },
    "externalId": "qwert123",
    "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "status": "DRAFT"
  }
}

Delete an event template

Request

This endpoint archives an event template.

Path

templateIdstringrequired

Template ID

Example: 6926658168

curl -i -X DELETE \
  https://apis.spotnana.com/v2/event-templates/6926658168 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Update template's basic information

Request

This endpoint allows updating basic template information.

Path

templateIdstringrequired

Template ID

Example: 6926658168

Bodyapplication/json

namestring

Name of the event template

descriptionstring

Description of the event

internalNotesstring

Internal notes of the event

referenceUsersArray of objects(UserId)

Event group reference user ids

locationobject(EventLocation)

Location for an event

travelerTypesArray of strings(Persona)non-empty

Allowed traveler types for the event

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

Example: ["EMPLOYEE"]

bookingStylestring(EventBookingStyle)

Whether the event bookings will be self served by the traveler or would be arranged by an agent for the traveler.

Enum"SELF_SERVE""AGENT_MANAGED"

policyIdstring(uuid)

Policy associated with the event.

Example: "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"

allowTravelersPolicystring(AllowTravelersPolicy)

Apply travelers policy when it is less restrictive.

Enum"ALLOWED""NOT_ALLOWED"

emailPreferencesobject(BucketEmailPreferences)

Email communication preferences based on bucket types.

allowTravelersToRsvpstring(AllowTravelersToRsvp)

Allow travelers to rsvp for the event

Enum"ALLOWED""NOT_ALLOWED"

tripOverridesobject(TripOverrides)

Trip overrides for the event

eventCustomFieldV3ResponsesArray of objects(CustomFieldPrefilledResponse)

List of custom field responses for an event.

inviteEmailConfigobject(InviteEmailConfig)

Configuration for event invite/reminder emails

eventCustomFieldResponsesArray of objects(CustomFieldResponse)Deprecated

Preselected custom field responses for the event template.

curl -i -X POST \
  https://apis.spotnana.com/v2/event-templates/6926658168/edit-basic-info \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "internalNotes": "string",
    "referenceUsers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "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
      }
    },
    "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"
      ]
    },
    "allowTravelersToRsvp": "ALLOWED",
    "tripOverrides": {
      "legalEntity": {
        "behavior": "OVERRIDE_ALLOWED",
        "legalEntityRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "costCenter": {
        "behavior": "OVERRIDE_ALLOWED",
        "costCenterRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "department": {
        "behavior": "OVERRIDE_ALLOWED",
        "departmentRef": {
          "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
          "name": "Name"
        }
      },
      "userAttributes": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "attribute": {
            "fixedColumnName": "contingentType",
            "value": "FSTV"
          }
        }
      ],
      "rateCodeOverrides": [
        {
          "behavior": "OVERRIDE_ALLOWED",
          "supplier": "SABRE",
          "travelType": "AIR",
          "rateCodeIds": [
            "f49d00fe-1eda-4304-ba79-a980f565281d"
          ]
        }
      ]
    },
    "eventCustomFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ],
    "eventCustomFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "readOnly": true,
        "hidden": true,
        "selectedOptions": [
          {
            "name": "string",
            "description": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ],
    "inviteEmailConfig": {
      "emailExcludeCoordinatorInfo": true
    }
  }'

Responses

Response

No content

Update template booking guidelines

Request

This endpoint updates the booking guidelines for a template.

Path

templateIdstringrequired

Template ID

Example: 6926658168

Bodyapplication/json

A list of booking guideline for the event.

allowedBookingTypesArray of strings(EventAllowedBookingType)

Allowed booking types for the event template

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

allowedPaymentConfigArray of objects(AllowedPaymentConfig)

Allowed payment configuration for the event template

paymentMappingsArray of objects(PaymentAccessMapping)

Mappings i.e. access level, travel type information etc if certain selected payment methods are only allowed.

curl -i -X POST \
  https://apis.spotnana.com/v2/event-templates/6926658168/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"
            }
          ],
          "allowedCityCodes": [
            "NYC"
          ],
          "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"
    ],
    "allowedPaymentConfig": [
      {
        "travelType": "AIR",
        "paymentConfig": "TRAVELER_DEFAULT"
      }
    ],
    "paymentMappings": [
      {
        "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "accessTypeAttributes": {
          "travelTypeFilter": {
            "travelTypes": [
              {
                "travelType": "AIR",
                "isRequired": true,
                "allowPostPaidBookings": false,
                "metadata": {
                  "vendors": []
                }
              }
            ]
          }
        }
      }
    ]
  }'

Responses

Response

No content

Update template's custom field responses.

Request

This endpoint updates the template's custom field responses.

Path

templateIdstringrequired

Template ID

Example: 6926658168

Bodyapplication/json

customFieldResponsesArray of objects(CustomFieldResponse)

Preselected custom field responses for the event template.

customFieldV3ResponsesArray of objects(CustomFieldPrefilledResponse)

List of custom field responses for an event.

curl -i -X PUT \
  https://apis.spotnana.com/v2/event-templates/6926658168/custom-field-responses \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customFieldResponses": [
      {
        "customFieldId": "f49d00fe-1eda-4304-ba79-a980f565281d",
        "responseItems": [
          {
            "response": "Leisure travel",
            "additionalInput": "20"
          }
        ],
        "travelerAccess": "HIDDEN"
      }
    ],
    "customFieldV3Responses": [
      {
        "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342",
        "fieldName": "string",
        "armId": "0fd508db-63ff-4444-bfb1-b89c43061433",
        "readOnly": true,
        "hidden": true,
        "selectedOptions": [
          {
            "name": "string",
            "description": "string",
            "additionalUserInput": "string",
            "additionalInfos": [
              "string"
            ],
            "additionalInfoConfigs": [
              {
                "type": "VARIABLE",
                "name": "LLF"
              }
            ]
          }
        ]
      }
    ]
  }'

Responses

Response

No content

List event templates

Request

This endpoint lists event templates.

Bodyapplication/json

filtersArray of EventCompanyFilterWrapper (object) or EventNameFilterWrapper (object) or EventTemplateStatusFilterWrapper (object)(EventTemplateFilter)

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 25

Example: 2

sortOptionsArray of objects(SearchEventTemplateSortOptions)

Sort options for the list event template request.

curl -i -X POST \
  https://apis.spotnana.com/v2/event-templates/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": [
      {
        "companyFilter": {
          "companyId": {
            "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
          }
        }
      }
    ],
    "offset": 2,
    "limit": 2,
    "sortOptions": [
      {
        "sortField": "EVENT_NAME",
        "sortOrder": "DESC"
      }
    ]
  }'

Responses

Bodyapplication/json

eventTemplatesArray of objects(EventTemplate)

List of event templates

paginationParamsobject(OffsetBasedPaginationResponseParams)

Pagination parameters for response.

Response

application/json

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

Get template by external ID

Request

Get template details using the template'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://apis.spotnana.com/v2/event-templates/read-by-external-id?companyId=f49d00fe-1eda-4304-ba79-a980f565281d&externalId=6926658168' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

eventTemplateobject(EventTemplate)

The event template object.

Response

application/json

{
  "eventTemplate": {
    "id": "string",
    "name": "string",
    "description": "string",
    "location": { … },
    "paymentSources": [ … ],
    "companyId": { … },
    "customFieldResponses": [ … ],
    "customFieldV3Responses": [ … ],
    "group": { … },
    "externalId": "qwert123",
    "policyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "status": "DRAFT"
  }
}

Template API (v2)

Event Templates

Create an event template

RequestExpand all

Responses

Get event template

Request

Responses

Delete an event template

Request

Responses

Update template's basic information

RequestExpand all

Responses

Update template booking guidelines

RequestExpand all

Responses

Update template's custom field responses.

RequestExpand all

Responses

List event templates

RequestExpand all

Responses

Get template by external ID

Request

Responses

Request

Request

Request

Request

Request