API tools faq
paste
calvinturbo

apiary Schedular

calvinturbo
Jun 21st, 2017
579
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 34.81 KB | None | 0 0
raw download clone embed print report
  1. # this is an example of the Uber API
  2. # as a demonstration of an API spec in YAML
  3. swagger: '2.0'
  4. info:
  5. title: Schedular API
  6. description: Use Schedular APIs to book rooms and people
  7. version: "1.0.0"
  8. # the domain of the service
  9. host: api.schedular.eu
  10. # array of all schemes that your API supports
  11. schemes:
  12. - https
  13. # will be prefixed to all paths
  14. basePath: /api/v1
  15. produces:
  16. - application/json
  17. paths:
  18. /projectinternus/companies:
  19. get:
  20. summary: Get all companies
  21. description: Get all project internus companies
  22. tags:
  23. - Project Internus
  24. responses:
  25. 200:
  26. description: Array with companies info
  27. /projectinternus/isRoomAvailable:
  28. get:
  29. summary: Is a room available?
  30. description: Is a chosen room available at a certain datetime
  31. parameters:
  32. - name: room_id
  33. in: formData
  34. description: room ID of the room you want to check
  35. type: string
  36. - name: start
  37. in: formData
  38. description: UNIX_TIMESTAMP of start datetime appointment
  39. required: true
  40. type: integer
  41. format: int64
  42. default: 1485526345
  43. - name: duration
  44. in: formData
  45. description: Duration in minutes
  46. required: true
  47. type: integer
  48. format: int64
  49. default: 60
  50. - name: people
  51. in: formData
  52. description: Amount of people
  53. required: true
  54. type: integer
  55. format: int64
  56. default: 5
  57. tags:
  58. - Project Internus
  59. responses:
  60. 200:
  61. description: JSON response of rooms with info and availability
  62. examples:
  63. application/json:
  64. room_id: 1
  65. company_id: 1
  66. name: The Kid Room
  67. people_capacity: 10
  68. image_url: https://yolodetolo.com/image.jpg
  69. description: Stupid children making noise
  70. schema:
  71. type: array
  72. items:
  73. type: array
  74. properties:
  75. room_id:
  76. type: integer
  77. format: int64
  78. name:
  79. type: string
  80. people_capacity:
  81. type: integer
  82. format: int64
  83. image_url:
  84. type: string
  85. description:
  86. type: string
  87. /projectinternus/AvailableRooms:
  88. get:
  89. summary: Get available rooms
  90. description: Get available rooms with specific parameters sent
  91. parameters:
  92. - name: start
  93. in: formData
  94. description: UNIX_TIMESTAMP of start datetime appointment
  95. required: true
  96. type: integer
  97. format: int64
  98. default: 1485526345
  99. - name: duration
  100. in: formData
  101. description: Duration in minutes
  102. required: true
  103. type: integer
  104. format: int64
  105. default: 60
  106. - name: people
  107. in: formData
  108. description: Amount of people
  109. required: true
  110. type: integer
  111. format: int64
  112. default: 5
  113. - name: chash
  114. in: header
  115. description: Hash to authorize actions with a certain company
  116. required: true
  117. type: string
  118. tags:
  119. - Project Internus
  120. responses:
  121. 200:
  122. description: JSON response of rooms with info and availability
  123. examples:
  124. application/json:
  125. room_id: 1
  126. company_id: 1
  127. name: The Kid Room
  128. people_capacity: 10
  129. image_url: https://yolodetolo.com/image.jpg
  130. description: Stupid children making noise
  131. schema:
  132. type: array
  133. items:
  134. type: array
  135. properties:
  136. room_id:
  137. type: integer
  138. format: int64
  139. name:
  140. type: string
  141. people_capacity:
  142. type: integer
  143. format: int64
  144. image_url:
  145. type: string
  146. description:
  147. type: string
  148. /projectinternus/confirmAppointment:
  149. post:
  150. summary: Confirm an Appointment
  151. description: |
  152. This function is used to save the appointment
  153. parameters:
  154. - name: auth
  155. in: header
  156. description: Auth0 JWT
  157. required: true
  158. type: integer
  159. format: int64
  160. default: AUTH0_ID_TOKEN_HERE
  161. - name: appointment_startdate
  162. in: formData
  163. description: UNIX_TIMESTAMP of start datetime appointment
  164. required: true
  165. type: integer
  166. format: int64
  167. default: 1485526345
  168. - name: duration
  169. in: formData
  170. description: Duration in minutes
  171. required: true
  172. type: integer
  173. format: int64
  174. default: 60
  175. - name: people
  176. in: formData
  177. description: Amount of people
  178. required: true
  179. type: integer
  180. format: int64
  181. default: 5
  182. - name: title
  183. in: formData
  184. description: Title of appointment
  185. required: false
  186. type: string
  187. - name: description
  188. in: formData
  189. description: Description of appointment (and/or notes)
  190. required: false
  191. type: string
  192. - name: members
  193. in: formData
  194. description: Everyone in the ´CC´ field
  195. required: true
  196. type: array
  197. items:
  198. type: string
  199. minLength: 5
  200. - name: room_id
  201. in: formData
  202. description: Room ID
  203. required: true
  204. type: integer
  205. format: int64
  206. default: 1
  207. - name: chash
  208. in: header
  209. description: Hash to authorize actions with a certain company
  210. required: true
  211. type: string
  212. tags:
  213. - Project Internus
  214. responses:
  215. 200:
  216. description: JSON response of success
  217. examples:
  218. application/json:
  219. success: true
  220. /projectinternus/RoomInfo:
  221. get:
  222. summary: Get information about a room
  223. description: Get information about one specific room, no authentication needed at this point
  224. parameters:
  225. - name: room_id
  226. in: formData
  227. description: Room ID as specified in other responses
  228. required: true
  229. type: integer
  230. format: int64
  231. default: 1
  232. tags:
  233. - Project Internus
  234. responses:
  235. 200:
  236. description: JSON response of success
  237. examples:
  238. application/json:
  239. id: 1
  240. company_id: 1
  241. name: The Kid Room
  242. people_capacity: 10
  243. image_url: https://yolodetolo.com/image.jpg
  244. description: Stupid children making noise
  245. /projectinternus/retrieveAppointments:
  246. get:
  247. summary: Get all user appointments
  248. description: A way to get all the appointments from a single user
  249. parameters:
  250. - name: auth
  251. in: header
  252. description: Auth0 JWT
  253. required: true
  254. type: integer
  255. format: int64
  256. default: AUTH0_ID_TOKEN_HERE
  257. tags:
  258. - Project Internus
  259. responses:
  260. 200:
  261. description: JSON response of success
  262. examples:
  263. application/json:
  264. id: 1
  265. company_id: 1
  266. user_id: 9223372036854775807
  267. room_id: 1
  268. book_datetime: "2017-01-18 08:10:00"
  269. start_datetime: "2017-01-18 08:10:00"
  270. end_datetime: "2017-01-18 08:20:00"
  271. title: Title of the appointment if present
  272. description: Description or notes if present
  273. /projectinternus/allRooms:
  274. get:
  275. summary: Get all rooms
  276. description: A way to retrieve all the rooms within one company
  277. parameters:
  278. - name: chash
  279. in: header
  280. description: Hash to authorize actions with a certain company
  281. required: true
  282. type: string
  283. tags:
  284. - Project Internus
  285. responses:
  286. 200:
  287. description: JSON response of success, same as RoomInfo, but for all rooms
  288. /projectinternus/cancelAppointment:
  289. delete:
  290. summary: Cancel an appointment
  291. description: Change the status from an appointment to cancelled
  292. parameters:
  293. - name: auth
  294. in: header
  295. description: Auth0 JWT
  296. required: true
  297. type: integer
  298. format: int64
  299. default: AUTH0_ID_TOKEN_HERE
  300. - name: appointment_id
  301. in: formData
  302. description: Appointment ID
  303. required: true
  304. type: integer
  305. format: int64
  306. default: 1
  307. tags:
  308. - Project Internus
  309. responses:
  310. 200:
  311. description: JSON response of success
  312. examples:
  313. application/json:
  314. success: true
  315. /projectinternus/saveContacts:
  316. get:
  317. summary: Save multiple contacts
  318. description: Function to save multiple contacts, for example to upload the address book from an user to our server
  319. parameters:
  320. - name: auth
  321. in: header
  322. description: Auth0 JWT
  323. required: true
  324. type: integer
  325. format: int64
  326. default: AUTH0_ID_TOKEN_HERE
  327. - name: contacts_name[]
  328. in: formData
  329. description: Array of contacts names
  330. required: true
  331. type: array
  332. items:
  333. type: string
  334. minLength: 3
  335. default: Calvin Uijlen
  336. - name: contacts_email[]
  337. in: formData
  338. description: Array of contacts mails
  339. required: true
  340. type: array
  341. items:
  342. type: string
  343. minLength: 5
  344. default: [email protected]
  345. tags:
  346. - Project Internus
  347. responses:
  348. 200:
  349. description: Per contact posted, the API returns a 1 or 0, 1 means the contact was inserted, 0 means it was not inserted
  350. /businessbookingdialog/companies:
  351. get:
  352. summary: Get all companies
  353. description: Get all Schedular for Business booking popup companies
  354. tags:
  355. - Schedular for Business booking popup
  356. responses:
  357. 200:
  358. description: Array with companies info
  359. /businessbookingdialog/isRoomAvailable:
  360. get:
  361. summary: Is a room available?
  362. description: Is a chosen room available at a certain datetime
  363. parameters:
  364. - name: room_id
  365. in: formData
  366. description: room ID of the room you want to check
  367. type: string
  368. - name: start
  369. in: formData
  370. description: UNIX_TIMESTAMP of start datetime appointment
  371. required: true
  372. type: integer
  373. format: int64
  374. default: 1485526345
  375. - name: duration
  376. in: formData
  377. description: Duration in minutes
  378. required: true
  379. type: integer
  380. format: int64
  381. default: 60
  382. - name: people
  383. in: formData
  384. description: Amount of people
  385. required: true
  386. type: integer
  387. format: int64
  388. default: 5
  389. tags:
  390. - Schedular for Business booking popup
  391. responses:
  392. 200:
  393. description: JSON response of rooms with info and availability
  394. examples:
  395. application/json:
  396. room_id: 1
  397. company_id: 1
  398. name: The Kid Room
  399. people_capacity: 10
  400. image_url: https://yolodetolo.com/image.jpg
  401. description: Stupid children making noise
  402. schema:
  403. type: array
  404. items:
  405. type: array
  406. properties:
  407. room_id:
  408. type: integer
  409. format: int64
  410. name:
  411. type: string
  412. people_capacity:
  413. type: integer
  414. format: int64
  415. image_url:
  416. type: string
  417. description:
  418. type: string
  419. /businessbookingdialog/AvailableRooms:
  420. get:
  421. summary: Get available rooms
  422. description: Get available rooms with specific parameters sent
  423. parameters:
  424. - name: start
  425. in: formData
  426. description: UNIX_TIMESTAMP of start datetime appointment
  427. required: true
  428. type: integer
  429. format: int64
  430. default: 1485526345
  431. - name: duration
  432. in: formData
  433. description: Duration in minutes
  434. required: true
  435. type: integer
  436. format: int64
  437. default: 60
  438. - name: people
  439. in: formData
  440. description: Amount of people
  441. required: true
  442. type: integer
  443. format: int64
  444. default: 5
  445. - name: chash
  446. in: header
  447. description: Hash to authorize actions with a certain company
  448. required: true
  449. type: string
  450. tags:
  451. - Schedular for Business booking popup
  452. responses:
  453. 200:
  454. description: JSON response of rooms with info and availability
  455. examples:
  456. application/json:
  457. room_id: 1
  458. company_id: 1
  459. name: The Kid Room
  460. people_capacity: 10
  461. image_url: https://yolodetolo.com/image.jpg
  462. description: Stupid children making noise
  463. schema:
  464. type: array
  465. items:
  466. type: array
  467. properties:
  468. room_id:
  469. type: integer
  470. format: int64
  471. name:
  472. type: string
  473. people_capacity:
  474. type: integer
  475. format: int64
  476. image_url:
  477. type: string
  478. description:
  479. type: string
  480. pricing:
  481. type: string
  482. currency:
  483. type: string
  484. rate:
  485. type: string
  486. /businessbookingdialog/confirmAppointment:
  487. post:
  488. summary: Confirm an Appointment
  489. description: |
  490. This function is used to save the appointment
  491. parameters:
  492. - name: auth
  493. in: header
  494. description: Auth0 JWT
  495. required: true
  496. type: integer
  497. format: int64
  498. default: AUTH0_ID_TOKEN_HERE
  499. - name: appointment_startdate
  500. in: formData
  501. description: UNIX_TIMESTAMP of start datetime appointment
  502. required: true
  503. type: integer
  504. format: int64
  505. default: 1485526345
  506. - name: duration
  507. in: formData
  508. description: Duration in minutes
  509. required: true
  510. type: integer
  511. format: int64
  512. default: 60
  513. - name: people
  514. in: formData
  515. description: Amount of people
  516. required: true
  517. type: integer
  518. format: int64
  519. default: 5
  520. - name: title
  521. in: formData
  522. description: Title of appointment
  523. required: false
  524. type: string
  525. - name: description
  526. in: formData
  527. description: Description of appointment (and/or notes)
  528. required: false
  529. type: string
  530. - name: members
  531. in: formData
  532. description: Everyone in the ´CC´ field
  533. required: true
  534. type: array
  535. items:
  536. type: string
  537. minLength: 5
  538. - name: room_id
  539. in: formData
  540. description: Room ID
  541. required: true
  542. type: integer
  543. format: int64
  544. default: 1
  545. - name: chash
  546. in: header
  547. description: Hash to authorize actions with a certain company
  548. required: true
  549. type: string
  550. tags:
  551. - Schedular for Business booking popup
  552. responses:
  553. 200:
  554. description: JSON response of success
  555. examples:
  556. application/json:
  557. success: true
  558. /businessbookingdialog/RoomInfo:
  559. get:
  560. summary: Get information about a room
  561. description: Get information about one specific room, no authentication needed at this point
  562. parameters:
  563. - name: room_id
  564. in: formData
  565. description: Room ID as specified in other responses
  566. required: true
  567. type: integer
  568. format: int64
  569. default: 1
  570. tags:
  571. - Schedular for Business booking popup
  572. responses:
  573. 200:
  574. description: JSON response of success
  575. examples:
  576. application/json:
  577. id: 1
  578. company_id: 1
  579. name: The Kid Room
  580. people_capacity: 10
  581. image_url: https://yolodetolo.com/image.jpg
  582. description: Stupid children making noise
  583. /businessbookingdialog/retrieveAppointments:
  584. get:
  585. summary: Get all user appointments
  586. description: A way to get all the appointments from a single user
  587. parameters:
  588. - name: auth
  589. in: header
  590. description: Auth0 JWT
  591. required: true
  592. type: integer
  593. format: int64
  594. default: AUTH0_ID_TOKEN_HERE
  595. tags:
  596. - Schedular for Business booking popup
  597. responses:
  598. 200:
  599. description: JSON response of success
  600. examples:
  601. application/json:
  602. id: 1
  603. company_id: 1
  604. user_id: 9223372036854775807
  605. room_id: 1
  606. book_datetime: "2017-01-18 08:10:00"
  607. start_datetime: "2017-01-18 08:10:00"
  608. end_datetime: "2017-01-18 08:20:00"
  609. title: Title of the appointment if present
  610. description: Description or notes if present
  611. /businessbookingdialog/allRooms:
  612. get:
  613. summary: Get all rooms
  614. description: A way to retrieve all the rooms within one company
  615. parameters:
  616. - name: chash
  617. in: header
  618. description: Hash to authorize actions with a certain company
  619. required: true
  620. type: string
  621. tags:
  622. - Schedular for Business booking popup
  623. responses:
  624. 200:
  625. description: JSON response of success, same as RoomInfo, but for all rooms
  626. /businessbookingdialog/cancelAppointment:
  627. delete:
  628. summary: Cancel an appointment
  629. description: Change the status from an appointment to cancelled
  630. parameters:
  631. - name: auth
  632. in: header
  633. description: Auth0 JWT
  634. required: true
  635. type: integer
  636. format: int64
  637. default: AUTH0_ID_TOKEN_HERE
  638. - name: appointment_id
  639. in: formData
  640. description: Appointment ID
  641. required: true
  642. type: integer
  643. format: int64
  644. default: 1
  645. tags:
  646. - Schedular for Business booking popup
  647. responses:
  648. 200:
  649. description: JSON response of success
  650. examples:
  651. application/json:
  652. success: true
  653. /businessbookingdialog/saveContacts:
  654. get:
  655. summary: Save multiple contacts
  656. description: Function to save multiple contacts, for example to upload the address book from an user to our server
  657. parameters:
  658. - name: auth
  659. in: header
  660. description: Auth0 JWT
  661. required: true
  662. type: integer
  663. format: int64
  664. default: AUTH0_ID_TOKEN_HERE
  665. - name: contacts_name[]
  666. in: formData
  667. description: Array of contacts names
  668. required: true
  669. type: array
  670. items:
  671. type: string
  672. minLength: 3
  673. default: Calvin Uijlen
  674. - name: contacts_email[]
  675. in: formData
  676. description: Array of contacts mails
  677. required: true
  678. type: array
  679. items:
  680. type: string
  681. minLength: 5
  682. default: [email protected]
  683. tags:
  684. - Schedular for Business booking popup
  685. responses:
  686. 200:
  687. description: Per contact posted, the API returns a 1 or 0, 1 means the contact was inserted, 0 means it was not inserted
  688. /link/roomqr/{roomcode}:
  689. get:
  690. summary: Get room info from QR string
  691. description: Get all the room information belonging to a certain string saved in a QR code
  692. parameters:
  693. - name: roomcode
  694. in: path
  695. description: Roomcode (string)
  696. required: true
  697. type: string
  698. tags:
  699. - Link
  700. responses:
  701. 200:
  702. description: Room information
  703. /backend/login:
  704. post:
  705. summary: Log in to the admin panel
  706. description: dat dus
  707. parameters:
  708. - name: username
  709. in: formData
  710. description: Emailaddress
  711. required: true
  712. type: string
  713. - name: password
  714. in: formData
  715. description: Password
  716. required: true
  717. type: string
  718. - name: company_id
  719. in: formData
  720. description: Company ID
  721. required: true
  722. type: integer
  723. format: int64
  724. tags:
  725. - Admin
  726. responses:
  727. 200:
  728. description: Admin
  729.  
  730. /backend/appointment:
  731. post:
  732. summary: Save a new appointment
  733. description: Admin panel API to save a new appointment
  734. parameters:
  735. - name: userid
  736. in: header
  737. description: UserID of admin user
  738. required: true
  739. type: integer
  740. format: int64
  741. default: userid
  742. - name: apikey
  743. in: header
  744. description: API key received by server when logging on
  745. required: true
  746. type: integer
  747. format: int64
  748. default: api key
  749. - name: start
  750. in: formData
  751. description: UNIX timestamp of start_datetime
  752. required: true
  753. type: string
  754. - name: end
  755. in: formData
  756. description: UNIX timestamp of end_datetime
  757. required: true
  758. type: string
  759. - name: room_id
  760. in: formData
  761. description: room-rooms that are going to be booked, single room_id or multiple room_id, separate with comma
  762. required: false
  763. type: string
  764. - name: duration
  765. in: formData
  766. description: duration in minutes
  767. required: true
  768. type: integer
  769. format: int64
  770. - name: title
  771. in: formData
  772. description: title of appointment
  773. required: false
  774. type: string
  775. - name: description
  776. in: formData
  777. description: description of appointment
  778. required: false
  779. type: string
  780. tags:
  781. - Admin
  782. responses:
  783. 200:
  784. description: Per contact posted, the API returns a 1 or 0, 1 means the contact was inserted, 0 means it was not inserted
  785. put:
  786. summary: Update an appointment
  787. description: Admin panel API to update an appointment
  788. parameters:
  789. - name: userid
  790. in: header
  791. description: UserID of admin user
  792. required: true
  793. type: integer
  794. format: int64
  795. default: userid
  796. - name: apikey
  797. in: header
  798. description: API key received by server when logging on
  799. required: true
  800. type: integer
  801. format: int64
  802. default: api key
  803. - name: appointment_id
  804. in: formData
  805. description: ID of appointment
  806. required: true
  807. type: integer
  808. format: int64
  809. - name: start
  810. in: formData
  811. description: UNIX timestamp of start_datetime
  812. required: true
  813. type: string
  814. - name: end
  815. in: formData
  816. description: UNIX timestamp of end_datetime
  817. required: true
  818. type: string
  819. - name: room_id
  820. in: formData
  821. description: room-rooms that are going to be booked, single room_id or multiple room_id, separate with comma
  822. required: false
  823. type: string
  824. - name: duration
  825. in: formData
  826. description: duration in minutes
  827. required: true
  828. type: integer
  829. format: int64
  830. - name: title
  831. in: formData
  832. description: title of appointment
  833. required: false
  834. type: string
  835. - name: description
  836. in: formData
  837. description: description of appointment
  838. required: false
  839. type: string
  840. tags:
  841. - Admin
  842. responses:
  843. 200:
  844. description: Per contact posted, the API returns a 1 or 0, 1 means the contact was inserted, 0 means it was not inserted
  845. delete:
  846. summary: Delete an appointment
  847. description: Admin panel API to delete an appointment
  848. parameters:
  849. - name: userid
  850. in: header
  851. description: UserID of admin user
  852. required: true
  853. type: integer
  854. format: int64
  855. default: userid
  856. - name: apikey
  857. in: header
  858. description: API key received by server when logging on
  859. required: true
  860. type: integer
  861. format: int64
  862. default: api key
  863. - name: appointment_id
  864. in: formData
  865. description: ID of appointment
  866. required: true
  867. type: integer
  868. format: int64
  869. tags:
  870. - Admin
  871. responses:
  872. 200:
  873. description: Per contact posted, the API returns a 1 or 0, 1 means the contact was inserted, 0 means it was not inserted
  874. /backend/appointment/{appointment_id}:
  875. get:
  876. summary: Get an appointment
  877. description: Admin panel API to get an appointment
  878. parameters:
  879. - name: userid
  880. in: header
  881. description: UserID of admin user
  882. required: true
  883. type: integer
  884. format: int64
  885. default: userid
  886. - name: apikey
  887. in: header
  888. description: API key received by server when logging on
  889. required: true
  890. type: integer
  891. format: int64
  892. default: api key
  893. - name: appointment_id
  894. in: path
  895. description: appointment_id
  896. required: true
  897. type: integer
  898. format: int64
  899. tags:
  900. - Admin
  901. responses:
  902. 200:
  903. description: Per contact posted, the API returns a 1 or 0, 1 means the contact was inserted, 0 means it was not inserted
  904. /backend/getappointmentscalendar:
  905. get:
  906. summary: Get an appointment
  907. description: Admin panel API to get calendar appointments
  908. parameters:
  909. - name: userid
  910. in: header
  911. description: UserID of admin user
  912. required: true
  913. type: integer
  914. format: int64
  915. default: userid
  916. - name: apikey
  917. in: header
  918. description: API key received by server when logging on
  919. required: true
  920. type: integer
  921. format: int64
  922. default: api key
  923. - name: view
  924. in: formData
  925. description: day or threeday or week or month
  926. required: true
  927. type: string
  928. - name: room_id
  929. in: formData
  930. description: Room ID
  931. required: false
  932. type: integer
  933. format: int64
  934. - name: staff_id
  935. in: formData
  936. description: Staff ID
  937. required: false
  938. type: integer
  939. format: int64
  940. tags:
  941. - Admin
  942. responses:
  943. 200:
  944. description: Get all the appointments my friend
  945. /backend/room/{room_id}:
  946. get:
  947. summary: Get a room
  948. description: Admin panel API to get a room
  949. parameters:
  950. - name: apikey
  951. in: header
  952. description: API key received by server when logging on
  953. required: true
  954. type: integer
  955. format: int64
  956. default: api key
  957. - name: room_id
  958. in: path
  959. description: room ID
  960. required: true
  961. type: integer
  962. format: int64
  963. tags:
  964. - Admin
  965. responses:
  966. 200:
  967. description: Get a certain room
  968. delete:
  969. summary: Delete a room
  970. description: Admin panel API to delete a room
  971. parameters:
  972. - name: apikey
  973. in: header
  974. description: API key received by server when logging on
  975. required: true
  976. type: integer
  977. format: int64
  978. default: api key
  979. - name: room_id
  980. in: path
  981. description: room ID
  982. required: true
  983. type: integer
  984. format: int64
  985. tags:
  986. - Admin
  987. responses:
  988. 200:
  989. description: Delete the room mate
  990. /backend/userlist:
  991. get:
  992. summary: List users
  993. description: Get all connected users to a certain company
  994. parameters:
  995. - name: apikey
  996. in: header
  997. description: API key received by server when logging on
  998. required: true
  999. type: integer
  1000. format: int64
  1001. default: api key
  1002. tags:
  1003. - Admin
  1004. responses:
  1005. 200:
  1006. description: Get all the appointments my friend
  1007. /backend/inviteuser/{user_email}:
  1008. get:
  1009. summary: Invite User
  1010. description: Intended for invite button in backend
  1011. parameters:
  1012. - name: apikey
  1013. in: header
  1014. description: API key received by server when logging on
  1015. required: true
  1016. type: integer
  1017. format: int64
  1018. default: api key
  1019. - name: user_email
  1020. in: path
  1021. description: Email address of the user you are trying to invite
  1022. required: true
  1023. type: integer
  1024. format: int64
  1025. tags:
  1026. - Admin
  1027. responses:
  1028. 200:
  1029. description: Success true or false
  1030. /backend/staff/{staff_id}:
  1031. get:
  1032. summary: Get information about staff
  1033. description: Get one staff account
  1034. parameters:
  1035. - name: apikey
  1036. in: header
  1037. description: API key received by server when logging on
  1038. required: true
  1039. type: integer
  1040. format: int64
  1041. default: api key
  1042. - name: staff_id
  1043. in: path
  1044. description: Staff ID
  1045. required: true
  1046. type: integer
  1047. format: int64
  1048. tags:
  1049. - Admin
  1050. responses:
  1051. 200:
  1052. description: Staff info
  1053. /backend/staff:
  1054. get:
  1055. summary: Get information about staff
  1056. description: Get multiple staff account
  1057. parameters:
  1058. - name: apikey
  1059. in: header
  1060. description: API key received by server when logging on
  1061. required: true
  1062. type: integer
  1063. format: int64
  1064. default: api key
  1065. tags:
  1066. - Admin
  1067. responses:
  1068. 200:
  1069. description: Multiple staff info
  1070. definitions:
  1071. Product:
  1072. type: object
  1073. properties:
  1074. product_id:
  1075. type: string
  1076. description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.
  1077. description:
  1078. type: string
  1079. description: Description of product.
  1080. display_name:
  1081. type: string
  1082. description: Display name of product.
  1083. capacity:
  1084. type: string
  1085. description: Capacity of product. For example, 4 people.
  1086. image:
  1087. type: string
  1088. description: Image URL representing the product.
  1089. PriceEstimate:
  1090. type: object
  1091. properties:
  1092. product_id:
  1093. type: string
  1094. description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles
  1095. currency_code:
  1096. type: string
  1097. description: "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code."
  1098. display_name:
  1099. type: string
  1100. description: Display name of product.
  1101. estimate:
  1102. type: string
  1103. description: Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or "Metered" for TAXI.
  1104. low_estimate:
  1105. type: number
  1106. description: Lower bound of the estimated price.
  1107. high_estimate:
  1108. type: number
  1109. description: Upper bound of the estimated price.
  1110. surge_multiplier:
  1111. type: number
  1112. description: Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier.
  1113. Profile:
  1114. type: object
  1115. properties:
  1116. first_name:
  1117. type: string
  1118. description: First name of the Uber user.
  1119. last_name:
  1120. type: string
  1121. description: Last name of the Uber user.
  1122. email:
  1123. type: string
  1124. description: Email address of the Uber user
  1125. picture:
  1126. type: string
  1127. description: Image URL of the Uber user.
  1128. promo_code:
  1129. type: string
  1130. description: Promo code of the Uber user.
  1131. Activity:
  1132. type: object
  1133. properties:
  1134. uuid:
  1135. type: string
  1136. description: Unique identifier for the activity
  1137. Activities:
  1138. type: object
  1139. properties:
  1140. offset:
  1141. type: integer
  1142. format: int32
  1143. description: Position in pagination.
  1144. limit:
  1145. type: integer
  1146. format: int32
  1147. description: Number of items to retrieve (100 max).
  1148. count:
  1149. type: integer
  1150. format: int32
  1151. description: Total number of items available.
  1152. history:
  1153. type: array
  1154. items:
  1155. $ref: '#/definitions/Activity'
  1156. Error:
  1157. type: object
  1158. properties:
  1159. code:
  1160. type: integer
  1161. format: int32
  1162. message:
  1163. type: string
  1164. fields:
  1165. type: string
Advertisement
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!