API tools faq
paste
Guest User

Untitled

a guest
May 2nd, 2017
51
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 95.94 KB | None | 0 0
raw download clone embed print report
  1. swagger: '2.0'
  2. info:
  3. title: Musement API
  4. description: Musmement API
  5. termsOfService: 'https://www.musement.com/'
  6. contact:
  7. email: api-support@musement.com
  8. license:
  9. name: Apache 2.0
  10. url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
  11. version: 3.2.0
  12. host: developers.musement.com
  13. basePath: /api/v3/
  14. schemes:
  15. - https
  16. consumes:
  17. - application/xml
  18. - application/json
  19. produces:
  20. - application/xml
  21. - application/json
  22. paths:
  23. /activity-taxonomies/features:
  24. get:
  25. tags:
  26. - ActivityTaxonomy
  27. summary: Get all feature taxonomies
  28. parameters:
  29. - $ref: '#/parameters/category'
  30. - $ref: '#/parameters/offset'
  31. - $ref: '#/parameters/limit'
  32. responses:
  33. '200':
  34. description: Returned when successful
  35. schema:
  36. $ref: '#/definitions/ActivityTaxonomy'
  37. '404':
  38. description: Returned when resource is not found
  39. '503':
  40. description: Returned when the service is unavailable
  41. /activity-taxonomies/highlights:
  42. get:
  43. tags:
  44. - ActivityTaxonomy
  45. summary: Get all highlight taxonomies
  46. parameters:
  47. - $ref: '#/parameters/category'
  48. - $ref: '#/parameters/offset'
  49. - $ref: '#/parameters/limit'
  50. responses:
  51. '200':
  52. description: Returned when successful
  53. schema:
  54. $ref: '#/definitions/ActivityTaxonomy'
  55. '404':
  56. description: Returned when resource is not found
  57. '503':
  58. description: Returned when the service is unavailable
  59. '/carts/{cartId}':
  60. get:
  61. tags:
  62. - Cart
  63. summary: Get a cart by unique identifier
  64. parameters:
  65. - $ref: '#/parameters/cartId'
  66. responses:
  67. '200':
  68. description: Returned when successful
  69. schema:
  70. $ref: '#/definitions/Cart'
  71. '404':
  72. description: Returned when resource is not found
  73. '503':
  74. description: Returned when the service is unavailable
  75. put:
  76. tags:
  77. - Cart
  78. summary: Replace a Cart
  79. parameters:
  80. - $ref: '#/parameters/cartId'
  81. - name: cart
  82. in: body
  83. description: Cart request
  84. required: true
  85. schema:
  86. $ref: '#/definitions/CartRequest'
  87. responses:
  88. '200':
  89. description: Returned when successful
  90. schema:
  91. $ref: '#/definitions/Cart'
  92. '404':
  93. description: Returned when resource is not found
  94. '503':
  95. description: Returned when the service is unavailable
  96. delete:
  97. tags:
  98. - Cart
  99. summary: Delete a Cart
  100. parameters:
  101. - $ref: '#/parameters/cartId'
  102. responses:
  103. '200':
  104. description: Returned when successful
  105. '404':
  106. description: Returned when resource is not found
  107. '503':
  108. description: Returned when the service is unavailable
  109. patch:
  110. tags:
  111. - Cart
  112. summary: Update a Cart
  113. parameters:
  114. - $ref: '#/parameters/cartId'
  115. - name: cart
  116. in: body
  117. description: Cart request
  118. required: true
  119. schema:
  120. $ref: '#/definitions/CartRequest'
  121. responses:
  122. '200':
  123. description: Returned when successful
  124. schema:
  125. $ref: '#/definitions/Cart'
  126. '404':
  127. description: Returned when resource is not found
  128. '503':
  129. description: Returned when the service is unavailable
  130. '/carts/{cartId}/form':
  131. get:
  132. tags:
  133. - Cart
  134. summary: Get the form associated to a cart
  135. parameters:
  136. - $ref: '#/parameters/cartId'
  137. responses:
  138. '200':
  139. description: Returned when successful
  140. '404':
  141. description: Returned when resource is not found
  142. '503':
  143. description: Returned when the service is unavailable
  144. '/carts/{cartId}/bundles':
  145. get:
  146. tags:
  147. - 'Cart, Bundle'
  148. summary: Get the bundle in a cart
  149. parameters:
  150. - $ref: '#/parameters/cartId'
  151. responses:
  152. '200':
  153. description: Returned when successful
  154. schema:
  155. $ref: '#/definitions/Bundle'
  156. '404':
  157. description: Returned when resource is not found
  158. '503':
  159. description: Returned when the service is unavailable
  160. /carts:
  161. post:
  162. tags:
  163. - Cart
  164. summary: Create a cart
  165. parameters:
  166. - name: cart
  167. in: body
  168. description: Cart request
  169. required: true
  170. schema:
  171. $ref: '#/definitions/CartRequest'
  172. responses:
  173. '200':
  174. description: Returned when successful
  175. schema:
  176. $ref: '#/definitions/Cart'
  177. '404':
  178. description: Returned when resource is not found
  179. '503':
  180. description: Returned when the service is unavailable
  181. '/carts/{id}/tickets':
  182. post:
  183. tags:
  184. - Cart
  185. summary: Add tickets to a cart
  186. parameters:
  187. - name: id
  188. in: path
  189. description: Cart Id
  190. required: true
  191. type: integer
  192. responses:
  193. '200':
  194. description: Returned when successful
  195. schema:
  196. $ref: '#/definitions/Cart'
  197. '404':
  198. description: Returned when resource is not found
  199. '503':
  200. description: Returned when the service is unavailable
  201. '/carts/{id}/tickets/{ticketId}':
  202. delete:
  203. tags:
  204. - Cart
  205. summary: Delete a ticket by ID
  206. parameters:
  207. - name: id
  208. in: path
  209. description: Cart Id
  210. required: true
  211. type: integer
  212. - name: ticketId
  213. in: path
  214. description: Ticket Id
  215. required: true
  216. type: integer
  217. responses:
  218. '200':
  219. description: Returned when successful
  220. schema:
  221. $ref: '#/definitions/Ticket'
  222. '404':
  223. description: Returned when resource is not found
  224. '503':
  225. description: Returned when the service is unavailable
  226. '/categories/{categoryId}':
  227. get:
  228. tags:
  229. - Category
  230. summary: Get a category by identifier
  231. parameters:
  232. - $ref: '#/parameters/categoryId'
  233. responses:
  234. '200':
  235. description: Returned when successful
  236. schema:
  237. $ref: '#/definitions/Category'
  238. '404':
  239. description: Returned when resource is not found
  240. '503':
  241. description: Returned when the service is unavailable
  242. /categories:
  243. get:
  244. tags:
  245. - Category
  246. summary: Get categories
  247. parameters:
  248. - $ref: '#/parameters/offset'
  249. - $ref: '#/parameters/limit'
  250. responses:
  251. '200':
  252. description: Returned when successful
  253. schema:
  254. type: array
  255. items:
  256. $ref: '#/definitions/Category'
  257. '404':
  258. description: No resource found
  259. '503':
  260. description: Service unavailable
  261. '/categories/{categoryId}/events':
  262. get:
  263. tags:
  264. - Category
  265. - Event
  266. summary: Get events for a category sorted by category relevance.
  267. description: >-
  268. Get all events for a category sorted by category relevance. Only the
  269. events that have at least one active date in the period specified
  270. between date_from and date_to are returned. If date_from and date_to are
  271. not set then the period that will be set will be one year from the date
  272. of the request'
  273. parameters:
  274. - $ref: '#/parameters/categoryId'
  275. - $ref: '#/parameters/vertical'
  276. - $ref: '#/parameters/city'
  277. - $ref: '#/parameters/venue'
  278. - $ref: '#/parameters/editorial-category'
  279. - $ref: '#/parameters/date_from'
  280. - $ref: '#/parameters/date_to'
  281. - $ref: '#/parameters/offset'
  282. - $ref: '#/parameters/limit'
  283. - name: sort_by
  284. in: query
  285. description: Sorting strategy
  286. required: false
  287. type: string
  288. default: venue-relevance
  289. enum:
  290. - relevance
  291. - venue-relevance
  292. - category-relevance
  293. - price
  294. - rating
  295. responses:
  296. '200':
  297. description: Returned when successful
  298. schema:
  299. type: array
  300. items:
  301. $ref: '#/definitions/Event'
  302. '404':
  303. description: No resource found
  304. '503':
  305. description: Service unavailable
  306. '/cities/{cityId}':
  307. get:
  308. tags:
  309. - City
  310. summary: Get city by unique identifier
  311. parameters:
  312. - $ref: '#/parameters/cityId'
  313. responses:
  314. '200':
  315. description: Returned when successful
  316. schema:
  317. $ref: '#/definitions/City'
  318. '404':
  319. description: Returned when resource is not found
  320. '503':
  321. description: Returned when the service is unavailable
  322. /cities:
  323. get:
  324. tags:
  325. - City
  326. summary: Get cities
  327. parameters:
  328. - $ref: '#/parameters/offset'
  329. - $ref: '#/parameters/limit'
  330. - name: prioritized_country
  331. in: query
  332. description: Set the country to prioritize (id) (will affect results order)
  333. required: false
  334. type: string
  335. - name: prioritized_country_cities_limit
  336. in: query
  337. description: >-
  338. Set the number of cities to select from the country given in
  339. prioritized_country, if not given means unlimited
  340. required: false
  341. type: integer
  342. - name: sort_by
  343. in: query
  344. description: Set sorting strategy
  345. required: false
  346. type: string
  347. default: weight
  348. enum:
  349. - none
  350. - weight
  351. - name: without_events
  352. in: query
  353. description: Set to 'yes' return all cities otherwise only those with events
  354. required: false
  355. type: string
  356. default: 'no'
  357. enum:
  358. - 'yes'
  359. - 'no'
  360. responses:
  361. '200':
  362. description: Returned when successful
  363. schema:
  364. type: array
  365. items:
  366. $ref: '#/definitions/CityAggregated'
  367. '404':
  368. description: No resource found
  369. '503':
  370. description: Service unavailable
  371. '/cities/{cityId}/lists':
  372. get:
  373. tags:
  374. - City
  375. - List
  376. summary: Get lists for a city
  377. parameters:
  378. - $ref: '#/parameters/cityId'
  379. - $ref: '#/parameters/offset'
  380. - $ref: '#/parameters/limit'
  381. - name: sort_by
  382. in: query
  383. description: Set sorting strategy
  384. required: false
  385. type: string
  386. default: weight
  387. enum:
  388. - none
  389. - weight
  390. - name: without_events
  391. in: query
  392. description: Set to 'yes' return all cities otherwise only those with events
  393. required: false
  394. type: string
  395. default: 'no'
  396. enum:
  397. - 'yes'
  398. - 'no'
  399. - name: tag
  400. in: query
  401. description: List tags to filter by
  402. required: false
  403. type: array
  404. items:
  405. type: string
  406. collectionFormat: multi
  407. - name: list-types
  408. in: query
  409. description: List type to filter by
  410. required: false
  411. type: array
  412. items:
  413. type: string
  414. collectionFormat: multi
  415. responses:
  416. '200':
  417. description: Returned when successful
  418. schema:
  419. type: array
  420. items:
  421. $ref: '#/definitions/MusementList'
  422. '404':
  423. description: No resource found
  424. '503':
  425. description: Service unavailable
  426. '/cities/{cityId}/verticals':
  427. get:
  428. tags:
  429. - City
  430. - Vertical
  431. summary: Get all verticals for a city
  432. parameters:
  433. - $ref: '#/parameters/cityId'
  434. responses:
  435. '200':
  436. description: Returned when successful
  437. schema:
  438. type: array
  439. items:
  440. $ref: '#/definitions/Vertical'
  441. '404':
  442. description: Returned when resource is not found
  443. '503':
  444. description: Returned when the service is unavailable
  445. '/cities/{cityId}/events':
  446. get:
  447. operationId: getEvents
  448. tags:
  449. - City
  450. - Event
  451. summary: Get all verticals for a city
  452. description: >-
  453. Get all events for an city. Only the events that have at least one
  454. active date in the period specified between date_from and date_to are
  455. returned. If date_from and date_to are not set then the period that will
  456. be set will be one year from the date of the request'
  457. parameters:
  458. - $ref: '#/parameters/cityId'
  459. - $ref: '#/parameters/vertical'
  460. - $ref: '#/parameters/category'
  461. - $ref: '#/parameters/venue'
  462. - $ref: '#/parameters/editorial-category'
  463. - $ref: '#/parameters/date_from'
  464. - $ref: '#/parameters/date_to'
  465. - $ref: '#/parameters/offset'
  466. - $ref: '#/parameters/limit'
  467. - name: sort_by
  468. in: query
  469. description: Sorting strategy
  470. required: false
  471. type: string
  472. default: venue-relevance
  473. enum:
  474. - relevance
  475. - venue-relevance
  476. - category-relevance
  477. - price
  478. - rating
  479. responses:
  480. '200':
  481. description: Returned when successful
  482. schema:
  483. type: array
  484. items:
  485. $ref: '#/definitions/Event'
  486. '404':
  487. description: Returned when resource is not found
  488. '503':
  489. description: Returned when the service is unavailable
  490. '/cities/{cityId}/events/{happening}':
  491. get:
  492. tags:
  493. - City
  494. - Event
  495. summary: Get events
  496. parameters:
  497. - $ref: '#/parameters/cityId'
  498. - $ref: '#/parameters/offset'
  499. - $ref: '#/parameters/limit'
  500. - name: happening
  501. in: path
  502. description: Events for today or tomorrow ?
  503. required: true
  504. type: string
  505. enum:
  506. - today
  507. - tomorrow
  508. responses:
  509. '200':
  510. description: Returned when successful
  511. schema:
  512. type: array
  513. items:
  514. $ref: '#/definitions/Event'
  515. '404':
  516. description: No resource found
  517. '503':
  518. description: Service unavailable
  519. '/cities/{cityId}/venues':
  520. get:
  521. tags:
  522. - 'City, Venue'
  523. summary: Get venues for a city
  524. parameters:
  525. - $ref: '#/parameters/cityId'
  526. - $ref: '#/parameters/offset'
  527. - $ref: '#/parameters/limit'
  528. - $ref: '#/parameters/vertical'
  529. responses:
  530. '200':
  531. description: Returned when successful
  532. schema:
  533. type: array
  534. items:
  535. $ref: '#/definitions/Venue'
  536. '404':
  537. description: No resource found
  538. '503':
  539. description: Service unavailable
  540. '/cities/{cityId}/categories':
  541. get:
  542. tags:
  543. - City
  544. - Category
  545. summary: Categories for the city. Sorted by the number of events for the category
  546. parameters:
  547. - $ref: '#/parameters/cityId'
  548. responses:
  549. '200':
  550. description: Returned when successful
  551. '404':
  552. description: Returned when resource is not found
  553. '503':
  554. description: Returned when te service is unavailable
  555. '/cities/{cityId}/blogposts':
  556. get:
  557. tags:
  558. - City
  559. - Blogpost
  560. summary: Get the blogposts for the city
  561. parameters:
  562. - $ref: '#/parameters/cityId'
  563. responses:
  564. '200':
  565. description: Returned when successful
  566. '404':
  567. description: Returned when resource is not found
  568. '503':
  569. description: Returned when the service is unavailable
  570. '/events/{eventId}/comments':
  571. get:
  572. tags:
  573. - Event
  574. - Comment
  575. summary: Get comments for an event
  576. parameters:
  577. - $ref: '#/parameters/eventId'
  578. - $ref: '#/parameters/offset'
  579. - $ref: '#/parameters/limit'
  580. - name: locale
  581. in: query
  582. description: Set first comment in this language
  583. required: false
  584. type: string
  585. responses:
  586. '200':
  587. description: Returned when successful
  588. schema:
  589. type: array
  590. items:
  591. $ref: '#/definitions/Comment'
  592. '404':
  593. description: No resource found
  594. '503':
  595. description: Service unavailable
  596. /content-managers/me:
  597. get:
  598. tags:
  599. - Security
  600. summary: Get logged content manager data
  601. responses:
  602. '200':
  603. description: Returned when successful
  604. schema:
  605. $ref: '#/definitions/ContentManager'
  606. '503':
  607. description: Returned when the service is unavailable
  608. '/countries/{countryId}':
  609. get:
  610. tags:
  611. - Country
  612. summary: Get country by unique identifier
  613. parameters:
  614. - name: countryId
  615. in: path
  616. description: Country identifier
  617. required: true
  618. type: integer
  619. responses:
  620. '200':
  621. description: Returned when successful
  622. '404':
  623. description: Returned when resource is not found
  624. '503':
  625. description: Returned when the service is unavailable
  626. /countries:
  627. get:
  628. tags:
  629. - Country
  630. summary: Get all countries
  631. responses:
  632. '200':
  633. description: Returned when successful
  634. schema:
  635. type: array
  636. items:
  637. $ref: '#/definitions/Country'
  638. '404':
  639. description: Returned when resource is not found
  640. '503':
  641. description: Returned when the service is unavailable
  642. '/countries/{countryId}/cities':
  643. get:
  644. tags:
  645. - Country
  646. - City
  647. summary: Get all cities for a country
  648. parameters:
  649. - $ref: '#/parameters/countryId'
  650. - $ref: '#/parameters/offset'
  651. - $ref: '#/parameters/limit'
  652. responses:
  653. '200':
  654. description: Returned when successful
  655. schema:
  656. type: array
  657. items:
  658. $ref: '#/definitions/CityAggregated'
  659. '404':
  660. description: Returned when resource is not found
  661. '503':
  662. description: Returned when the service is unavailable
  663. '/countries/{countryId}/events':
  664. get:
  665. tags:
  666. - Country
  667. - Events
  668. summary: Get all events for a country
  669. description: >-
  670. Get all events for a country sorted by relevance. If priority_city is
  671. specified the event for that city are returned first'
  672. parameters:
  673. - $ref: '#/parameters/countryId'
  674. - $ref: '#/parameters/vertical'
  675. - name: priority_city
  676. in: query
  677. description: Prioritize results that belong to this city
  678. required: false
  679. type: integer
  680. - $ref: '#/parameters/offset'
  681. - $ref: '#/parameters/limit'
  682. responses:
  683. '200':
  684. description: Returned when successful
  685. schema:
  686. type: array
  687. items:
  688. $ref: '#/definitions/Event'
  689. '404':
  690. description: Returned when resource is not found
  691. '503':
  692. description: Returned when the service is unavailable
  693. /currencies:
  694. get:
  695. tags:
  696. - Currencies
  697. summary: Get all available currencies
  698. responses:
  699. '200':
  700. description: Returned when successful
  701. schema:
  702. $ref: '#/definitions/Currency'
  703. '404':
  704. description: Returned when resource is not found
  705. '503':
  706. description: Returned when the service is unavailable
  707. /customers/me:
  708. get:
  709. tags:
  710. - Security
  711. summary: Get logged user data
  712. responses:
  713. '200':
  714. description: Returned when successful
  715. schema:
  716. $ref: '#/definitions/Customer'
  717. '503':
  718. description: Returned when te service is unavailable
  719. /customers/me/orders:
  720. get:
  721. tags:
  722. - Order
  723. summary: Get all orders for the user logged in
  724. responses:
  725. '200':
  726. description: Returned when successful
  727. schema:
  728. type: array
  729. items:
  730. $ref: '#/definitions/Order'
  731. '503':
  732. description: Returned when the service is unavailable
  733. /customers/me/reviews:
  734. get:
  735. tags:
  736. - Review
  737. summary: Get all reviews for the user logged in
  738. responses:
  739. '200':
  740. description: Returned when successful
  741. schema:
  742. $ref: '#/definitions/Comment'
  743. '503':
  744. description: Returned when the service is unavailable
  745. '/customers/me/wishes/{id}':
  746. delete:
  747. tags:
  748. - Wishlist
  749. summary: Delete an item from user wishlist
  750. parameters:
  751. - name: id
  752. in: path
  753. description: ''
  754. required: true
  755. type: integer
  756. responses:
  757. '204':
  758. description: Returned when successful
  759. '403':
  760. description: When the user has no authorization on the item it's trying to remove
  761. '404':
  762. description: The item to remove doesn't exists
  763. '503':
  764. description: Returned when te service is unavailable
  765. '/editorial-categories/{editorialcategoryId}':
  766. get:
  767. tags:
  768. - Editorial category
  769. summary: Get an editorial category by ID
  770. parameters:
  771. - $ref: '#/parameters/editorialcategoryId'
  772. responses:
  773. '200':
  774. description: Returned when successful
  775. schema:
  776. $ref: '#/definitions/EditorialCategory'
  777. '404':
  778. description: Returned when resource is not found
  779. '503':
  780. description: Returned when the service is unavailable
  781. /editorial-categories:
  782. get:
  783. tags:
  784. - Editorial category
  785. summary: Get all editorial categories
  786. parameters:
  787. - $ref: '#/parameters/offset'
  788. - $ref: '#/parameters/limit'
  789. responses:
  790. '200':
  791. description: Returned when successful
  792. schema:
  793. type: array
  794. items:
  795. $ref: '#/definitions/EditorialCategory'
  796. '404':
  797. description: Returned when resource is not found
  798. '503':
  799. description: Returned when the service is unavailable
  800. '/editorial-categories/{editorialcategoryId}/events':
  801. get:
  802. tags:
  803. - Editorial category
  804. - Event
  805. summary: Get all events for an editorial category sorted by event relevance.
  806. description: >-
  807. Get all events for an editorial category sorted by relevance. Only the
  808. events that have at least one active date in the period specified
  809. between date_from and date_to are returned. If date_from and date_to are
  810. not set then the period that will be set will be one year from the date
  811. of the request'
  812. parameters:
  813. - $ref: '#/parameters/editorialcategoryId'
  814. - $ref: '#/parameters/vertical'
  815. - $ref: '#/parameters/city'
  816. - $ref: '#/parameters/category'
  817. - $ref: '#/parameters/venue'
  818. - $ref: '#/parameters/date_from'
  819. - $ref: '#/parameters/date_to'
  820. - $ref: '#/parameters/offset'
  821. - $ref: '#/parameters/limit'
  822. - name: sort_by
  823. in: query
  824. description: Sorting strategy
  825. required: false
  826. type: string
  827. default: relevance
  828. enum:
  829. - relevance
  830. - price
  831. - rating
  832. responses:
  833. '200':
  834. description: Returned when successful
  835. schema:
  836. type: array
  837. items:
  838. $ref: '#/definitions/Event'
  839. '404':
  840. description: Returned when resource is not found
  841. '503':
  842. description: Returned when the service is unavailable
  843. '/editorial-categories/{editorialcategoryId}/flavours':
  844. get:
  845. tags:
  846. - Editorial categories
  847. summary: Get all flavours connected to an editorial category
  848. parameters:
  849. - $ref: '#/parameters/editorialcategoryId'
  850. responses:
  851. '200':
  852. description: Returned when successful
  853. schema:
  854. $ref: '#/definitions/Flavour'
  855. '404':
  856. description: Returned when resource is not found
  857. '503':
  858. description: Returned when the service is unavailable
  859. /events/search:
  860. get:
  861. tags:
  862. - search
  863. - deprecated
  864. summary: Deprecated API for search - Use search-extended endpoint
  865. parameters:
  866. - $ref: '#/parameters/limit'
  867. - $ref: '#/parameters/offset'
  868. responses:
  869. '200':
  870. description: Returned when successful
  871. '503':
  872. description: Returned when te service is unavailable
  873. deprecated: true
  874. /events/search-extended:
  875. get:
  876. tags:
  877. - Event
  878. summary: API for search
  879. parameters:
  880. - name: q
  881. in: query
  882. description: Query String
  883. required: false
  884. type: string
  885. - $ref: '#/parameters/offset'
  886. - $ref: '#/parameters/limit'
  887. - $ref: '#/parameters/date_from'
  888. - $ref: '#/parameters/date_to'
  889. - $ref: '#/parameters/vertical_collection'
  890. - $ref: '#/parameters/category_collection'
  891. - $ref: '#/parameters/country_collection'
  892. - $ref: '#/parameters/city_collection'
  893. - name: minPrice
  894. in: query
  895. description: Minimum price for an event to be considered
  896. required: false
  897. type: string
  898. minimum: 0
  899. - name: maxPrice
  900. in: query
  901. description: Maximum price for an event to be considered
  902. required: false
  903. type: string
  904. minimum: 1
  905. - name: topFeature
  906. in: query
  907. description: Query String
  908. required: false
  909. type: string
  910. - name: sorting
  911. in: query
  912. description: Sorting strategy
  913. required: false
  914. type: string
  915. default: relevance
  916. enum:
  917. - relevance
  918. - venue-relevance
  919. - city-relevance
  920. - category-relevance
  921. - price
  922. - rating
  923. responses:
  924. '200':
  925. description: Returned when successful
  926. schema:
  927. $ref: '#/definitions/SearchResponse'
  928. '503':
  929. description: Returned when te service is unavailable
  930. '/events/{eventId}':
  931. get:
  932. tags:
  933. - Event
  934. summary: Get event by unique identifier
  935. parameters:
  936. - $ref: '#/parameters/eventId'
  937. responses:
  938. '200':
  939. description: Returned when successful
  940. schema:
  941. $ref: '#/definitions/Event'
  942. '404':
  943. description: Returned when resource is not found
  944. '503':
  945. description: Returned when the service is unavailable
  946. '/activities/{activityUuid}/contents/{localeCode}':
  947. get:
  948. tags:
  949. - Event
  950. - Activity
  951. summary: Get activity content for a specific locale
  952. parameters:
  953. - $ref: '#/parameters/activityUuid'
  954. - $ref: '#/parameters/localeCode'
  955. responses:
  956. '200':
  957. description: Returned when successful
  958. schema:
  959. $ref: '#/definitions/ActivityContent'
  960. '404':
  961. description: Returned when resource is not found
  962. '503':
  963. description: Returned when the service is unavailable
  964. '/events/{eventId}/contact-form':
  965. get:
  966. tags:
  967. - Event
  968. summary: Get Event contact form
  969. parameters:
  970. - $ref: '#/parameters/eventId'
  971. responses:
  972. '200':
  973. description: Returned when successful
  974. schema:
  975. $ref: '#/definitions/Category'
  976. '404':
  977. description: Returned when resource is not found
  978. '503':
  979. description: Returned when the service is unavailable
  980. '/events/{eventId}/contact-requests':
  981. post:
  982. tags:
  983. - Event
  984. summary: Send a contact request with submitted data.
  985. parameters:
  986. - $ref: '#/parameters/eventId'
  987. responses:
  988. '200':
  989. description: Returned when successful
  990. '400':
  991. description: Returned when the form has errors
  992. '/events/{eventId}/dates':
  993. get:
  994. tags:
  995. - Event
  996. - Date
  997. summary: Get available dates for an event
  998. parameters:
  999. - $ref: '#/parameters/eventId'
  1000. - name: date_from
  1001. in: query
  1002. description: 'Start date | If not specified set to today | Use format: YYYY-MM-DD'
  1003. required: false
  1004. type: string
  1005. - name: date_to
  1006. in: query
  1007. description: 'To date | If not specified set to next year | Use format: YYYY-MM-DD'
  1008. required: false
  1009. type: string
  1010. responses:
  1011. '200':
  1012. description: Returned when successful
  1013. schema:
  1014. $ref: '#/definitions/Date'
  1015. '404':
  1016. description: Returned when resource is not found
  1017. '503':
  1018. description: Returned when the service is unavailable
  1019. '/events/{eventId}/bundles':
  1020. get:
  1021. tags:
  1022. - Event
  1023. - Bundle
  1024. summary: Get bundles related to an event
  1025. parameters:
  1026. - $ref: '#/parameters/eventId'
  1027. responses:
  1028. '200':
  1029. description: Returned when successful
  1030. schema:
  1031. $ref: '#/definitions/Bundle'
  1032. '404':
  1033. description: Returned when resource is not found
  1034. '503':
  1035. description: Returned when the service is unavailable
  1036. '/events/{eventId}/schedule/{day}':
  1037. get:
  1038. tags:
  1039. - Event
  1040. - Date
  1041. summary: Get schedule for a day for an event
  1042. parameters:
  1043. - $ref: '#/parameters/eventId'
  1044. - $ref: '#/parameters/day'
  1045. - name: ticketsNumber
  1046. in: query
  1047. description: Number of ticket requested tickets |Only useful for real time events
  1048. required: false
  1049. type: string
  1050. responses:
  1051. '200':
  1052. description: Returned when successful
  1053. schema:
  1054. type: array
  1055. items:
  1056. $ref: '#/definitions/Schedule'
  1057. '404':
  1058. description: Returned when resource is not found
  1059. '503':
  1060. description: Returned when the service is unavailable
  1061. '/events/{eventId}/schedule/{day}/{giftCode}':
  1062. get:
  1063. tags:
  1064. - Event
  1065. - Date
  1066. summary: Get schedule for Gift and specific day
  1067. parameters:
  1068. - $ref: '#/parameters/eventId'
  1069. - $ref: '#/parameters/day'
  1070. - $ref: '#/parameters/giftCode'
  1071. responses:
  1072. '200':
  1073. description: Returned when successful
  1074. schema:
  1075. type: array
  1076. items:
  1077. $ref: '#/definitions/Schedule'
  1078. '404':
  1079. description: Returned when resource is not found
  1080. '503':
  1081. description: Returned when the service is unavailable
  1082. '/events/{eventId}/gift-schedule':
  1083. get:
  1084. tags:
  1085. - Event
  1086. - Date
  1087. summary: Get schedule for a 'Gift creation' for an Event
  1088. parameters:
  1089. - $ref: '#/parameters/eventId'
  1090. responses:
  1091. '200':
  1092. description: Returned when successful
  1093. schema:
  1094. $ref: '#/definitions/GiftSchedule'
  1095. '404':
  1096. description: Returned when Event is not found or is not giftable
  1097. '503':
  1098. description: Returned when the service is unavailable
  1099. /events:
  1100. get:
  1101. tags:
  1102. - Event
  1103. summary: Get events
  1104. parameters:
  1105. - name: ids
  1106. in: query
  1107. description: Filter on these events
  1108. required: true
  1109. type: array
  1110. items:
  1111. type: integer
  1112. collectionFormat: multi
  1113. responses:
  1114. '200':
  1115. description: Returned when successful
  1116. schema:
  1117. type: array
  1118. items:
  1119. $ref: '#/definitions/Event'
  1120. '404':
  1121. description: No resource found
  1122. '503':
  1123. description: Service unavailable
  1124. '/events/{eventId}/media':
  1125. get:
  1126. tags:
  1127. - Event
  1128. - Media
  1129. summary: Get all media for an event
  1130. parameters:
  1131. - $ref: '#/parameters/eventId'
  1132. responses:
  1133. '200':
  1134. description: Returned when successful
  1135. schema:
  1136. type: array
  1137. items:
  1138. $ref: '#/definitions/GalleryMedia'
  1139. '404':
  1140. description: No resource found
  1141. '503':
  1142. description: Service unavailable
  1143. '/feedback-requests/{feedbackRequestNonce}':
  1144. get:
  1145. tags:
  1146. - Event
  1147. - Comment
  1148. - Purchase experience
  1149. summary: Get feedback request details
  1150. parameters:
  1151. - name: feedbackRequestNonce
  1152. in: path
  1153. description: Feedback request nonce
  1154. required: true
  1155. type: string
  1156. responses:
  1157. '200':
  1158. description: Returned when successful
  1159. schema:
  1160. $ref: '#/definitions/FeedbackRequest'
  1161. '404':
  1162. description: No resource found
  1163. '503':
  1164. description: Service unavailable
  1165. '/carts/{cartId}/gifts':
  1166. post:
  1167. tags:
  1168. - Cart
  1169. summary: Create tailored Gift and add it to Cart
  1170. parameters:
  1171. - name: cartId
  1172. in: path
  1173. description: Cart Id
  1174. required: true
  1175. type: integer
  1176. - name: giftCreationRequest
  1177. in: body
  1178. description: Gift creation request
  1179. required: true
  1180. schema:
  1181. $ref: '#/definitions/GiftCreationRequest'
  1182. responses:
  1183. '200':
  1184. description: Returned when successful
  1185. schema:
  1186. $ref: '#/definitions/ResponseWithMessage'
  1187. '404':
  1188. description: Returned when resource is not found
  1189. '503':
  1190. description: Returned when the service is unavailable
  1191. '/carts/{cartId}/gifts/{giftCode}':
  1192. put:
  1193. tags:
  1194. - Cart
  1195. summary: >-
  1196. Redeem gift code with chosen date+time+language. Appropriate Tickets
  1197. with price 0 will be added to Cart
  1198. parameters:
  1199. - name: cartId
  1200. in: path
  1201. description: Cart Id
  1202. required: true
  1203. type: integer
  1204. - name: giftCode
  1205. in: path
  1206. description: Gift code
  1207. required: true
  1208. type: string
  1209. - name: giftRedeemRequest
  1210. in: body
  1211. description: Gift redeem request
  1212. required: true
  1213. schema:
  1214. $ref: '#/definitions/GiftRedeemRequest'
  1215. responses:
  1216. '200':
  1217. description: Returned when successful
  1218. schema:
  1219. $ref: '#/definitions/ResponseWithMessage'
  1220. '404':
  1221. description: Returned when resource is not found
  1222. '503':
  1223. description: Returned when the service is unavailable
  1224. /languages:
  1225. get:
  1226. tags:
  1227. - Language
  1228. summary: Get all the possible content languages
  1229. responses:
  1230. '200':
  1231. description: Returned when successful
  1232. '404':
  1233. description: Returned when resource is not found
  1234. '503':
  1235. description: Returned when the service is unavailable
  1236. /poi-types:
  1237. get:
  1238. tags:
  1239. - POI types
  1240. summary: Get all the POI types
  1241. responses:
  1242. '200':
  1243. description: Returned when successful
  1244. schema:
  1245. type: array
  1246. items:
  1247. $ref: '#/definitions/TranslatedMetadata'
  1248. '404':
  1249. description: Returned when resource is not found
  1250. '503':
  1251. description: Returned when the service is unavailable
  1252. /activity-languages:
  1253. get:
  1254. tags:
  1255. - Activity
  1256. summary: Get all possible languages for the activities
  1257. responses:
  1258. '200':
  1259. description: Returned when successful
  1260. schema:
  1261. type: array
  1262. items:
  1263. $ref: '#/definitions/TranslatedMetadata'
  1264. '404':
  1265. description: Returned when resource is not found
  1266. '503':
  1267. description: Returned when the service is unavailable
  1268. /features:
  1269. get:
  1270. tags:
  1271. - 'features, metadata'
  1272. summary: Get all the available features
  1273. responses:
  1274. '200':
  1275. description: Returned when successful
  1276. schema:
  1277. type: array
  1278. items:
  1279. $ref: '#/definitions/TranslatedMetadata'
  1280. '404':
  1281. description: Returned when resource is not found
  1282. '503':
  1283. description: Returned when the service is unavailable
  1284. /services:
  1285. get:
  1286. tags:
  1287. - 'services, metadata'
  1288. summary: Get all available services
  1289. responses:
  1290. '200':
  1291. description: Returned when successful
  1292. schema:
  1293. type: array
  1294. items:
  1295. $ref: '#/definitions/TranslatedMetadata'
  1296. '404':
  1297. description: Returned when resource is not found
  1298. '503':
  1299. description: Returned when the service is unavailable
  1300. /orders:
  1301. post:
  1302. tags:
  1303. - Order
  1304. summary: Create an order
  1305. parameters:
  1306. - name: cart_id
  1307. in: formData
  1308. description: ''
  1309. required: false
  1310. type: integer
  1311. responses:
  1312. '200':
  1313. description: Returned when successful
  1314. '404':
  1315. description: Returned when resource is not found
  1316. '503':
  1317. description: Returned when te service is unavailable
  1318. '/orders/{orderUuid}':
  1319. get:
  1320. tags:
  1321. - Order
  1322. summary: Get details for an order
  1323. parameters:
  1324. - name: orderUuid
  1325. in: path
  1326. description: Order Uuid
  1327. required: true
  1328. type: string
  1329. responses:
  1330. '200':
  1331. description: Returned when successful
  1332. schema:
  1333. $ref: '#/definitions/Order'
  1334. '404':
  1335. description: Returned when resource is not found
  1336. '503':
  1337. description: Returned when te service is unavailable
  1338. /payments/braintree/token:
  1339. post:
  1340. tags:
  1341. - Payment
  1342. - Order
  1343. - Braintree
  1344. summary: Create Braintree clientToken
  1345. responses:
  1346. '200':
  1347. description: Returned when successful
  1348. schema:
  1349. $ref: '#/definitions/PostClientToken'
  1350. '503':
  1351. description: Returned when the service is unavailable
  1352. /payments/braintree/payment:
  1353. post:
  1354. tags:
  1355. - Braintree
  1356. summary: Pay an order.
  1357. description: Pay an order using braintree.
  1358. parameters:
  1359. - name: braintreePayment
  1360. in: body
  1361. description: Braintree payment info request
  1362. required: true
  1363. schema:
  1364. $ref: '#/definitions/BraintreePaymentRequest'
  1365. responses:
  1366. '200':
  1367. description: Returned when payment was successful
  1368. schema:
  1369. $ref: '#/definitions/ResponseWithMessage'
  1370. '401':
  1371. description: Returned when Order does not belong to authenticated Customer
  1372. '404':
  1373. description: Returned when Order was not found
  1374. '422':
  1375. description: >-
  1376. Returned when there was error error during payment via Braintree
  1377. (wrong credit card number, bad CVV code, not enough balance, etc)
  1378. '423':
  1379. description: Returned when Order is already payed
  1380. '503':
  1381. description: Returned when the service isUnavailable
  1382. /payments/no/payment:
  1383. post:
  1384. tags:
  1385. - Order
  1386. summary: Apply the no-payment strategy.
  1387. description: >-
  1388. Apply the no-payment strategy for an order. You can use this strategy if
  1389. the cart amount is zero or if you have the special `NoPaymentStrategy`
  1390. grant
  1391. responses:
  1392. '200':
  1393. description: Returned when payment was successful
  1394. schema:
  1395. $ref: '#/definitions/ResponseWithMessage'
  1396. '404':
  1397. description: Returned when Order was not found
  1398. '422':
  1399. description: >-
  1400. Returned when Order amount is > 0 or other error during
  1401. NoPaymentStrategy
  1402. '423':
  1403. description: Returned when Order is already processed by NoPaymentStrategy
  1404. '503':
  1405. description: Returned when the service is unavailable
  1406. /payments/paypal/payment:
  1407. post:
  1408. tags:
  1409. - Paypal
  1410. summary: Pay an Order.
  1411. description: Pay an Order using Paypal.
  1412. parameters:
  1413. - name: paypalPayment
  1414. in: body
  1415. description: Paypal payment info request
  1416. required: true
  1417. schema:
  1418. $ref: '#/definitions/PaypalPaymentRequest'
  1419. responses:
  1420. '200':
  1421. description: Returned when payment was successful
  1422. schema:
  1423. $ref: '#/definitions/SuccessfulPayment'
  1424. '401':
  1425. description: Returned when Order does not belong to authenticated Customer
  1426. '404':
  1427. description: Returned when Order was not found
  1428. '422':
  1429. description: Returned when there was error error verifying payment via Paypal
  1430. '423':
  1431. description: Returned when Order is already payed
  1432. '503':
  1433. description: Returned when the service isUnavailable
  1434. /payments/stripe/stored_source_info:
  1435. get:
  1436. tags:
  1437. - Payment
  1438. - Order
  1439. - Stripe
  1440. summary: Get stored Stripe Source info
  1441. responses:
  1442. '200':
  1443. description: Returned when successful
  1444. '404':
  1445. description: Returned when no stored Stripe Source is found
  1446. '503':
  1447. description: Returned when the service is unavailable
  1448. /payments/stripe/payment:
  1449. post:
  1450. tags:
  1451. - Stripe
  1452. summary: Pay an order.
  1453. description: Pay an order using stripe.
  1454. parameters:
  1455. - name: stripePayment
  1456. in: body
  1457. description: Stripe payment info request
  1458. required: true
  1459. schema:
  1460. $ref: '#/definitions/StripePaymentRequest'
  1461. responses:
  1462. '200':
  1463. description: Returned when payment was successful
  1464. schema:
  1465. $ref: '#/definitions/SuccessfulPayment'
  1466. '401':
  1467. description: Returned when Order does not belong to authenticated Customer
  1468. '404':
  1469. description: Returned when Order was not found
  1470. '422':
  1471. description: >-
  1472. Returned when there was error error during payment via Stripe (wrong
  1473. credit card number, bad CVV code, not enough balance, etc)
  1474. '423':
  1475. description: Returned when Order is already payed
  1476. '503':
  1477. description: Returned when the service isUnavailable
  1478. /payments/stripe/complete_3d_secure:
  1479. post:
  1480. tags:
  1481. - Stripe
  1482. summary: Complete 3d secure payment.
  1483. description: Complete 3d secure payment after confirming it on card issuer page.
  1484. responses:
  1485. '200':
  1486. description: Returned when payment was successful
  1487. schema:
  1488. $ref: '#/definitions/SuccessfulPayment'
  1489. '401':
  1490. description: Returned when Order does not belong to authenticated Customer
  1491. '404':
  1492. description: Returned when Order was not found
  1493. '422':
  1494. description: >-
  1495. Returned when there was error error during payment via Stripe (wrong
  1496. credit card number, bad CVV code, not enough balance, etc)
  1497. '423':
  1498. description: Returned when Order is already payed
  1499. '503':
  1500. description: Returned when the service isUnavailable
  1501. '/pricetags/{id}':
  1502. get:
  1503. tags:
  1504. - Pricetag
  1505. summary: Get the name for a pricetag
  1506. parameters:
  1507. - name: id
  1508. in: path
  1509. description: ''
  1510. required: true
  1511. type: integer
  1512. responses:
  1513. '200':
  1514. description: Returned when successful
  1515. schema:
  1516. $ref: '#/definitions/Pricetag'
  1517. '404':
  1518. description: Returned when resource is not found
  1519. '503':
  1520. description: Returned when the service is unavailable
  1521. /proxy/auth/user:
  1522. post:
  1523. tags:
  1524. - API proxy
  1525. summary: POST Login using password grant type
  1526. responses:
  1527. '200':
  1528. description: Returned when successful
  1529. '400':
  1530. description: Returned when the login has errors
  1531. '503':
  1532. description: Returned when te service is unavailable
  1533. /proxy/auth/client:
  1534. post:
  1535. tags:
  1536. - API proxy
  1537. summary: POST Login using client_credentials grant type
  1538. responses:
  1539. '200':
  1540. description: Returned when successful
  1541. '400':
  1542. description: Returned when the login has errors
  1543. '503':
  1544. description: Returned when te service is unavailable
  1545. /login:
  1546. get:
  1547. tags:
  1548. - Security
  1549. summary: Login a user via OAuth 2
  1550. responses:
  1551. '200':
  1552. description: Returned when successful
  1553. '400':
  1554. description: Returned when the errors
  1555. '503':
  1556. description: Returned when the service is unavailable
  1557. /refresh:
  1558. get:
  1559. tags:
  1560. - Security
  1561. summary: Retrieve a fresh access token
  1562. responses:
  1563. '200':
  1564. description: Returned when successful
  1565. '400':
  1566. description: Returned when the errors
  1567. '503':
  1568. description: Returned when the service is unavailable
  1569. /signup/soft:
  1570. post:
  1571. tags:
  1572. - Security
  1573. summary: Register a new customer setting the softpassword
  1574. responses:
  1575. '200':
  1576. description: Returned when successful
  1577. '400':
  1578. description: Returned when the form has errors
  1579. '503':
  1580. description: Returned when te service is unavailable
  1581. /signup:
  1582. post:
  1583. tags:
  1584. - Security
  1585. summary: Begin a new signup process
  1586. responses:
  1587. '200':
  1588. description: Returned when successful
  1589. '400':
  1590. description: Returned when the form has errors
  1591. '503':
  1592. description: Returned when te service is unavailable
  1593. /signup/external_provider:
  1594. post:
  1595. tags:
  1596. - Security
  1597. summary: Register a new customer using external provider data
  1598. responses:
  1599. '200':
  1600. description: Returned when successful
  1601. schema:
  1602. $ref: '#/definitions/Customer'
  1603. '400':
  1604. description: Returned when the form has errors
  1605. '503':
  1606. description: Returned when te service is unavailable
  1607. /reset_password:
  1608. post:
  1609. tags:
  1610. - Security
  1611. summary: Send reset password email. This method always returns 204
  1612. parameters:
  1613. - name: email
  1614. in: formData
  1615. description: Email address of the user
  1616. required: true
  1617. type: string
  1618. responses:
  1619. '204':
  1620. description: Returned in all the other cases
  1621. '406':
  1622. description: Returned when there are wrong data in the request
  1623. /suggest:
  1624. get:
  1625. tags:
  1626. - Autosuggest
  1627. summary: Search relevant items in Musement DB
  1628. parameters:
  1629. - name: q
  1630. in: query
  1631. description: Search string. Minimum 3 chars
  1632. required: false
  1633. type: string
  1634. responses:
  1635. '200':
  1636. description: Returned when there are items.
  1637. '404':
  1638. description: Returned when no data are found.
  1639. /suppliers/me:
  1640. get:
  1641. tags:
  1642. - Security
  1643. summary: Get logged supplier data
  1644. responses:
  1645. '200':
  1646. description: Returned when successful
  1647. schema:
  1648. $ref: '#/definitions/Supplier'
  1649. '503':
  1650. description: Returned when the service is unavailable
  1651. /suppliers/me/price-features:
  1652. get:
  1653. tags:
  1654. - Security
  1655. summary: Get all available price features for the logged in supplier
  1656. responses:
  1657. '200':
  1658. description: Returned when successful
  1659. schema:
  1660. type: array
  1661. items:
  1662. $ref: '#/definitions/TranslatedMetadata'
  1663. '503':
  1664. description: Returned when the service is unavailable
  1665. /suppliers/me/ticket-holders:
  1666. get:
  1667. tags:
  1668. - Security
  1669. summary: Get all available ticket holders features for the logged in supplier
  1670. responses:
  1671. '200':
  1672. description: Returned when successful
  1673. schema:
  1674. type: array
  1675. items:
  1676. $ref: '#/definitions/TranslatedMetadata'
  1677. '503':
  1678. description: Returned when the service is unavailable
  1679. /suppliers/me/activities:
  1680. get:
  1681. tags:
  1682. - Security
  1683. summary: Get activities for the logged in supplier
  1684. parameters:
  1685. - $ref: '#/parameters/offset'
  1686. - $ref: '#/parameters/limit'
  1687. responses:
  1688. '200':
  1689. description: Returned when successful
  1690. schema:
  1691. type: array
  1692. items:
  1693. $ref: '#/definitions/Event'
  1694. '503':
  1695. description: Returned when the service is unavailable
  1696. '/customers/me/orders/{order_id}/tickets/{ticket_id}':
  1697. get:
  1698. tags:
  1699. - Order
  1700. summary: Get the details for a specific ticket
  1701. parameters:
  1702. - name: order_id
  1703. in: path
  1704. description: $order_id Order identifier
  1705. required: true
  1706. type: integer
  1707. - name: ticket_id
  1708. in: path
  1709. description: $ticket_id Ticket identifier
  1710. required: true
  1711. type: integer
  1712. responses:
  1713. '200':
  1714. description: Returned when successful
  1715. schema:
  1716. $ref: '#/definitions/Order'
  1717. '503':
  1718. description: Returned when the service is unavailable
  1719. '/venues/{venueId}':
  1720. get:
  1721. tags:
  1722. - Venue
  1723. summary: Get a venue
  1724. parameters:
  1725. - name: venueId
  1726. in: path
  1727. description: ''
  1728. required: true
  1729. type: integer
  1730. responses:
  1731. '200':
  1732. description: Returned when successful
  1733. '404':
  1734. description: Returned when resource is not found
  1735. '503':
  1736. description: Returned when the service is unavailable
  1737. '/venues/{venueId}/events':
  1738. get:
  1739. tags:
  1740. - Venue
  1741. - Event
  1742. summary: Get all events for a venue sorted by venue relevance.
  1743. description: >-
  1744. Get all events for an venue sorted by relevance. Only the events that
  1745. have at least one active date in the period specified between date_from
  1746. and date_to are returned. If date_from and date_to are not set then the
  1747. period that will be set will be one year from the date of the request'
  1748. parameters:
  1749. - $ref: '#/parameters/venueId'
  1750. - $ref: '#/parameters/vertical'
  1751. - $ref: '#/parameters/city'
  1752. - $ref: '#/parameters/category'
  1753. - $ref: '#/parameters/editorial-category'
  1754. - $ref: '#/parameters/date_from'
  1755. - $ref: '#/parameters/date_to'
  1756. - $ref: '#/parameters/offset'
  1757. - $ref: '#/parameters/limit'
  1758. - name: sort_by
  1759. in: query
  1760. description: Sorting strategy
  1761. required: false
  1762. type: string
  1763. default: venue-relevance
  1764. enum:
  1765. - relevance
  1766. - venue-relevance
  1767. - category-relevance
  1768. - price
  1769. - rating
  1770. responses:
  1771. '200':
  1772. description: Returned when successful
  1773. schema:
  1774. type: array
  1775. items:
  1776. $ref: '#/definitions/Event'
  1777. '404':
  1778. description: Returned when resource is not found
  1779. '503':
  1780. description: Returned when the service is unavailable
  1781. /verticals:
  1782. get:
  1783. tags:
  1784. - Vertical
  1785. summary: Get all verticals
  1786. parameters:
  1787. - $ref: '#/parameters/offset'
  1788. - $ref: '#/parameters/limit'
  1789. responses:
  1790. '200':
  1791. description: Returned when successful
  1792. '404':
  1793. description: Returned when resource is not found
  1794. '503':
  1795. description: Returned when the service is unavailable
  1796. '/verticals/{verticalId}/events':
  1797. get:
  1798. tags:
  1799. - Vertical
  1800. summary: Get all events for by vertical ID
  1801. parameters:
  1802. - $ref: '#/parameters/verticalId'
  1803. - $ref: '#/parameters/offset'
  1804. - $ref: '#/parameters/limit'
  1805. responses:
  1806. '200':
  1807. description: Returned when successful
  1808. '302':
  1809. description: Returned when more than 100 items requested
  1810. '404':
  1811. description: Returned when resource is not found
  1812. '503':
  1813. description: Returned when the service is unavailable
  1814. '/verticals/{verticalId}/categories':
  1815. get:
  1816. tags:
  1817. - Vertical
  1818. summary: Get categories by vertical ID
  1819. parameters:
  1820. - $ref: '#/parameters/verticalId'
  1821. - $ref: '#/parameters/offset'
  1822. - $ref: '#/parameters/limit'
  1823. responses:
  1824. '200':
  1825. description: Returned when successful
  1826. '302':
  1827. description: Returned when more than 100 items requested
  1828. '404':
  1829. description: Returned when resource is not found
  1830. '503':
  1831. description: Returned when the service is unavailable
  1832. '/wishes/{code}':
  1833. get:
  1834. tags:
  1835. - Wishlist
  1836. summary: Get a wish
  1837. parameters:
  1838. - name: code
  1839. in: path
  1840. description: 'Wish identifier in the form ''[wish-id]-[wishtype]'''
  1841. required: true
  1842. type: string
  1843. responses:
  1844. '200':
  1845. description: Returned when successful
  1846. schema:
  1847. $ref: '#/definitions/Wish'
  1848. '403':
  1849. description: When the user has no authorization on the item it's trying to view
  1850. '404':
  1851. description: The item to view doesn't exists
  1852. '503':
  1853. description: Returned when te service is unavailable
  1854. definitions:
  1855. Currency:
  1856. properties:
  1857. code:
  1858. type: string
  1859. name:
  1860. type: string
  1861. symbol:
  1862. type: string
  1863. is_top:
  1864. type: boolean
  1865. FormError:
  1866. properties:
  1867. code:
  1868. type: string
  1869. globalErrorMessage:
  1870. type: string
  1871. errors:
  1872. type: array
  1873. items:
  1874. $ref: '#/definitions/FormFieldError'
  1875. FormFieldError:
  1876. properties:
  1877. fieldName:
  1878. type: string
  1879. fieldErrorMessage:
  1880. type: string
  1881. ExtendedField: {}
  1882. ActivityContent:
  1883. xml:
  1884. name: ActivityContent
  1885. ActivityPoi:
  1886. properties:
  1887. latitude:
  1888. type: number
  1889. format: float
  1890. longitude:
  1891. type: number
  1892. format: float
  1893. types:
  1894. type: array
  1895. items:
  1896. $ref: '#/definitions/TranslatedMetadata'
  1897. xml:
  1898. name: ActivityPoi
  1899. ActivityTaxonomy:
  1900. properties:
  1901. uuid:
  1902. type: string
  1903. name:
  1904. type: string
  1905. category:
  1906. type: string
  1907. xml:
  1908. name: ActivityTaxonomy
  1909. Background:
  1910. properties:
  1911. id:
  1912. type: integer
  1913. slogan:
  1914. type: string
  1915. active:
  1916. type: boolean
  1917. coverImageUrl:
  1918. type: string
  1919. xml:
  1920. name: Background
  1921. Barcode:
  1922. properties:
  1923. code:
  1924. type: string
  1925. imageUrl:
  1926. type: string
  1927. used: {}
  1928. seasonPass: {}
  1929. xml:
  1930. name: Barcode
  1931. Blogger:
  1932. properties:
  1933. id:
  1934. type: string
  1935. name:
  1936. type: string
  1937. bio:
  1938. type: string
  1939. avatar:
  1940. type: string
  1941. socialUrl:
  1942. type: string
  1943. website:
  1944. type: string
  1945. xml:
  1946. name: Blogger
  1947. Blogpost:
  1948. properties:
  1949. id:
  1950. type: string
  1951. title:
  1952. type: string
  1953. abstract:
  1954. type: string
  1955. publishDate:
  1956. type: string
  1957. format: date-time
  1958. url:
  1959. type: string
  1960. backgroundImage:
  1961. type: string
  1962. backgroundImageCredits:
  1963. type: string
  1964. categories:
  1965. type: array
  1966. items:
  1967. $ref: '#/definitions/BlogpostCategory'
  1968. blocks:
  1969. type: string
  1970. city:
  1971. $ref: '#/definitions/City'
  1972. author:
  1973. $ref: '#/definitions/Blogger'
  1974. shareImage:
  1975. type: string
  1976. xml:
  1977. name: Blogpost
  1978. BlogpostBlock:
  1979. properties:
  1980. id:
  1981. type: string
  1982. xml:
  1983. name: BlogpostBlock
  1984. BlogpostBlockEmbeddedHtml:
  1985. properties:
  1986. embeddedCode:
  1987. type: string
  1988. type:
  1989. type: string
  1990. id:
  1991. type: string
  1992. xml:
  1993. name: BlogpostBlockEmbeddedHtml
  1994. BlogpostBlockImage:
  1995. properties:
  1996. url:
  1997. type: string
  1998. caption:
  1999. type: string
  2000. shareable:
  2001. type: boolean
  2002. id:
  2003. type: string
  2004. xml:
  2005. name: BlogpostBlockImage
  2006. BlogpostBlockText:
  2007. properties:
  2008. text:
  2009. type: string
  2010. id:
  2011. type: string
  2012. xml:
  2013. name: BlogpostBlockText
  2014. BlogpostCategory:
  2015. properties:
  2016. id:
  2017. type: string
  2018. code:
  2019. type: string
  2020. name:
  2021. type: string
  2022. slug:
  2023. type: string
  2024. description:
  2025. type: string
  2026. metaTitle:
  2027. type: string
  2028. backgroundImage:
  2029. type: string
  2030. xml:
  2031. name: BlogpostCategory
  2032. BlogpostCategoryAggregated:
  2033. properties:
  2034. blogpostCount:
  2035. type: integer
  2036. id:
  2037. type: string
  2038. code:
  2039. type: string
  2040. name:
  2041. type: string
  2042. slug:
  2043. type: string
  2044. description:
  2045. type: string
  2046. metaTitle:
  2047. type: string
  2048. backgroundImage:
  2049. type: string
  2050. xml:
  2051. name: BlogpostCategoryAggregated
  2052. Bucket:
  2053. properties:
  2054. id:
  2055. type: integer
  2056. code:
  2057. type: string
  2058. name:
  2059. type: string
  2060. xml:
  2061. name: Bucket
  2062. Bundle:
  2063. properties:
  2064. discount:
  2065. type: integer
  2066. discountType:
  2067. type: string
  2068. bundleType:
  2069. description: on_everything|from_second|no_discount
  2070. type: string
  2071. activities:
  2072. type: array
  2073. items:
  2074. $ref: '#/definitions/Event'
  2075. xml:
  2076. name: Bundle
  2077. Cart:
  2078. properties:
  2079. id:
  2080. type: integer
  2081. tickets:
  2082. type: array
  2083. items:
  2084. $ref: '#/definitions/Ticket'
  2085. discountCode:
  2086. title: discount_code
  2087. description: This is used only when the cart is posted/put/patched.
  2088. type: string
  2089. giftCard:
  2090. $ref: '#/definitions/GiftCard'
  2091. promoCode:
  2092. $ref: '#/definitions/PromoCode'
  2093. customer:
  2094. $ref: '#/definitions/Customer'
  2095. customerId:
  2096. type: integer
  2097. retailPrice:
  2098. $ref: '#/definitions/Price'
  2099. xml:
  2100. name: Cart
  2101. Category:
  2102. properties:
  2103. id:
  2104. type: integer
  2105. name:
  2106. type: string
  2107. level:
  2108. type: string
  2109. code:
  2110. type: string
  2111. eventImageUrl:
  2112. type: string
  2113. coverImageUrl:
  2114. type: string
  2115. url:
  2116. type: string
  2117. xml:
  2118. name: Category
  2119. CategoryAggregated:
  2120. properties:
  2121. eventCount:
  2122. type: integer
  2123. id:
  2124. type: integer
  2125. name:
  2126. type: string
  2127. level:
  2128. type: string
  2129. code:
  2130. type: string
  2131. eventImageUrl:
  2132. type: string
  2133. coverImageUrl:
  2134. type: string
  2135. url:
  2136. type: string
  2137. xml:
  2138. name: CategoryAggregated
  2139. City:
  2140. properties:
  2141. id:
  2142. type: integer
  2143. top:
  2144. description: Indicate if the event is a Musement 'top' event
  2145. type: boolean
  2146. hasConcierge:
  2147. description: True for cities with Musement's concierge service active
  2148. type: boolean
  2149. name:
  2150. description: City name
  2151. type: string
  2152. code:
  2153. description: City code. Do not depends on locale
  2154. type: string
  2155. content:
  2156. description: Description
  2157. type: string
  2158. more:
  2159. type: string
  2160. weight:
  2161. type: integer
  2162. latitude:
  2163. type: number
  2164. format: float
  2165. longitude:
  2166. type: number
  2167. format: float
  2168. country:
  2169. $ref: '#/definitions/Country'
  2170. coverImageUrl:
  2171. type: string
  2172. url:
  2173. type: string
  2174. eventsCount:
  2175. description: Number of active events
  2176. type: integer
  2177. xml:
  2178. name: City
  2179. CityAggregated:
  2180. properties:
  2181. eventCount:
  2182. type: integer
  2183. listCount:
  2184. type: integer
  2185. venueCount:
  2186. type: integer
  2187. showInPopular:
  2188. type: boolean
  2189. id:
  2190. type: integer
  2191. top:
  2192. description: Indicate if the event is a Musement 'top' event
  2193. type: boolean
  2194. hasConcierge:
  2195. description: True for cities with Musement's concierge service active
  2196. type: boolean
  2197. name:
  2198. description: City name
  2199. type: string
  2200. code:
  2201. description: City code. Do not depends on locale
  2202. type: string
  2203. content:
  2204. description: Description
  2205. type: string
  2206. more:
  2207. type: string
  2208. weight:
  2209. type: integer
  2210. latitude:
  2211. type: number
  2212. format: float
  2213. longitude:
  2214. type: number
  2215. format: float
  2216. country:
  2217. $ref: '#/definitions/Country'
  2218. coverImageUrl:
  2219. type: string
  2220. url:
  2221. type: string
  2222. eventsCount:
  2223. description: Number of active events
  2224. type: integer
  2225. xml:
  2226. name: CityAggregated
  2227. Comment:
  2228. properties:
  2229. status:
  2230. type: string
  2231. author:
  2232. $ref: '#/definitions/Customer'
  2233. locale:
  2234. type: string
  2235. pictures:
  2236. type: array
  2237. items:
  2238. type: string
  2239. title:
  2240. type: string
  2241. body:
  2242. type: string
  2243. rating:
  2244. type: number
  2245. format: float
  2246. sentAt:
  2247. type: string
  2248. format: date-time
  2249. event:
  2250. $ref: '#/definitions/Event'
  2251. xml:
  2252. name: Comment
  2253. ContentLanguage:
  2254. properties:
  2255. code:
  2256. type: string
  2257. name:
  2258. type: string
  2259. xml:
  2260. name: ContentLanguage
  2261. ContentManager:
  2262. xml:
  2263. name: ContentManager
  2264. Country:
  2265. properties:
  2266. id:
  2267. type: integer
  2268. name:
  2269. type: string
  2270. isoCode:
  2271. type: string
  2272. countryPrefix:
  2273. type: string
  2274. xml:
  2275. name: Country
  2276. Customer:
  2277. properties:
  2278. id:
  2279. type: integer
  2280. registrationType:
  2281. type: string
  2282. password:
  2283. type: string
  2284. email:
  2285. type: string
  2286. firstname:
  2287. type: string
  2288. lastname:
  2289. type: string
  2290. avatar:
  2291. type: string
  2292. country:
  2293. $ref: '#/definitions/Country'
  2294. currency:
  2295. type: string
  2296. zipcode:
  2297. type: string
  2298. state:
  2299. type: string
  2300. address:
  2301. type: string
  2302. id_number:
  2303. type: string
  2304. mobile:
  2305. type: string
  2306. city:
  2307. description: >-
  2308. This is a string ! It's the city of the address it has nothing to do
  2309. with musement city.
  2310. type: string
  2311. xml:
  2312. name: Customer
  2313. Date:
  2314. properties:
  2315. day:
  2316. type: string
  2317. soldOut:
  2318. type: boolean
  2319. price:
  2320. $ref: '#/definitions/Price'
  2321. discountedPrice:
  2322. $ref: '#/definitions/Price'
  2323. discountAmount:
  2324. $ref: '#/definitions/Price'
  2325. xml:
  2326. name: Date
  2327. Deeplink:
  2328. properties:
  2329. id:
  2330. type: string
  2331. type:
  2332. type: string
  2333. identifier:
  2334. type: string
  2335. apiUrl:
  2336. type: string
  2337. xml:
  2338. name: Deeplink
  2339. Destination:
  2340. properties:
  2341. id:
  2342. type: integer
  2343. verticals:
  2344. type: array
  2345. items:
  2346. $ref: '#/definitions/Vertical'
  2347. city:
  2348. $ref: '#/definitions/City'
  2349. saves:
  2350. type: integer
  2351. name:
  2352. type: string
  2353. canonicalUrl:
  2354. type: string
  2355. phone:
  2356. type: string
  2357. website:
  2358. type: string
  2359. priceRange:
  2360. type: integer
  2361. latitude:
  2362. type: number
  2363. format: float
  2364. longitude:
  2365. type: number
  2366. format: float
  2367. address:
  2368. type: string
  2369. photos:
  2370. type: array
  2371. items:
  2372. $ref: '#/definitions/DestinationPhoto'
  2373. comments:
  2374. type: array
  2375. items:
  2376. $ref: '#/definitions/DestinationComment'
  2377. openingHours:
  2378. type: array
  2379. items: {}
  2380. specialities:
  2381. type: array
  2382. items: {}
  2383. rating:
  2384. type: number
  2385. format: float
  2386. xml:
  2387. name: Destination
  2388. DestinationComment:
  2389. properties:
  2390. author:
  2391. $ref: '#/definitions/DestinationCommentAuthor'
  2392. title:
  2393. type: string
  2394. text:
  2395. type: string
  2396. date:
  2397. description: This value is saved as ISO 8601 string.
  2398. type: string
  2399. xml:
  2400. name: DestinationComment
  2401. DestinationCommentAuthor:
  2402. properties:
  2403. name:
  2404. type: string
  2405. avatar:
  2406. type: string
  2407. xml:
  2408. name: DestinationCommentAuthor
  2409. DestinationPhoto:
  2410. properties:
  2411. url:
  2412. type: string
  2413. title:
  2414. type: string
  2415. xml:
  2416. name: DestinationPhoto
  2417. EditorialCategory:
  2418. properties:
  2419. id:
  2420. type: integer
  2421. imageUrl:
  2422. type: string
  2423. active:
  2424. type: boolean
  2425. name:
  2426. type: string
  2427. subTitle:
  2428. type: string
  2429. content:
  2430. type: string
  2431. slug:
  2432. type: string
  2433. minEventsForFiltering:
  2434. type: integer
  2435. xml:
  2436. name: EditorialCategory
  2437. Event:
  2438. properties:
  2439. uuid:
  2440. description: Event unique identifier
  2441. type: string
  2442. city:
  2443. $ref: '#/definitions/City'
  2444. saves:
  2445. description: Number of customer who saved this city as favorite
  2446. type: integer
  2447. title:
  2448. type: string
  2449. relevance:
  2450. type: integer
  2451. relevanceVenue:
  2452. type: integer
  2453. maxConfirmationTime:
  2454. type: integer
  2455. mustSee:
  2456. type: boolean
  2457. lastChance:
  2458. type: boolean
  2459. topSeller:
  2460. type: boolean
  2461. printVoucher:
  2462. description: Voucher must be printed to access the activity
  2463. type: boolean
  2464. temporary:
  2465. type: boolean
  2466. description:
  2467. type: string
  2468. about:
  2469. type: string
  2470. aboutMarkdown:
  2471. type: string
  2472. aboutHtml:
  2473. type: string
  2474. meetingPoint:
  2475. type: string
  2476. openingHours:
  2477. type: string
  2478. duration: {}
  2479. validity: {}
  2480. numberedSeats:
  2481. type: boolean
  2482. hasPriceInfoOnDate:
  2483. description: 'If true the call GET /events/{id}/dates returns prices for each day.'
  2484. type: boolean
  2485. open:
  2486. description: >-
  2487. Define if the Event is with open dates entrance (aka:
  2488. Event::isOpenTicket).
  2489. type: boolean
  2490. ticketNotIncluded:
  2491. type: boolean
  2492. likelyToSellOut:
  2493. type: boolean
  2494. specialOffer:
  2495. type: boolean
  2496. exclusive:
  2497. type: boolean
  2498. includedHotelNightNumber:
  2499. type: integer
  2500. greenFeeDays:
  2501. type: integer
  2502. daily:
  2503. description: >-
  2504. Define if the Event is with "daily tickets" (aka:
  2505. Event::getDailyTickets)
  2506.  
  2507. This causes for example: to hide "time block" in Orderbox.
  2508. type: boolean
  2509. languages:
  2510. type: array
  2511. items:
  2512. $ref: '#/definitions/TranslatedMetadata'
  2513. groupSize:
  2514. type: array
  2515. items: {}
  2516. food:
  2517. type: array
  2518. items:
  2519. $ref: '#/definitions/TranslatedMetadata'
  2520. services:
  2521. type: array
  2522. items:
  2523. $ref: '#/definitions/TranslatedMetadata'
  2524. translated:
  2525. type: array
  2526. items: {}
  2527. features:
  2528. type: array
  2529. items:
  2530. $ref: '#/definitions/TranslatedMetadata'
  2531. highlights:
  2532. type: array
  2533. items:
  2534. type: string
  2535. included:
  2536. type: array
  2537. items:
  2538. type: string
  2539. notIncluded:
  2540. type: array
  2541. items:
  2542. type: string
  2543. isAvailableToday:
  2544. type: boolean
  2545. isAvailableTomorrow:
  2546. type: boolean
  2547. hasMultipleOptions:
  2548. type: boolean
  2549. coverImageUrl:
  2550. type: string
  2551. extraMediaUrl:
  2552. type: string
  2553. retailPrice:
  2554. $ref: '#/definitions/Price'
  2555. netPrice:
  2556. $ref: '#/definitions/Price'
  2557. bundledPrice:
  2558. $ref: '#/definitions/Price'
  2559. discount:
  2560. type: integer
  2561. bucket:
  2562. $ref: '#/definitions/Bucket'
  2563. categories:
  2564. type: array
  2565. items:
  2566. $ref: '#/definitions/Category'
  2567. reviewsNumber:
  2568. type: integer
  2569. reviewsAvg:
  2570. type: number
  2571. format: float
  2572. reviewsAggregatedInfo:
  2573. type: array
  2574. items: {}
  2575. latitude:
  2576. type: number
  2577. format: float
  2578. longitude:
  2579. type: number
  2580. format: float
  2581. url:
  2582. type: string
  2583. agencyUrls:
  2584. type: array
  2585. items:
  2586. type: string
  2587. agencyPrice:
  2588. $ref: '#/definitions/Price'
  2589. tags:
  2590. type: array
  2591. items:
  2592. $ref: '#/definitions/Tag'
  2593. flavours:
  2594. type: array
  2595. items:
  2596. $ref: '#/definitions/Flavour'
  2597. verticals:
  2598. type: array
  2599. items:
  2600. $ref: '#/definitions/Vertical'
  2601. orderBoxElements:
  2602. type: array
  2603. items:
  2604. type: string
  2605. giftable:
  2606. type: boolean
  2607. hasPassengerInfo:
  2608. type: boolean
  2609. hasExtraCustomerData:
  2610. type: boolean
  2611. realtimeCapable:
  2612. description: Define if the Event is "realtimeCapable".
  2613. type: boolean
  2614. xml:
  2615. name: Event
  2616. FeedbackRequest:
  2617. properties:
  2618. nonce:
  2619. type: string
  2620. type:
  2621. type: string
  2622. event:
  2623. $ref: '#/definitions/Event'
  2624. xml:
  2625. name: CommentRequest
  2626. Flavour:
  2627. properties:
  2628. id:
  2629. type: integer
  2630. name:
  2631. type: string
  2632. active:
  2633. type: boolean
  2634. img:
  2635. type: string
  2636. slug:
  2637. type: string
  2638. xml:
  2639. name: Flavour
  2640. GalleryMedia:
  2641. properties:
  2642. id:
  2643. type: integer
  2644. title:
  2645. type: string
  2646. url:
  2647. type: string
  2648. type:
  2649. type: string
  2650. externalIdentifier:
  2651. type: string
  2652. xml:
  2653. name: GalleryMedia
  2654. GenericEvent:
  2655. properties:
  2656. id:
  2657. type: integer
  2658. whereIs:
  2659. type: string
  2660. whenIs:
  2661. type: string
  2662. latitude:
  2663. type: number
  2664. format: float
  2665. longitude:
  2666. type: number
  2667. format: float
  2668. date:
  2669. type: string
  2670. price:
  2671. type: string
  2672. phone:
  2673. type: string
  2674. website:
  2675. type: string
  2676. rating:
  2677. type: integer
  2678. votes:
  2679. type: integer
  2680. city:
  2681. $ref: '#/definitions/City'
  2682. venue:
  2683. $ref: '#/definitions/Venue'
  2684. images:
  2685. type: array
  2686. items:
  2687. $ref: '#/definitions/GalleryMedia'
  2688. xml:
  2689. name: GenericEvent
  2690. GiftSchedule:
  2691. properties:
  2692. features:
  2693. type: array
  2694. items:
  2695. $ref: '#/definitions/GiftScheduleFeature'
  2696. xml:
  2697. name: GiftSchedule
  2698. GiftScheduleFeature:
  2699. properties:
  2700. featureCode:
  2701. type: string
  2702. name:
  2703. description: Name (label) of Feature.
  2704. type: string
  2705. description:
  2706. type: string
  2707. default:
  2708. type: boolean
  2709. products:
  2710. type: array
  2711. items:
  2712. $ref: '#/definitions/GiftScheduleProduct'
  2713. xml:
  2714. name: GiftScheduleFeature
  2715. GiftScheduleProduct:
  2716. properties:
  2717. holderCode:
  2718. type: string
  2719. name:
  2720. description: Name (label) of Holder.
  2721. type: string
  2722. type:
  2723. type: string
  2724. productId:
  2725. type: string
  2726. minBuy:
  2727. type: integer
  2728. maxBuy:
  2729. type: integer
  2730. availability:
  2731. type: integer
  2732. rawPrice:
  2733. description: >-
  2734. This is the price to the user without any discount applied. (same
  2735. currency as retailPrice)
  2736. $ref: '#/definitions/Price'
  2737. discountAmount:
  2738. description: >-
  2739. Amount of discount in same currency as retailPrice (only
  2740. SeatPrice.discount used because its not in Cart)
  2741. $ref: '#/definitions/Price'
  2742. retailPrice:
  2743. description: >-
  2744. Price with discount applied (only SeatPrice.discount used because its
  2745. not in Cart)
  2746. $ref: '#/definitions/Price'
  2747. serviceFee:
  2748. $ref: '#/definitions/Price'
  2749. xml:
  2750. name: ScheduleProduct
  2751. GiftCard:
  2752. properties:
  2753. id:
  2754. type: integer
  2755. code:
  2756. type: string
  2757. validFrom:
  2758. type: string
  2759. format: date-time
  2760. validUntil:
  2761. type: string
  2762. format: date-time
  2763. created:
  2764. type: string
  2765. format: date-time
  2766. updated:
  2767. type: string
  2768. format: date-time
  2769. xml:
  2770. name: GiftCard
  2771. ListType:
  2772. properties:
  2773. id:
  2774. type: integer
  2775. name:
  2776. type: string
  2777. xml:
  2778. name: ListType
  2779. MusementList:
  2780. properties:
  2781. id:
  2782. type: integer
  2783. title:
  2784. type: string
  2785. description:
  2786. type: string
  2787. authors:
  2788. type: array
  2789. items:
  2790. $ref: '#/definitions/Customer'
  2791. views:
  2792. type: integer
  2793. scroll:
  2794. type: integer
  2795. saves:
  2796. type: integer
  2797. listType:
  2798. $ref: '#/definitions/ListType'
  2799. city:
  2800. $ref: '#/definitions/City'
  2801. coverImageUrl:
  2802. type: string
  2803. verticals:
  2804. type: array
  2805. items:
  2806. $ref: '#/definitions/Vertical'
  2807. xml:
  2808. name: MusementList
  2809. MusementListGenericItem:
  2810. properties:
  2811. id:
  2812. type: integer
  2813. publicType:
  2814. type: string
  2815. title:
  2816. type: string
  2817. description:
  2818. type: string
  2819. genericEvent:
  2820. $ref: '#/definitions/GenericEvent'
  2821. xml:
  2822. name: MusementListGenericItem
  2823. MusementListMusementItem:
  2824. properties:
  2825. id:
  2826. type: integer
  2827. publicType:
  2828. type: string
  2829. title:
  2830. type: string
  2831. xml:
  2832. name: MusementListMusementItem
  2833. MusementListThirdpartyItem:
  2834. properties:
  2835. id:
  2836. type: integer
  2837. publicType:
  2838. type: string
  2839. title:
  2840. type: string
  2841. description:
  2842. type: string
  2843. destination:
  2844. $ref: '#/definitions/Destination'
  2845. xml:
  2846. name: MusementListThirdpartyItem
  2847. Order:
  2848. properties:
  2849. uuid:
  2850. description: Order unique identifier
  2851. type: string
  2852. date:
  2853. type: string
  2854. format: date-time
  2855. status:
  2856. type: string
  2857. tickets:
  2858. type: array
  2859. items:
  2860. $ref: '#/definitions/Ticket'
  2861. xml:
  2862. name: Order
  2863. Page:
  2864. properties:
  2865. id:
  2866. type: integer
  2867. title:
  2868. type: string
  2869. content:
  2870. type: string
  2871. xml:
  2872. name: Page
  2873. PassengerInfo:
  2874. properties:
  2875. salutation:
  2876. type: string
  2877. firstname:
  2878. type: string
  2879. lastname:
  2880. type: string
  2881. dateOfBirth:
  2882. title: date_of_birth
  2883. type: string
  2884. format: date-time
  2885. passport:
  2886. type: string
  2887. email:
  2888. type: string
  2889. passportExpiryDate:
  2890. title: passport_expiry_date
  2891. type: string
  2892. format: date-time
  2893. nationality:
  2894. type: string
  2895. medicalNotes:
  2896. title: medical_note
  2897. type: string
  2898. address:
  2899. type: string
  2900. fanCard:
  2901. description: /**
  2902. type: string
  2903. xml:
  2904. name: PassengerInfo
  2905. Price:
  2906. properties:
  2907. currency:
  2908. type: string
  2909. value:
  2910. type: number
  2911. format: float
  2912. formattedValue:
  2913. type: number
  2914. format: float
  2915. xml:
  2916. name: Price
  2917. Pricetag:
  2918. properties:
  2919. id:
  2920. type: integer
  2921. code:
  2922. type: string
  2923. priceFeature:
  2924. type: string
  2925. ticketHolder:
  2926. type: string
  2927. name:
  2928. type: string
  2929. group:
  2930. type: string
  2931. xml:
  2932. name: Pricetag
  2933. Product:
  2934. properties:
  2935. id:
  2936. description: >-
  2937. This is a unique identifier of the product. For Musement's product
  2938. this is the SeatPriceId
  2939.  
  2940. for 3rd party product is the unique identifier of the partner's
  2941. product.
  2942.  
  2943.  
  2944. Please note that this is a string
  2945. type: string
  2946. type:
  2947. type: string
  2948. title:
  2949. type: string
  2950. datetime:
  2951. type: string
  2952. format: date-time
  2953. touristCategory:
  2954. type: string
  2955. activityName:
  2956. type: string
  2957. activity:
  2958. $ref: '#/definitions/Event'
  2959. image:
  2960. type: string
  2961. finalPrice:
  2962. $ref: '#/definitions/Price'
  2963. discountAmount:
  2964. $ref: '#/definitions/Price'
  2965. serviceFee:
  2966. $ref: '#/definitions/Price'
  2967. xml:
  2968. name: Product
  2969. PromoCode:
  2970. properties:
  2971. code:
  2972. type: string
  2973. active:
  2974. type: boolean
  2975. percentage:
  2976. type: boolean
  2977. discount:
  2978. type: integer
  2979. maxUsage:
  2980. type: integer
  2981. validFrom:
  2982. type: string
  2983. format: date-time
  2984. validUntil:
  2985. type: string
  2986. format: date-time
  2987. minimumAmount:
  2988. type: number
  2989. format: float
  2990. xml:
  2991. name: PromoCode
  2992. Activity:
  2993. xml:
  2994. name: Activity
  2995. BraintreePaymentRequest:
  2996. properties:
  2997. orderId:
  2998. type: integer
  2999. nonce:
  3000. description: >-
  3001. Braintree "nonce" created on "client side". If provided then don't
  3002. provide "paymentMethodToken".
  3003. paymentMethodToken:
  3004. description: >-
  3005. Braintree "paymentMethodToken". If provided then don't provide
  3006. "nonce".
  3007. clientIp:
  3008. description: '[optional] User IP address for logging purposes.'
  3009. type: string
  3010. cardholderName:
  3011. description: >-
  3012. [optional] Credit card holder name. Required for iOS integration
  3013. because its missing in "tokenizeCard" function there. Include it only
  3014. if you pass "nonce" parameter.
  3015. type: string
  3016. xml:
  3017. name: BraintreePaymentRequest
  3018. CartRequest:
  3019. properties:
  3020. tickets:
  3021. type: array
  3022. items:
  3023. $ref: '#/definitions/TicketRequest'
  3024. customer:
  3025. $ref: '#/definitions/CustomerRequest'
  3026. discountCode:
  3027. title: discount_code
  3028. type: string
  3029. xml:
  3030. name: CartRequest
  3031. CityRequest:
  3032. properties:
  3033. id:
  3034. type: integer
  3035. xml:
  3036. name: CityRequest
  3037. CountryRequest:
  3038. properties:
  3039. id:
  3040. type: integer
  3041. name:
  3042. type: string
  3043. xml:
  3044. name: CountryRequest
  3045. CustomerRequest:
  3046. properties:
  3047. favouriteCity:
  3048. $ref: '#/definitions/CityRequest'
  3049. email:
  3050. type: string
  3051. firstname:
  3052. type: string
  3053. lastname:
  3054. type: string
  3055. country:
  3056. $ref: '#/definitions/CountryRequest'
  3057. zipcode:
  3058. type: string
  3059. state:
  3060. type: string
  3061. city:
  3062. description: >-
  3063. This is a string ! It's the city of the address it has nothing to do
  3064. with musement city.
  3065. type: string
  3066. address:
  3067. type: string
  3068. idNumber:
  3069. title: id_number
  3070. type: string
  3071. mobile:
  3072. type: string
  3073. currency:
  3074. type: string
  3075. vatNumber:
  3076. type: string
  3077. birthdate:
  3078. type: string
  3079. format: date-time
  3080. xml:
  3081. name: CustomerRequest
  3082. GiftCreationProductWithQuantity:
  3083. properties:
  3084. holderCode:
  3085. type: string
  3086. quantity:
  3087. type: integer
  3088. xml:
  3089. name: GiftCreationProductWithQuantity
  3090. GiftCreationRequest:
  3091. properties:
  3092. eventId:
  3093. type: integer
  3094. donorName:
  3095. type: string
  3096. message:
  3097. type: string
  3098. pictureUrl:
  3099. type: string
  3100. print:
  3101. type: boolean
  3102. recipientEmail:
  3103. description: Optional if print is true.
  3104. type: string
  3105. recipientName:
  3106. type: string
  3107. featureCode:
  3108. type: string
  3109. productsWithQuantities:
  3110. type: array
  3111. items:
  3112. $ref: '#/definitions/GiftCreationProductWithQuantity'
  3113. xml:
  3114. name: GiftCreationRequest
  3115. GiftRedeemRequest:
  3116. properties:
  3117. date:
  3118. description: This is optional - for example when open ticket.
  3119. type: string
  3120. time:
  3121. description: This is optional - for example when open ticket.
  3122. type: string
  3123. language:
  3124. description: This is optional - when Event doesnt have languages to choose.
  3125. type: string
  3126. xml:
  3127. name: GiftRedeemRequest
  3128. PassengerInfoRequest:
  3129. properties:
  3130. salutation:
  3131. type: string
  3132. firstname:
  3133. type: string
  3134. lastname:
  3135. type: string
  3136. dateOfBirth:
  3137. type: string
  3138. format: date-time
  3139. passport:
  3140. type: string
  3141. email:
  3142. type: string
  3143. passportExpiryDate:
  3144. type: string
  3145. format: date-time
  3146. nationality:
  3147. type: string
  3148. medicalNotes:
  3149. type: string
  3150. address:
  3151. type: string
  3152. fanCard:
  3153. type: string
  3154. xml:
  3155. name: PassengerInfoRequest
  3156. PaypalPaymentRequest:
  3157. properties:
  3158. orderId:
  3159. type: integer
  3160. paypalPaymentId:
  3161. description: Paypal "payment id" obtained on "client side".
  3162. type: string
  3163. clientIp:
  3164. description: '[optional] User IP address for logging purposes.'
  3165. type: string
  3166. xml:
  3167. name: PaypalPaymentRequest
  3168. ProductRequest:
  3169. properties:
  3170. id:
  3171. type: string
  3172. type:
  3173. type: string
  3174. xml:
  3175. name: ProductRequest
  3176. PurchaseExperience:
  3177. properties:
  3178. locale:
  3179. type: string
  3180. title:
  3181. type: string
  3182. text:
  3183. type: string
  3184. rating:
  3185. type: integer
  3186. xml:
  3187. name: PurchaseExperience
  3188. StripePaymentRequest:
  3189. properties:
  3190. orderId:
  3191. type: integer
  3192. stripeToken:
  3193. description: >-
  3194. Stripe token created on "client side". If provided then don't provide
  3195. "stripeSourceId".
  3196. stripeSourceId:
  3197. description: Stripe "Source id". If provided then don't provide "stripeToken".
  3198. clientIp:
  3199. description: '[optional] User IP address for logging purposes.'
  3200. type: string
  3201. xml:
  3202. name: StripePaymentRequest
  3203. TicketRequest:
  3204. properties:
  3205. product:
  3206. $ref: '#/definitions/Product'
  3207. quantity:
  3208. type: integer
  3209. passengersInfo:
  3210. title: passengers_info
  3211. type: array
  3212. items:
  3213. $ref: '#/definitions/PassengerInfoRequest'
  3214. metadata:
  3215. $ref: '#/definitions/TicketMetadataRequest'
  3216. xml:
  3217. name: TicketRequest
  3218. TicketMetadataRequest:
  3219. properties:
  3220. language:
  3221. type: string
  3222. note:
  3223. type: string
  3224. extended_fields:
  3225. type: array
  3226. items:
  3227. $ref: '#/definitions/ExtendedField'
  3228. xml:
  3229. name: TicketMetadataRequest
  3230. PostClientToken:
  3231. xml:
  3232. name: PostClientToken
  3233. SuccessfulPayment:
  3234. xml:
  3235. name: PaypalPayment
  3236. ResponseWithMessage:
  3237. xml:
  3238. name: ResponseWithMessage
  3239. SearchResponse:
  3240. xml:
  3241. name: SearchResponse
  3242. RedirectTo3dSecureCardIssuer:
  3243. xml:
  3244. name: RedirectTo3dSecureCardIssuer
  3245. Wish:
  3246. properties:
  3247. code:
  3248. type: string
  3249. itemId:
  3250. type: integer
  3251. itemType:
  3252. type: string
  3253. title:
  3254. type: string
  3255. description:
  3256. type: string
  3257. coverImageUrl:
  3258. type: string
  3259. city:
  3260. $ref: '#/definitions/City'
  3261. latitude:
  3262. type: number
  3263. format: float
  3264. longitude:
  3265. type: number
  3266. format: float
  3267. xml:
  3268. name: Wish
  3269. Review:
  3270. properties:
  3271. locale:
  3272. type: string
  3273. rating:
  3274. type: integer
  3275. picture:
  3276. type: string
  3277. title:
  3278. type: string
  3279. body:
  3280. type: string
  3281. sentAt:
  3282. type: string
  3283. format: date-time
  3284. approvedAt:
  3285. type: string
  3286. format: date-time
  3287. xml:
  3288. name: Review
  3289. Schedule:
  3290. properties:
  3291. groups:
  3292. type: array
  3293. items:
  3294. $ref: '#/definitions/ScheduleGroup'
  3295. xml:
  3296. name: Schedule
  3297. ScheduleGroup:
  3298. properties:
  3299. featureCode:
  3300. type: string
  3301. name:
  3302. description: Name (label) of Feature.
  3303. type: string
  3304. description:
  3305. type: string
  3306. default:
  3307. type: boolean
  3308. slots:
  3309. type: array
  3310. items:
  3311. $ref: '#/definitions/ScheduleSlot'
  3312. xml:
  3313. name: ScheduleGroup
  3314. ScheduleProduct:
  3315. properties:
  3316. holderCode:
  3317. type: string
  3318. name:
  3319. description: Name (label) of Holder.
  3320. type: string
  3321. type:
  3322. type: string
  3323. productId:
  3324. type: string
  3325. minBuy:
  3326. type: integer
  3327. maxBuy:
  3328. type: integer
  3329. availability:
  3330. type: integer
  3331. rawPrice:
  3332. description: >-
  3333. This is the price to the user without any discount applied. (same
  3334. currency as retailPrice)
  3335. $ref: '#/definitions/Price'
  3336. discountAmount:
  3337. description: >-
  3338. Amount of discount in same currency as retailPrice (only
  3339. SeatPrice.discount used because its not in Cart)
  3340. $ref: '#/definitions/Price'
  3341. retailPrice:
  3342. description: >-
  3343. Price with discount applied (only SeatPrice.discount used because its
  3344. not in Cart)
  3345. $ref: '#/definitions/Price'
  3346. serviceFee:
  3347. $ref: '#/definitions/Price'
  3348. xml:
  3349. name: ScheduleProduct
  3350. ScheduleSlot:
  3351. properties:
  3352. time:
  3353. type: string
  3354. languages:
  3355. type: array
  3356. items:
  3357. $ref: '#/definitions/TranslatedMetadata'
  3358. products:
  3359. type: array
  3360. items:
  3361. $ref: '#/definitions/ScheduleProduct'
  3362. xml:
  3363. name: ScheduleSlot
  3364. SeatPrice:
  3365. properties:
  3366. id:
  3367. type: integer
  3368. event:
  3369. $ref: '#/definitions/Event'
  3370. priceTag:
  3371. $ref: '#/definitions/Pricetag'
  3372. rawPrice:
  3373. description: >-
  3374. This is the price to the user without any discount applied. (same
  3375. currency as retailPrice)
  3376. $ref: '#/definitions/Price'
  3377. discountAmount:
  3378. description: >-
  3379. Amount of discount in same currency as retailPrice (only
  3380. SeatPrice.discount used because its not in Cart)
  3381. $ref: '#/definitions/Price'
  3382. retailPrice:
  3383. description: >-
  3384. Price with discount applied (only SeatPrice.discount used because its
  3385. not in Cart)
  3386. $ref: '#/definitions/Price'
  3387. serviceFee:
  3388. $ref: '#/definitions/Price'
  3389. datetime:
  3390. type: integer
  3391. xml:
  3392. name: SeatPrice
  3393. Supplier:
  3394. properties:
  3395. uuid:
  3396. type: string
  3397. name:
  3398. type: string
  3399. contactEmail:
  3400. type: string
  3401. contactNumber:
  3402. type: string
  3403. xml:
  3404. name: Supplier
  3405. Tag:
  3406. properties:
  3407. id:
  3408. type: integer
  3409. name:
  3410. type: string
  3411. xml:
  3412. name: Tag
  3413. Ticket:
  3414. properties:
  3415. uuid:
  3416. description: Ticket unique identifier
  3417. type: string
  3418. cartId:
  3419. type: integer
  3420. product:
  3421. $ref: '#/definitions/Product'
  3422. code:
  3423. type: string
  3424. quantity:
  3425. type: integer
  3426. totalPrice:
  3427. $ref: '#/definitions/Price'
  3428. bundle: {}
  3429. passengersInfo:
  3430. type: array
  3431. items:
  3432. $ref: '#/definitions/PassengerInfo'
  3433. metadata:
  3434. $ref: '#/definitions/TicketMetadata'
  3435. status:
  3436. type: string
  3437. vouchers:
  3438. type: array
  3439. items:
  3440. type: string
  3441. xml:
  3442. name: Ticket
  3443. TicketMetadata:
  3444. properties:
  3445. language:
  3446. type: string
  3447. note:
  3448. type: string
  3449. extendedFields:
  3450. type: array
  3451. items: {}
  3452. xml:
  3453. name: TicketMetadata
  3454. TranslatedMetadata:
  3455. properties:
  3456. code:
  3457. type: string
  3458. name:
  3459. type: string
  3460. extra:
  3461. type: array
  3462. items:
  3463. type: string
  3464. xml:
  3465. name: TranslatedMetadata
  3466. Venue:
  3467. properties:
  3468. id:
  3469. type: integer
  3470. city:
  3471. $ref: '#/definitions/City'
  3472. name:
  3473. type: string
  3474. headline:
  3475. type: string
  3476. latitude:
  3477. type: number
  3478. format: float
  3479. longitude:
  3480. type: number
  3481. format: float
  3482. relevance:
  3483. type: integer
  3484. description:
  3485. type: string
  3486. descriptionHtml:
  3487. type: string
  3488. address:
  3489. type: string
  3490. events:
  3491. type: array
  3492. items:
  3493. $ref: '#/definitions/Event'
  3494. verticals:
  3495. type: array
  3496. items:
  3497. $ref: '#/definitions/Vertical'
  3498. coverImageUrl:
  3499. type: string
  3500. eventsCount:
  3501. type: integer
  3502. url:
  3503. type: string
  3504. country:
  3505. $ref: '#/definitions/Country'
  3506. showCalendar:
  3507. type: boolean
  3508. showFlavoursFilter:
  3509. type: boolean
  3510. showFiltersWhenEventsCount:
  3511. type: integer
  3512. xml:
  3513. name: Venue
  3514. Vertical:
  3515. properties:
  3516. id:
  3517. type: integer
  3518. name:
  3519. type: string
  3520. active:
  3521. type: boolean
  3522. code:
  3523. type: string
  3524. slug:
  3525. type: string
  3526. sectionTitle:
  3527. type: string
  3528. coverImageUrl:
  3529. type: string
  3530. topEvents:
  3531. type: array
  3532. items:
  3533. $ref: '#/definitions/Event'
  3534. relevance:
  3535. type: integer
  3536. xml:
  3537. name: Vertical
  3538. VerticalAggregated:
  3539. properties:
  3540. count:
  3541. type: integer
  3542. id:
  3543. type: integer
  3544. name:
  3545. type: string
  3546. active:
  3547. type: boolean
  3548. code:
  3549. type: string
  3550. slug:
  3551. type: string
  3552. sectionTitle:
  3553. type: string
  3554. coverImageUrl:
  3555. type: string
  3556. topEvents:
  3557. type: array
  3558. items:
  3559. $ref: '#/definitions/Event'
  3560. relevance:
  3561. type: integer
  3562. xml:
  3563. name: VerticalAggregated
  3564. parameters:
  3565. limit:
  3566. name: limit
  3567. in: query
  3568. description: Max number of items in the response
  3569. required: false
  3570. type: integer
  3571. default: 10
  3572. maximum: 100
  3573. offset:
  3574. name: offset
  3575. in: query
  3576. description: Pagination offset
  3577. required: false
  3578. type: integer
  3579. default: 0
  3580. minimum: 0
  3581. cartId:
  3582. name: cartId
  3583. in: path
  3584. description: Cart identifier
  3585. required: true
  3586. type: integer
  3587. categoryId:
  3588. name: categoryId
  3589. in: path
  3590. description: Category identifier
  3591. required: true
  3592. type: integer
  3593. verticalId:
  3594. name: verticalId
  3595. in: path
  3596. description: Vertical identifier
  3597. required: true
  3598. type: integer
  3599. eventId:
  3600. name: eventId
  3601. in: path
  3602. description: Event identifier
  3603. required: true
  3604. type: integer
  3605. activityUuid:
  3606. name: activityUuid
  3607. in: path
  3608. description: Activity identifier
  3609. required: true
  3610. type: string
  3611. editorialcategoryId:
  3612. name: editorialcategoryId
  3613. in: path
  3614. description: Editorial category identifier
  3615. required: true
  3616. type: integer
  3617. destinationId:
  3618. name: destinationId
  3619. in: path
  3620. description: Destination identifier
  3621. required: true
  3622. type: integer
  3623. countryId:
  3624. name: countryId
  3625. in: path
  3626. description: Country identifier
  3627. required: true
  3628. type: integer
  3629. cityId:
  3630. name: cityId
  3631. in: path
  3632. description: City identifier
  3633. required: true
  3634. type: integer
  3635. venueId:
  3636. name: venueId
  3637. in: path
  3638. description: Venue identifier
  3639. required: true
  3640. type: integer
  3641. day:
  3642. name: day
  3643. in: path
  3644. description: 'Day | Use format: YYYY-MM-DD'
  3645. required: true
  3646. type: string
  3647. vertical:
  3648. name: vertical
  3649. in: query
  3650. description: Vertical identifier
  3651. required: false
  3652. type: integer
  3653. city:
  3654. name: city
  3655. in: query
  3656. description: City identifier
  3657. required: false
  3658. type: integer
  3659. venue:
  3660. name: venue
  3661. in: query
  3662. description: Venue identifier
  3663. required: false
  3664. type: integer
  3665. editorial-category:
  3666. name: editorial-category
  3667. in: query
  3668. description: Editorial category identifier
  3669. required: false
  3670. type: integer
  3671. category:
  3672. name: category
  3673. in: query
  3674. description: Category identifier
  3675. required: false
  3676. type: integer
  3677. giftCode:
  3678. name: giftCode
  3679. in: path
  3680. description: Gift code
  3681. required: true
  3682. type: string
  3683. vertical_collection:
  3684. name: vertical_collection
  3685. in: query
  3686. description: List of verticals comma separated
  3687. required: false
  3688. type: array
  3689. items:
  3690. type: string
  3691. collectionFormat: csv
  3692. category_collection:
  3693. name: category_collection
  3694. in: query
  3695. description: List of categories comma separated
  3696. required: false
  3697. type: array
  3698. items:
  3699. type: string
  3700. collectionFormat: csv
  3701. country_collection:
  3702. name: country_collection
  3703. in: query
  3704. description: List of countries comma separated
  3705. required: false
  3706. type: array
  3707. items:
  3708. type: string
  3709. collectionFormat: csv
  3710. city_collection:
  3711. name: city_collection
  3712. in: query
  3713. description: List of cities comma separated
  3714. required: false
  3715. type: array
  3716. items:
  3717. type: string
  3718. collectionFormat: csv
  3719. date_from:
  3720. name: date_from
  3721. in: query
  3722. description: 'Start date | Use format: YYYY-MM-DD'
  3723. required: false
  3724. type: string
  3725. date_to:
  3726. name: date_to
  3727. in: query
  3728. description: 'To date | Use format: YYYY-MM-DD'
  3729. required: false
  3730. type: string
  3731. localeCode:
  3732. name: localeCode
  3733. in: path
  3734. description: Locale code
  3735. required: true
  3736. type: string
  3737. securityDefinitions:
  3738. Bearer:
  3739. type: apiKey
  3740. name: Authorization
  3741. in: header
  3742. musement_client_credential_auth:
  3743. type: oauth2
  3744. flow: application
  3745. tokenUrl: /login
  3746. externalDocs:
  3747. description: Find out more about Musement API
  3748. url: 'http://musement.gelato.io'
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!