API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jan 16th, 2017
220
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 391.41 KB | None | 0 0
raw download clone embed print report
  1. #%RAML 0.8
  2. title: core-gaming-api
  3. version: "1.0"
  4. baseUri: "http://192.168.100.161:8081/api/core/v1"
  5. mediaType: application/json
  6. schemas:
  7. -
  8. loginUserInput: |
  9. {
  10. "$schema": "http://json-schema.org/draft-04/schema#",
  11. "type" : "object",
  12. "properties" : {
  13. "userName" : {
  14. "type" : "string",
  15. "description" : "Player entered username used to log into player web portal. Free from form errors"
  16. },
  17. "password" : {
  18. "type" : "string",
  19. "description" : "Player entered password used to log into player web portal"
  20. },
  21. "loginDateUpdateRequired" : {
  22. "type" : "boolean",
  23. "description" : "Will update the last login date with this login command in the player's profile"
  24. },
  25. "geofilterInfo" : {
  26. "type" : "object",
  27. "properties" : {
  28. "charset" : {
  29. "type" : "string",
  30. "description" : "Characterset attribute of the request"
  31. },
  32. "language" : {
  33. "type" : "string",
  34. "description" : "Language attribute of the request"
  35. },
  36. "browser" : {
  37. "type" : "string",
  38. "description" : "User-Agent attribute of the request"
  39. },
  40. "clientIP" : {
  41. "type" : "string",
  42. "description" : "IPAdress attribute of the request"
  43. },
  44. "proxyInfo" : {
  45. "type" : "string",
  46. "description" : "Proxy information of the request"
  47. },
  48. "localTime" : {
  49. "type" : "string",
  50. "description" : "Local Time"
  51. },
  52. "timeZoneOffset" : {
  53. "type" : "string",
  54. "description" : "Time zone offset"
  55. },
  56. "encoding" : {
  57. "type" : "string",
  58. "description" : "Encoding attribute if this request"
  59. }
  60. }
  61. }
  62. },
  63. "required": [ "userName", "password" ]
  64. }
  65. -
  66. loginUserOutput: |
  67. {
  68. "$schema": "http://json-schema.org/draft-04/schema#",
  69. "type" : "object",
  70. "properties" : {
  71. "userId" : {
  72. "type" : "string",
  73. "description" : "Player's session id upon successful login"
  74. },
  75. "sessionId" : {
  76. "type" : "string",
  77. "description" : ""
  78. },
  79. "lastLogon" : {
  80. "type" : "string",
  81. "description" : ""
  82. }
  83. },
  84. "required": [ "userId", "sessionId"]
  85. }
  86. -
  87. simpleResponse: |
  88. {
  89. "$schema": "http://json-schema.org/draft-04/schema#",
  90. "type" : "object",
  91. "properties" : {
  92. "message" : {
  93. "type" : "string"
  94. },
  95. "uuid" : {
  96. "type" : "string"
  97. }
  98. },
  99. "required": [ "message" ]
  100. }
  101. -
  102. loadPlayerProfileOutput: |
  103. {
  104. "$schema": "http://json-schema.org/draft-04/schema#",
  105. "type" : "object",
  106. "properties" : {
  107. "title" : {
  108. "type" : "string",
  109. "description" : ""
  110. },
  111. "firstName" : {
  112. "type" : "string",
  113. "description" : "First name in player's profile"
  114. },
  115. "lastName" : {
  116. "type" : "string",
  117. "description" : "Last name in player's profile"
  118. },
  119. "dateOfBirth" : {
  120. "type" : "string",
  121. "description" : "Date of birth in player's profile"
  122. },
  123. "gender" : {
  124. "type" : "string",
  125. "description" : "Gender attribute in player's profile ('M' for male and 'F' for female)"
  126. },
  127. "tlaArea" : {
  128. "type" : "string",
  129. "description" : "Player's TLA area designation"
  130. },
  131. "tlaLocation" : {
  132. "type" : "string",
  133. "description" : "Player's TLA area designation"
  134. },
  135. "phone" : {
  136. "type" : ["string", "null"],
  137. "description" : "Player's phone number"
  138. },
  139. "emailAddress" : {
  140. "type" : "string",
  141. "description" : "Player's email address"
  142. },
  143. "optInEmailResultsNotify" : {
  144. "type" : "boolean",
  145. "description" : "Option to receive draw results by email"
  146. },
  147. "optInLottoResults" : {
  148. "type" : ["boolean", "null"],
  149. "description" : "Option to receive Lotto family results as part of the 'Get Results Fast' option "
  150. },
  151. "bankAccountNumber" : {
  152. "type" : ["string", "null"],
  153. "description" : "Bank account number in player's profile"
  154. },
  155. "bankAccountConfirmed" : {
  156. "type" : "boolean",
  157. "description" : "Status confirmation of player's bank account "
  158. },
  159. "helpFlagEnabled" : {
  160. "type" : "boolean",
  161. "description" : "Indicates if the player has switched off their step by step help"
  162. },
  163. "newPasswordRequired" : {
  164. "type" : "boolean",
  165. "description" : "Indicates whether a new password is required (an admin user may reset the password for example)"
  166. },
  167. "accountStatus" : {
  168. "type" : "number",
  169. "description" : "ESI account status: 0 - active, 1 - closed; 2 - suspended. Note: Player with closed.suspended account is not able to login. So it can be observed only using 'on behalf' mode."
  170. },
  171. "loginStatus" : {
  172. "type" : "number",
  173. "description" : "Login status, 0 - active (allowed to log in), 1 - suspended (cannot log in)"
  174. },
  175. "playerStatus" : {
  176. "type" : "number",
  177. "description" : "Player status (also called user type): 1 is applicant, 2 is non confirmed, 3 is ID verified, 4 is confirmed, 5 is wagerging permitted, 6 is email changed "
  178. },
  179. "walletStatus" : {
  180. "type" : "integer",
  181. "description" : "Player's wallet status, 0 is active, 1 is suspended (e.g. cannot load money to the wallet)"
  182. },
  183. "cashBalance" : {
  184. "type" : "number",
  185. "description" : "Player's wallet balance; not null"
  186. },
  187. "tokenBalance" : {
  188. "type" : "number",
  189. "description" : "Token's balance; not null"
  190. },
  191. "weeklySpendingLimit" : {
  192. "type" : "number",
  193. "description" : "Player's actual weekly spending limits; possibly null (when e.g. the user is not wagering permitted)"
  194. },
  195. "monthlySpendingLimit" : {
  196. "type" : "number",
  197. "description" : "Player's actual monthly spending limits; possibly null (when e.g. the user is not wagering permitted)"
  198. },
  199. "weeklyXferAmt" : {
  200. "type" : "number",
  201. "description" : "Total amount of money transfers to the wallet in the current week; not null"
  202. },
  203. "loginTime" : {
  204. "type" : "string",
  205. "description" : "Last login timestamp; possibly null (is not null if the command was invoked after login)"
  206. },
  207. "claimTypeNotificationsCount" : {
  208. "type" : "number",
  209. "description" : "The number of notifications about tickets to claim"
  210. },
  211. "totalNotifications" : {
  212. "type" : "number",
  213. "description" : "Total number of notifications"
  214. },
  215. "weeklyTransferCount" : {
  216. "type" : "number",
  217. "description" : "Total number of money transfers to the wallet in the current week"
  218. },
  219. "winningTypeNotificationsCount" : {
  220. "type" : "number",
  221. "description" : "The number of notifications about winning tickets"
  222. },
  223. "ageConfirmStatus" : {
  224. "type" : "number",
  225. "description" : "Player's age confirmation status: 0 is not requested, 1 is requested, 2 is verified, 3 is denied"
  226. },
  227. "homePhone" : {
  228. "type" : "string",
  229. "description" : "Player's phone number"
  230. },
  231. "mobilePhone" : {
  232. "type" : "string",
  233. "description" : ""
  234. },
  235. "acctNumber" : {
  236. "type" : "string",
  237. "description" : "Unique ID that identifies the player sent through from the player web portal. AcctNumber of the player is nothing but userId concatenated with check digit of the player."
  238. },
  239. "sessionActive" : {
  240. "type" : "boolean",
  241. "description" : ""
  242. },
  243. "tcVersion" : {
  244. "type" : "string",
  245. "description" : "Last terms and conditions version accepted by player as stored in ESi database"
  246. },
  247. "playerGreeting" : {
  248. "type" : "string",
  249. "description" : "Customized player greeting"
  250. },
  251. "spentToDateWeek" : {
  252. "type" : "number",
  253. "description" : "Actual user spending for a week."
  254. },
  255. "spentToDateMonth" : {
  256. "type" : "number",
  257. "description" : "Actual user spending for a month."
  258. },
  259. "userType" : {
  260. "type" : "integer",
  261. "description" : "Returns the user type: 0 is 'Full' - myLotto User, 1 is 'Partial' - 2ndChance user"
  262. },
  263. "optInInstantKiwi" : {
  264. "type" : ["boolean", "null"],
  265. "description" : "Flag for Opt In Instant Kiwi"
  266. },
  267. "optInLottoJackpot" : {
  268. "type" : ["boolean", "null"],
  269. "description" : "Flag for Opt In Lotto Jackpot"
  270. },
  271. "optInLottoJackpotThreshold" : {
  272. "type" : ["integer", "null"],
  273. "description" : "Opt In Lotto Jackpot Threshold"
  274. },
  275. "optInMarketing" : {
  276. "type" : ["boolean", "null"],
  277. "description" : "Flag for Opt In Marketing"
  278. }
  279. }
  280. }
  281. -
  282. purchaseWagerInput: |
  283. {
  284. "$schema": "http://json-schema.org/draft-04/schema#",
  285. "type": "object",
  286. "properties": {
  287. "channelId": {
  288. "type": "integer",
  289. "description" : "Channel identificator (1 – Desktop, 2 - Mobile). When nothing or 0 set then 1 is put as default."
  290. },
  291. "lottoWagers": {
  292. "type": "array",
  293. "items": {
  294. "type": "object",
  295. "properties": {
  296. "purchaseType": {
  297. "type": "string",
  298. "description" : "4 possible options: 1. Default 2. DIP 3. Pick Your Own 4. Favourite 5. Subscription:DIP 6. Subscription:Favourite when nothing is entered, Default is used."
  299. },
  300. "wagerAmount": {
  301. "type": "number",
  302. "description" : "Total purchase amount"
  303. },
  304. "numberOfBoards": {
  305. "type": "integer",
  306. "description" : "Number of boards wager is purchased for"
  307. },
  308. "numberStrikeBoards": {
  309. "type": "integer",
  310. "description" : "Number of boards wager is purchased for"
  311. },
  312. "numberPowerballBoards": {
  313. "type": "integer",
  314. "description" : "Number of Powerball boards"
  315. },
  316. "powerballNumber": {
  317. "type": "string",
  318. "description" : "Powerball number to be played."
  319. },
  320. "numberOfDraws": {
  321. "type": "integer",
  322. "description" : "Number of draws wager is purchased for, starting from current draw"
  323. },
  324. "advanceDraw": {
  325. "type": "integer",
  326. "description" : "Number of draws in advance wager is purchased for"
  327. },
  328. "couponType": {
  329. "type": "boolean",
  330. "description" : "Wager is played via manual entry of coupon"
  331. },
  332. "strikeWagerDetails": {
  333. "type": "array",
  334. "items": {
  335. "type": "object",
  336. "properties": {
  337. "strikeBoard": {
  338. "type": "array",
  339. "items": {
  340. "type": "object",
  341. "properties": {
  342. "numbers": {
  343. "type": "array",
  344. "items": {
  345. "type": "integer",
  346. "description" : "Numbers selected"
  347. }
  348. }
  349. }
  350. }
  351. },
  352. "drawDays": {
  353. "type": "array",
  354. "items": [
  355. {
  356. "type": "string",
  357. "description" : "Draw Day for example: Wed, Sat"
  358. }
  359. ]
  360. }
  361. }
  362. }
  363. },
  364. "lottoWagerDetails": {
  365. "type": "array",
  366. "items": {
  367. "type": "object",
  368. "properties": {
  369. "starterDipType": {
  370. "type": "boolean",
  371. "description" : ""
  372. },
  373. "lottoLuckyDip": {
  374. "type": "boolean",
  375. "description" : "Dip option corresponding to Lotto Lucky Dip"
  376. },
  377. "lottoPowerDip": {
  378. "type": "boolean",
  379. "description" : "Dip option corresponding to Lotto Power Dip"
  380. },
  381. "lottoTripleDip": {
  382. "type": "boolean",
  383. "description" : "Dip option corresponding to Lotto Triple Dip"
  384. },
  385. "basicDipType": {
  386. "type": "boolean",
  387. "description" : "Dip type - basic"
  388. },
  389. "superDipType": {
  390. "type": "boolean",
  391. "description" : "Dip type - super"
  392. },
  393. "superPlusDipType": {
  394. "type": "boolean",
  395. "description" : "Dip type - super plus"
  396. },
  397. "megaDipType": {
  398. "type": "boolean",
  399. "description" : "Dip type - mega"
  400. },
  401. "mega24DipType": {
  402. "type": "boolean",
  403. "description" : "Dip type - mega24, old type mega with wager amount of $24"
  404. },
  405. "lottoBoard": {
  406. "type": "array",
  407. "items": {
  408. "type": "object",
  409. "properties": {
  410. "powerballNumber": {
  411. "type": "integer",
  412. "description" : "Powerball number for board if selected"
  413. },
  414. "numbers": {
  415. "type": "array",
  416. "items": {
  417. "type": "integer",
  418. "description" : "List of LottoNumberSelection objects which contains number selection for each board"
  419. }
  420. }
  421. }
  422. }
  423. },
  424. "drawDays": {
  425. "type": "array",
  426. "items": [
  427. {
  428. "type": "string",
  429. "description" : "Draw Day for example: Wed, Sat"
  430. }
  431. ]
  432. }
  433. }
  434. }
  435. }
  436. }
  437. }
  438. },
  439. "bullseyeWagers": {
  440. "type": "array",
  441. "items": {
  442. "type": "object",
  443. "properties": {
  444. "purchaseType": {
  445. "type": "string",
  446. "description" : "4 possible options: 1. Default 2. DIP 3. Pick Your Own 4. Favourite when nothing is entered, Default is used."
  447. },
  448. "wagerAmount": {
  449. "type": "number",
  450. "description" : "Total purchase amount"
  451. },
  452. "numberOfBoards": {
  453. "type": "integer",
  454. "description" : "Number of boards wager is purchased for"
  455. },
  456. "numberOfDraws": {
  457. "type": "integer",
  458. "description" : "Number of draws wager is purchased for, starting from current draw"
  459. },
  460. "couponType": {
  461. "type": "boolean",
  462. "description" : "Wager is played via manual entry of coupon"
  463. },
  464. "bullseyeWagerDetails": {
  465. "type": "array",
  466. "items": {
  467. "type": "object",
  468. "properties": {
  469. "bullseyeDip": {
  470. "type": "integer",
  471. "description" : "Dip option corresponding to Bullseye Dip. The Dip option can be 1, 3 and 7."
  472. },
  473. "bullseyeBoard": {
  474. "type": "array",
  475. "items": {
  476. "type": "object",
  477. "properties": {
  478. "numbers": {
  479. "type": "array",
  480. "items": {
  481. "type": "integer",
  482. "description" : "List of BullseyeNumberSelection objects which contains digit selection for each board, the digits compose of the Bullseye number (the digit at 0 position is the most significant and the last is the less significant); there should be always six numbers provided with leading zeros"
  483. }
  484. }
  485. }
  486. }
  487. }
  488. }
  489. }
  490. }
  491. }
  492. }
  493. },
  494. "kenoWagers":{
  495. "type": "array",
  496. "items": {
  497. "type": "object",
  498. "properties": {
  499. "purchaseType": {
  500. "type": "string",
  501. "description" : "4 possible options: 1. Default 2. DIP 3. Pick Your Own 4. Favourite when nothing is entered, Default is used."
  502. },
  503. "wagerAmount": {
  504. "type": "number",
  505. "description" : "Total purchase amount"
  506. },
  507. "pricePerBoard": {
  508. "type": "number",
  509. "description" : "Amount wagered per board"
  510. },
  511. "numberOfBoards": {
  512. "type": "integer",
  513. "description" : "Number of boards wager is purchased for"
  514. },
  515. "numberOfDraws": {
  516. "type": "integer",
  517. "description" : "Number of draws wager is purchased for, starting from current draw"
  518. },
  519. "couponType": {
  520. "type": "boolean",
  521. "description" : "Wager is played via manual entry of coupon"
  522. },
  523. "kenoWagerDetails": {
  524. "type": "array",
  525. "items": {
  526. "type": "object",
  527. "properties": {
  528. "kenoDip": {
  529. "type": "integer",
  530. "description" : "Dip option corresponding to Keno Dip"
  531. },
  532. "drawTimes": {
  533. "type": "array",
  534. "items": [
  535. {
  536. "type": "integer",
  537. "description" : "Draw times set (Keno only) 10 - 10 AM Draw 13 - 1 PM Draw 15 - 3 PM Draw 18 - 6 PM draw"
  538. }
  539. ]
  540. },
  541. "kenoBoard": {
  542. "type": "array",
  543. "items": {
  544. "type": "object",
  545. "properties": {
  546. "groupNumber": {
  547. "type": "integer",
  548. "description" : "Prize group played per board"
  549. },
  550. "numbers": {
  551. "type": "array",
  552. "items": {
  553. "type": "integer",
  554. "description" : "List of KenoNumberSelection objects which contains number selection for each board"
  555. }
  556. }
  557. }
  558. }
  559. }
  560. }
  561. }
  562. }
  563. }
  564. }
  565. },
  566. "play3Wagers": {
  567. "type": "array",
  568. "items": {
  569. "type": "object",
  570. "properties": {
  571. "purchaseType": {
  572. "type": "string",
  573. "description" : "4 possible options: 1. Default 2. DIP 3. Pick Your Own 4. Favourite when nothing is entered, Default is used."
  574. },
  575. "wagerAmount": {
  576. "type": "number",
  577. "description" : "Total purchase amount"
  578. },
  579. "numberOfBoards": {
  580. "type": "integer",
  581. "description" : "Number of boards wager is purchased for"
  582. },
  583. "numberOfDraws": {
  584. "type": "integer",
  585. "description" : "Number of draws wager is purchased for, starting from current draw"
  586. },
  587. "couponType": {
  588. "type": "boolean",
  589. "description" : "Wager is played via manual entry of coupon"
  590. },
  591. "play3WagerDetails": {
  592. "type": "array",
  593. "items": {
  594. "type": "object",
  595. "properties": {
  596. "play3Boards": {
  597. "type": "array",
  598. "items": {
  599. "type": "object",
  600. "properties": {
  601. "numbers": {
  602. "type": "array",
  603. "items": {
  604. "type": "integer",
  605. "description" : "List of play3NumberSelection objects which contains digit selection for each board, the are 3 digits "
  606. }
  607. },
  608. "play3PlayType": {
  609. "type": "string",
  610. "description" : "possible values are 'Exact', 'Any', 'Pairs', 'ExactAny', 'ExactPairs', 'ExactAnyPairs' ,'Combo'"
  611. },
  612. "play3BoardAmount": {
  613. "type": "integer",
  614. "description" : "price for purchased board. Just for validation purpose"
  615. }
  616. }
  617. }
  618. }
  619. }
  620. }
  621. }
  622. },
  623. "required": [
  624. "purchaseType",
  625. "wagerAmount",
  626. "numberOfBoards",
  627. "numberOfDraws",
  628. "couponType",
  629. "play3WagerDetails"
  630. ]
  631. }
  632. }
  633. },
  634. "required": [
  635. "channelId"
  636. ]
  637. }
  638. -
  639. purchaseWagerOutput: |
  640. {
  641. "$schema": "http://json-schema.org/draft-04/schema#",
  642. "type": "object",
  643. "properties": {
  644. "lottoWagers": {
  645. "type": "array",
  646. "items": {
  647. "type": "object",
  648. "properties": {
  649. "failureMessage": {
  650. "type": "string",
  651. "description": "Reason why this purchase request failed"
  652. },
  653. "gameTransactionNumber": {
  654. "type": "string",
  655. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  656. },
  657. "wagerAmount": {
  658. "type": "number",
  659. "description" : "Total cost of ticket"
  660. },
  661. "walletBalance": {
  662. "type": "number",
  663. "description" : "Updated wallet balance"
  664. },
  665. "numberOfTicketsGenerated": {
  666. "type": "integer",
  667. "description" : "Number of tickets generated (1-2 depending on number of boards)"
  668. },
  669. "promoTicketReturned": {
  670. "type": "boolean",
  671. "description" : "if a promotion ticket (e.g. voucher) is returned"
  672. },
  673. "numberOfStrikeTicketsGenerated": {
  674. "type": "integer",
  675. "description" : "Number of tickets generated (1-2 depending on number of boards)"
  676. },
  677. "lottoTickets": {
  678. "type": "array",
  679. "items": {
  680. "type": "object",
  681. "properties": {
  682. "transactionId": {
  683. "type": "string",
  684. "description" : "Transaction number maintained in ESi"
  685. },
  686. "ticketNumber": {
  687. "type": "string",
  688. "description" : "Unique ticket number maintained in ESi"
  689. },
  690. "ticketDetails": {
  691. "type": "object",
  692. "properties": {
  693. "strikeBoard": {
  694. "type": "array",
  695. "items": {
  696. "type": "object",
  697. "properties": {
  698. "numbers": {
  699. "type": "array",
  700. "items": {
  701. "type": "integer",
  702. "description": "Numbers selected"
  703. }
  704. }
  705. }
  706. }
  707. },
  708. "drawDays": {
  709. "type": "array",
  710. "items": [
  711. {
  712. "type": "string",
  713. "description": "Draw Day for example: Wed, Sat"
  714. }
  715. ]
  716. }
  717. }
  718. }
  719. }
  720. }
  721. },
  722. "strikeTickets": {
  723. "type": "array",
  724. "items": {
  725. "type": "object",
  726. "properties": {
  727. "strikeTransactionId": {
  728. "type": "string",
  729. "description" : "Strike transaction number maintained in ESi"
  730. },
  731. "strikeTicketNumber": {
  732. "type": "string",
  733. "description" : "Unique Strike ticket number maintained in ESi"
  734. },
  735. "ticketDetails": {
  736. "type": "object",
  737. "properties": {
  738. "strikeBoard": {
  739. "type": "array",
  740. "items": {
  741. "type": "object",
  742. "properties": {
  743. "numbers": {
  744. "type": "array",
  745. "items": {
  746. "type": "integer",
  747. "description": "Numbers selected"
  748. }
  749. }
  750. }
  751. }
  752. },
  753. "drawDays": {
  754. "type": "array",
  755. "items": [
  756. {
  757. "type": "string",
  758. "description": "Draw Day for example: Wed, Sat"
  759. }
  760. ]
  761. }
  762. }
  763. }
  764. }
  765. }
  766. },
  767. "voucherTicket": {
  768. "type": "array",
  769. "items": {
  770. "type": "object",
  771. "properties": {
  772. "promoTransactionId": {
  773. "type": "string",
  774. "description" : "Transaction number maintained in ESi"
  775. },
  776. "promoTicketNumber": {
  777. "type": "integer",
  778. "description" : "Unique promotion ticket number maintained in ESi"
  779. },
  780. "voucherSerial": {
  781. "type": "integer",
  782. "description" : "Voucher serial number as created by ESTE"
  783. },
  784. "ticketDetails": {
  785. "type": "object",
  786. "properties": {
  787. "gameName": {
  788. "type": "string",
  789. "description" : "Game name"
  790. },
  791. "numberOfBoards": {
  792. "type": "integer",
  793. "description" : "Number of boards wager is purchased for"
  794. },
  795. "numberOfDraws": {
  796. "type": "integer",
  797. "description" : "Number of draws wager is purchased for, starting from current draw"
  798. },
  799. "systemNumber": {
  800. "type": "integer",
  801. "description" : "System number for combo wagers."
  802. },
  803. "wagerAmount": {
  804. "type": "number",
  805. "description" : "Total purchase amount"
  806. },
  807. "ticketNumber": {
  808. "type": "string",
  809. "description" : "Unique ticket number maintained in ESi"
  810. },
  811. "ticketType": {
  812. "type": "string",
  813. "description" : "Ticket type description"
  814. },
  815. "purchaseDate": {
  816. "type": "string",
  817. "description" : "Date ticket was purchased"
  818. },
  819. "ticketStatus": {
  820. "type": "string",
  821. "description" : "Ticket status"
  822. },
  823. "gameTransactionNumber": {
  824. "type": "string",
  825. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  826. },
  827. "couponType": {
  828. "type": "boolean",
  829. "description" : "Wager is played via manual entry of coupon"
  830. },
  831. "drawWinDetails": {
  832. "type": "array",
  833. "items": {
  834. "type": "object",
  835. "properties": {
  836. "lottoNumber": {
  837. "type": "integer",
  838. "description" : ""
  839. },
  840. "bonusTickets": {
  841. "type": "integer",
  842. "description" : ""
  843. },
  844. "drawDate": {
  845. "type": "string",
  846. "description" : "Draw date"
  847. },
  848. "drawStatus": {
  849. "type": "string",
  850. "description" : "Draw status"
  851. },
  852. "winAmount": {
  853. "type": "number",
  854. "description" : "Winning amount for cash prizes"
  855. },
  856. "winningFlag": {
  857. "type": "boolean",
  858. "description" : "Flag to indicate ticket is a winner"
  859. },
  860. "drawTicketStatus": {
  861. "type": "string",
  862. "description" : ""
  863. },
  864. "megaDipType": {
  865. "type": "boolean",
  866. "description" : ""
  867. },
  868. "drawNumber": {
  869. "type": "integer",
  870. "description" : "Draw number"
  871. },
  872. "lottoLuckyDip": {
  873. "type": "boolean",
  874. "description" : ""
  875. },
  876. "lottoPowerDip": {
  877. "type": "boolean",
  878. "description" : ""
  879. },
  880. "lottoTripleDip": {
  881. "type": "boolean",
  882. "description" : ""
  883. }
  884. }
  885. }
  886. },
  887. "promoTicketReturned": {
  888. "type": "boolean",
  889. "description" : "Wager qualified for a promotion/voucher ticket"
  890. },
  891. "startDraw": {
  892. "type": "integer",
  893. "description" : "Start draw number of wager."
  894. },
  895. "ticketMessage": {
  896. "type": "string",
  897. "description" : "Output string 4 lines of 26 characters."
  898. },
  899. "voucherDetails": {
  900. "type": "array",
  901. "items": {
  902. "type": "object",
  903. "properties": {
  904. "voucherMessageField1": {
  905. "type": "string",
  906. "description" : "Output string 3 lines of 15 characters."
  907. },
  908. "voucherNumber": {
  909. "type": "integer",
  910. "description" : "Voucher serial number maintained in ESI"
  911. },
  912. "voucherMessageField2": {
  913. "type": "string",
  914. "description" : "Output string 5 lines of 25 characters."
  915. },
  916. "voucherFixedText1": {
  917. "type": "string",
  918. "description" : "Fixed text on voucher ticket."
  919. },
  920. "voucherFixedText2": {
  921. "type": "string",
  922. "description" : "Fixed text on voucher ticket."
  923. },
  924. "promotionNumber": {
  925. "type": "string",
  926. "description" : "The last three digits of the promotion number."
  927. }
  928. }
  929. }
  930. },
  931. "ticketName": {
  932. "type": "string",
  933. "description" : "Name of the ticket as specified in OnlineGames SRS (predefined value); 'Bonus' string will be added at the end of the field if this is a bonus ticket"
  934. }
  935. }
  936. }
  937. }
  938. }
  939. },
  940. "spentToDateWeek": {
  941. "type": "number",
  942. "description" : "The amount a player spent for the remaining week"
  943. },
  944. "spentToDateMonth": {
  945. "type": "number",
  946. "description" : "The amount a player spent for the remaining month"
  947. }
  948. }
  949. }
  950. },
  951. "bullseyeWagers": {
  952. "type": "array",
  953. "items": {
  954. "type": "object",
  955. "properties": {
  956. "failureMessage": {
  957. "type": "string",
  958. "description": "Reason why this purchase request failed"
  959. },
  960. "transactionId": {
  961. "type": "string",
  962. "description" : "Transaction number maintained in ESi"
  963. },
  964. "ticketNumber": {
  965. "type": "string",
  966. "description" : "Unique ticket number maintained in ESi"
  967. },
  968. "gameTransactionNumber": {
  969. "type": "string",
  970. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  971. },
  972. "wagerAmount": {
  973. "type": "number",
  974. "description" : "Total cost of ticket"
  975. },
  976. "walletBalance": {
  977. "type": "number",
  978. "description" : "Updated wallet balance"
  979. },
  980. "promoTicketReturned": {
  981. "type": "boolean",
  982. "description" : "if a promotion ticket (e.g. voucher) is returned"
  983. },
  984. "voucherTicket": {
  985. "type": "array",
  986. "items": {
  987. "type": "object",
  988. "properties": {
  989. "promoTransactionId": {
  990. "type": "string",
  991. "description" : "Transaction number maintained in ESi"
  992. },
  993. "promoTicketNumber": {
  994. "type": "integer",
  995. "description" : "Unique promotion ticket number maintained in ESi"
  996. },
  997. "voucherSerial": {
  998. "type": "integer",
  999. "description" : "Voucher serial number as created by ESTE"
  1000. }
  1001. }
  1002. }
  1003. },
  1004. "spentToDateWeek": {
  1005. "type": "number",
  1006. "description" : "The amount a player spent for the remaining week"
  1007. },
  1008. "spentToDateMonth": {
  1009. "type": "number",
  1010. "description" : "The amount a player spent for the remaining month"
  1011. },
  1012. "ticketDetails": {
  1013. "type": "object",
  1014. "properties": {
  1015. "bullseyeDip": {
  1016. "type": "integer",
  1017. "description" : "Dip option corresponding to Bullseye Dip. The Dip option can be 1, 3 and 7."
  1018. },
  1019. "bullseyeBoard": {
  1020. "type": "array",
  1021. "items": {
  1022. "type": "object",
  1023. "properties": {
  1024. "numbers": {
  1025. "type": "array",
  1026. "items": {
  1027. "type": "integer",
  1028. "description" : "List of BullseyeNumberSelection objects which contains digit selection for each board, the digits compose of the Bullseye number (the digit at 0 position is the most significant and the last is the less significant); there should be always six numbers provided with leading zeros"
  1029. }
  1030. }
  1031. }
  1032. }
  1033. }
  1034. }
  1035. }
  1036. }
  1037. }
  1038. },
  1039. "kenoWagers": {
  1040. "type": "array",
  1041. "items": {
  1042. "type": "object",
  1043. "properties": {
  1044. "failureMessage": {
  1045. "type": "string",
  1046. "description": "Reason why this purchase request failed"
  1047. },
  1048. "transactionId": {
  1049. "type": "string",
  1050. "description" : "Transaction number maintained in ESi"
  1051. },
  1052. "ticketNumber": {
  1053. "type": "string",
  1054. "description" : "Unique ticket number maintained in ESi"
  1055. },
  1056. "gameTransactionNumber": {
  1057. "type": "string",
  1058. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  1059. },
  1060. "wagerAmount": {
  1061. "type": "number",
  1062. "description" : "Total cost of ticket"
  1063. },
  1064. "walletBalance": {
  1065. "type": "number",
  1066. "description" : "Updated wallet balance"
  1067. },
  1068. "promoTicketReturned": {
  1069. "type": "boolean",
  1070. "description" : "if a promotion ticket (e.g. voucher) is returned"
  1071. },
  1072. "voucherTicket": {
  1073. "type": "array",
  1074. "items": {
  1075. "type": "object",
  1076. "properties": {
  1077. "promoTransactionId": {
  1078. "type": "string",
  1079. "description" : "Transaction number maintained in ESi"
  1080. },
  1081. "promoTicketNumber": {
  1082. "type": "integer",
  1083. "description" : "Unique promotion ticket number maintained in ESi"
  1084. },
  1085. "voucherSerial": {
  1086. "type": "integer",
  1087. "description" : "Voucher serial number as created by ESTE"
  1088. }
  1089. }
  1090. }
  1091. },
  1092. "spentToDateWeek": {
  1093. "type": "number",
  1094. "description" : "The amount a player spent for the remaining week"
  1095. },
  1096. "spentToDateMonth": {
  1097. "type": "number",
  1098. "description" : "The amount a player spent for the remaining month"
  1099. },
  1100. "ticketDetails": {
  1101. "type": "object",
  1102. "properties": {
  1103. "kenoDip": {
  1104. "type": "integer",
  1105. "description": "Dip option corresponding to Keno Dip"
  1106. },
  1107. "drawTimes": {
  1108. "type": "array",
  1109. "items": [
  1110. {
  1111. "type": "string",
  1112. "description": "Draw times set (Keno only) 10 - 10 AM Draw 13 - 1 PM Draw 15 - 3 PM Draw 18 - 6 PM draw"
  1113. }
  1114. ]
  1115. },
  1116. "kenoBoard": {
  1117. "type": "array",
  1118. "items": {
  1119. "type": "object",
  1120. "properties": {
  1121. "groupNumber": {
  1122. "type": "integer",
  1123. "description": "Prize group played per board"
  1124. },
  1125. "numbers": {
  1126. "type": "array",
  1127. "items": {
  1128. "type": "integer",
  1129. "description": "List of KenoNumberSelection objects which contains number selection for each board"
  1130. }
  1131. }
  1132. }
  1133. }
  1134. }
  1135. }
  1136. }
  1137. }
  1138. }
  1139. },
  1140. "play3Wagers": {
  1141. "type": "array",
  1142. "items": {
  1143. "type": "object",
  1144. "properties": {
  1145. "failureMessage": {
  1146. "type": "string",
  1147. "description": "Reason why this purchase request failed"
  1148. },
  1149. "transactionId": {
  1150. "type": "string",
  1151. "description" : "Transaction number maintained in ESi"
  1152. },
  1153. "ticketNumber": {
  1154. "type": "string",
  1155. "description" : "Unique ticket number maintained in ESi"
  1156. },
  1157. "gameTransactionNumber": {
  1158. "type": "string",
  1159. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  1160. },
  1161. "wagerAmount": {
  1162. "type": "number",
  1163. "description" : "Total cost of ticket"
  1164. },
  1165. "walletBalance": {
  1166. "type": "number",
  1167. "description" : "Updated wallet balance"
  1168. },
  1169. "promoTicketReturned": {
  1170. "type": "boolean",
  1171. "description" : "if a promotion ticket (e.g. voucher) is returned"
  1172. },
  1173. "play3Tickets": {
  1174. "type": "array",
  1175. "items": {
  1176. "type": "object",
  1177. "properties": {
  1178. "transactionId": {
  1179. "type": "string",
  1180. "description" : "Transaction number maintained in ESi"
  1181. },
  1182. "ticketNumber": {
  1183. "type": "string",
  1184. "description" : "Unique ticket number maintained in ESi"
  1185. }
  1186. }
  1187. }
  1188. },
  1189. "voucherTicket": {
  1190. "type": "array",
  1191. "items": {
  1192. "type": "object",
  1193. "properties": {
  1194. "promoTransactionId": {
  1195. "type": "string",
  1196. "description" : "Transaction number maintained in ESi"
  1197. },
  1198. "promoTicketNumber": {
  1199. "type": "integer",
  1200. "description" : "Unique promotion ticket number maintained in ESi"
  1201. },
  1202. "voucherSerial": {
  1203. "type": "integer",
  1204. "description" : "Voucher serial number as created by ESTE"
  1205. }
  1206. }
  1207. }
  1208. },
  1209. "spentToDateWeek": {
  1210. "type": "number",
  1211. "description" : "The amount a player spent for the remaining week"
  1212. },
  1213. "spentToDateMonth": {
  1214. "type": "number",
  1215. "description" : "The amount a player spent for the remaining month"
  1216. },
  1217. "ticketDetails": {
  1218. "type": "object",
  1219. "properties": {
  1220. "play3Boards": {
  1221. "type": "array",
  1222. "items": {
  1223. "type": "object",
  1224. "properties": {
  1225. "numbers": {
  1226. "type": "array",
  1227. "items": {
  1228. "type": "integer",
  1229. "description": "List of play3NumberSelection objects which contains digit selection for each board, the are 3 digits "
  1230. }
  1231. },
  1232. "play3PlayType": {
  1233. "type": "string",
  1234. "description": "possible values are 'Exact', 'Any', 'Pairs', 'ExactAny', 'ExactPairs', 'ExactAnyPairs' ,'Combo'"
  1235. },
  1236. "play3BoardAmount": {
  1237. "type": "number",
  1238. "description": "price for purchased board. Just for validation purpose"
  1239. }
  1240. }
  1241. }
  1242. }
  1243. }
  1244. }
  1245. }
  1246. }
  1247. }
  1248. }
  1249. }
  1250. -
  1251. updatePlayerProfileInput: |
  1252. {
  1253. "$schema": "http://json-schema.org/draft-04/schema#",
  1254. "type" : "object",
  1255. "properties" : {
  1256. "password" : {
  1257. "type" : "string",
  1258. "description" : "Password entered by player as part of login credentials"
  1259. },
  1260. "username" : {
  1261. "type" : "string",
  1262. "description" : "Player's account number as created and stored in ESi database"
  1263. },
  1264. "firstName" : {
  1265. "type" : "string",
  1266. "description" : "Player's first name"
  1267. },
  1268. "lastName" : {
  1269. "type" : "string",
  1270. "description" : "Player's last name"
  1271. },
  1272. "gender" : {
  1273. "type" : "string",
  1274. "description" : "Player's gender"
  1275. },
  1276. "dateOfBirth" : {
  1277. "type" : "string",
  1278. "description" : "Date of birth in player's profile",
  1279. "pattern": "^[F0-9]{4}-[F0-9]{2}-[F0-9]{2}$"
  1280. },
  1281. "tlaArea" : {
  1282. "type" : "string",
  1283. "description" : "Player's TLA (Territory Local Authority) area designation"
  1284. },
  1285. "tlaLocation" : {
  1286. "type" : "string",
  1287. "description" : "Player's TLA (Territory Local Authority) area location"
  1288. },
  1289. "emailAddress" : {
  1290. "type" : "string",
  1291. "description" : "Player's email address to be used as username"
  1292. },
  1293. "optInEmailResultsNotify" : {
  1294. "type" : "boolean",
  1295. "description" : "Option to receive draw results by email. "
  1296. },
  1297. "optInLottoResults" : {
  1298. "type" : ["boolean", "null"],
  1299. "description" : "Option to receive Lotto family results as part of the 'Get Results Fast' option. "
  1300. },
  1301. "mobilePhone" : {
  1302. "type" : "string",
  1303. "description" : ""
  1304. },
  1305. "bankAccountNumber" : {
  1306. "type" : "string",
  1307. "description" : "Bank account number in player's profile"
  1308. },
  1309. "helpFlagEnabled" : {
  1310. "type" : "boolean",
  1311. "description" : "Indicates if the player has switched off their step by step help"
  1312. },
  1313. "phone" : {
  1314. "type" : "string",
  1315. "description" : "Player's phone number"
  1316. },
  1317. "bankAccountConfirmed" : {
  1318. "type" : "boolean",
  1319. "description" : "Status confirmation of player's bank account "
  1320. },
  1321. "referenceNumber" : {
  1322. "type" : "string",
  1323. "description" : ""
  1324. },
  1325. "postCode" : {
  1326. "type" : "string",
  1327. "description" : ""
  1328. },
  1329. "transAccountId" : {
  1330. "type" : "string",
  1331. "description" : ""
  1332. },
  1333. "transferId" : {
  1334. "type" : "string",
  1335. "description" : ""
  1336. },
  1337. "optInInstantKiwi" : {
  1338. "type" : ["boolean", "null"],
  1339. "description" : "Flag for Opt In Instant Kiwi"
  1340. },
  1341. "optInLottoJackpot" : {
  1342. "type" : ["boolean", "null"],
  1343. "description" : "Flag for Opt In Lotto Jackpot"
  1344. },
  1345. "optInLottoJackpotThreshold" : {
  1346. "type" : ["integer", "null"],
  1347. "description" : "Opt In Lotto Jackpot Threshold"
  1348. },
  1349. "optInMarketing" : {
  1350. "type" : ["boolean", "null"],
  1351. "description" : "Flag for Opt In Marketing"
  1352. }
  1353. },
  1354. "required": [ "password", "tlaArea", "tlaLocation"]
  1355. }
  1356. -
  1357. activationConfirmInput: |
  1358. {
  1359. "$schema": "http://json-schema.org/draft-04/schema#",
  1360. "type" : "object",
  1361. "properties" : {
  1362. "geofilterInfo" : {
  1363. "type" : "object",
  1364. "description" : "Geofilter information object",
  1365. "properties" : {
  1366. "charset" : {
  1367. "type" : "string",
  1368. "description" : "Geofilter information object"
  1369. },
  1370. "language" : {
  1371. "type" : "string",
  1372. "description" : "Language attribute of the request"
  1373. },
  1374. "browser" : {
  1375. "type" : "string",
  1376. "description" : "User-Agent attribute of the request"
  1377. },
  1378. "clientIP" : {
  1379. "type" : "string",
  1380. "description" : "IPAdress of the client"
  1381. },
  1382. "proxyInfo" : {
  1383. "type" : "string",
  1384. "description" : "Proxy information of the request"
  1385. },
  1386. "localTime" : {
  1387. "type" : "string",
  1388. "description" : "Local Time"
  1389. },
  1390. "timeZoneOffset" : {
  1391. "type" : "string",
  1392. "description" : "Time zone offset"
  1393. },
  1394. "encoding" : {
  1395. "type" : "string",
  1396. "description" : "Encoding attribute of the request"
  1397. }
  1398. }
  1399. },
  1400. "activationId" : {
  1401. "type" : "string",
  1402. "description" : "Activation number contained in email notification to player which when sent to ESi will change the player status to 'Confirmed' "
  1403. }
  1404. },
  1405. "required": [ "activationId" ]
  1406. }
  1407. -
  1408. activationConfirmOutput: |
  1409. {
  1410. "$schema": "http://json-schema.org/draft-04/schema#",
  1411. "type" : "object",
  1412. "properties" : {
  1413. "userId" : {
  1414. "type" : "string",
  1415. "description" : "Player’s account number as created and stored in ESi database"
  1416. },
  1417. "emailAddress" : {
  1418. "type" : "string",
  1419. "description" : "Player’s Email"
  1420. },
  1421. "playerStatus" : {
  1422. "type" : "object",
  1423. "properties" : {
  1424. "playerCode" : {
  1425. "type" : "number",
  1426. "description" : "Status code which reflects “Non-Confirmed”, “Verified ID” or “Confirmed” to indicate player’s status"
  1427. },
  1428. "playerDescription" : {
  1429. "type" : "string",
  1430. "description" : "Text description of the playerCode, e.g. Full MyLotto User"
  1431. }
  1432. }
  1433. },
  1434. "activationIdExpired" : {
  1435. "type" : "boolean",
  1436. "description" : "'true' or 'false' to indicate if activationId is expired or not"
  1437. }
  1438. }
  1439. }
  1440. -
  1441. securityTnCRegistrationInput: |
  1442. {
  1443. "$schema": "http://json-schema.org/draft-04/schema#",
  1444. "type": "object",
  1445. "properties": {
  1446. "password": {
  1447. "type": "string",
  1448. "description": "Password entered by player as part of login credentials"
  1449. },
  1450. "firstName": {
  1451. "type": "string",
  1452. "description": "Player’s first name"
  1453. },
  1454. "lastName": {
  1455. "type": "string",
  1456. "description": "Player’s last name"
  1457. },
  1458. "gender": {
  1459. "type": "string",
  1460. "description": "Player’s gender"
  1461. },
  1462. "dateOfBirth": {
  1463. "type": "string",
  1464. "description": "Player’s Date of Birth",
  1465. "pattern": "^[F0-9]{4}-[F0-9]{2}-[F0-9]{2}$"
  1466. },
  1467. "tlaArea": {
  1468. "type": "string",
  1469. "description": "Player’s TLA (Territory Local Authority) area designation"
  1470. },
  1471. "tlaLocation": {
  1472. "type": "string",
  1473. "description": "Player’s TLA (Territory Local Authority) area location"
  1474. },
  1475. "phone": {
  1476. "type": "string",
  1477. "description": "Player’s phone number"
  1478. },
  1479. "emailAddress": {
  1480. "type": "string",
  1481. "description": "Player’s email address to be used as username"
  1482. },
  1483. "optInLottoResults": {
  1484. "type": "boolean",
  1485. "description": "Option to receive Lotto family results as part of the ‘Get Results Fast’ option. Default value = 'false'"
  1486. },
  1487. "securityQuestionId": {
  1488. "type": "number",
  1489. "description": "Hint ID corresponding to question number 1 entered by player as part of password retrieval process"
  1490. },
  1491. "securityAnswer": {
  1492. "type": "string",
  1493. "description": "Answer to hint question number 1 entered by player as part of password retrieval process"
  1494. },
  1495. "userAgreed": {
  1496. "type": "boolean",
  1497. "description": "Indication that player has agreed and accepted terms and conditions. 'true' or 'false'; if not set to 'true' the registration will stop and empty response object will be returned"
  1498. },
  1499. "geofilterInfo": {
  1500. "type": "object",
  1501. "description": "Geofilter information object",
  1502. "properties": {
  1503. "charset": {
  1504. "type": "string",
  1505. "description": "Geofilter information object"
  1506. },
  1507. "language": {
  1508. "type": "string",
  1509. "description": "Language attribute of the request"
  1510. },
  1511. "browser": {
  1512. "type": "string",
  1513. "description": "User-Agent attribute of the request"
  1514. },
  1515. "clientIP": {
  1516. "type": "string",
  1517. "description": "IPAdress of the client"
  1518. },
  1519. "proxyInfo": {
  1520. "type": "string",
  1521. "description": "Proxy information of the request"
  1522. },
  1523. "localTime": {
  1524. "type": "string",
  1525. "description": "Local Time"
  1526. },
  1527. "timeZoneOffset": {
  1528. "type": "string",
  1529. "description": "Time zone offset"
  1530. },
  1531. "encoding": {
  1532. "type": "string",
  1533. "description": "Encoding attribute of the request"
  1534. }
  1535. }
  1536. },
  1537. "optInInstantKiwi": {
  1538. "type": "boolean",
  1539. "description": "Flag for Opt In Instant Kiwi"
  1540. },
  1541. "optInLottoJackpot": {
  1542. "type": "boolean",
  1543. "description": "Flag for Opt In Lotto Jackpot"
  1544. },
  1545. "optInLottoJackpotThreshold": {
  1546. "type": "integer",
  1547. "description": "Opt In Lotto Jackpot Threshold"
  1548. },
  1549. "optInMarketing": {
  1550. "type": "boolean",
  1551. "description": "Flag for opt In Marketing"
  1552. },
  1553. "playerStatus": {
  1554. "type": "string",
  1555. "description": "Represents player/account status during multistep registration process"
  1556. }
  1557. },
  1558. "required": [
  1559. "password",
  1560. "firstName",
  1561. "lastName",
  1562. "gender",
  1563. "dateOfBirth",
  1564. "tlaArea",
  1565. "tlaLocation",
  1566. "phone",
  1567. "emailAddress",
  1568. "securityQuestionId",
  1569. "securityAnswer",
  1570. "userAgreed",
  1571. "geofilterInfo",
  1572. "optInLottoResults",
  1573. "optInLottoJackpotThreshold",
  1574. "optInLottoJackpot",
  1575. "optInMarketing",
  1576. "optInInstantKiwi"
  1577. ]
  1578. }
  1579. -
  1580. securityTnCRegistrationOutput: |
  1581. {
  1582. "$schema": "http://json-schema.org/draft-04/schema#",
  1583. "type" : "object",
  1584. "properties" : {
  1585. "playerStatus" : {
  1586. "type" : "object",
  1587. "properties" : {
  1588. "playerCode" : {
  1589. "type" : "number",
  1590. "description" : "Status code which reflects “Non-Confirmed”, “Verified ID” or “Confirmed” to indicate player’s status"
  1591. },
  1592. "playerDescription" : {
  1593. "type" : "string",
  1594. "description" : "Text description of the playerCode, e.g. Full MyLotto User"
  1595. }
  1596. }
  1597. },
  1598. "userId" : {
  1599. "type" : "string",
  1600. "description" : "Player’s account number as stored in ESi database"
  1601. }
  1602. }
  1603. }
  1604. -
  1605. changePasswordInput: |
  1606. {
  1607. "$schema": "http://json-schema.org/draft-04/schema#",
  1608. "type" : "object",
  1609. "properties" : {
  1610. "currentPassword" : {
  1611. "type" : "string",
  1612. "description" : "Player entered password used to log into player web portal"
  1613. },
  1614. "newPassword" : {
  1615. "type" : "string",
  1616. "description" : "New password to be changed to, as entered by player"
  1617. }
  1618. },
  1619. "required": ["currentPassword", "newPassword" ]
  1620. }
  1621. -
  1622. getHintQuestionsOutput: |
  1623. {
  1624. "$schema": "http://json-schema.org/draft-04/schema#",
  1625. "id": "http://jsonschema.net",
  1626. "type": "array",
  1627. "items": [
  1628. {
  1629. "id": "http://jsonschema.net/0",
  1630. "type": "object",
  1631. "properties": {
  1632. "type": {
  1633. "id": "http://jsonschema.net/0/type",
  1634. "type": "integer"
  1635. },
  1636. "question": {
  1637. "id": "http://jsonschema.net/0/question",
  1638. "type": "string"
  1639. }
  1640. },
  1641. "required": [
  1642. "type",
  1643. "question"
  1644. ]
  1645. }
  1646. ]
  1647. }
  1648. -
  1649. getHintQuestionOutput: |
  1650. {
  1651. "$schema": "http://json-schema.org/draft-04/schema#",
  1652. "type" : "object",
  1653. "properties" : {
  1654. "type" : {
  1655. "type" : "number",
  1656. "description" : "ID corresponding to the hint question"
  1657. },
  1658. "question" : {
  1659. "type" : "string",
  1660. "description" : "Player's hint question corresponding to the question id above, as stored in ESi database"
  1661. }
  1662. }
  1663. }
  1664. -
  1665. changeHintQuestionsAnswersInput: |
  1666. {
  1667. "$schema": "http://json-schema.org/draft-04/schema#",
  1668. "type" : "object",
  1669. "properties" : {
  1670. "password" : {
  1671. "type" : "string",
  1672. "description" : "Password entered by player as part of login credentials, optional if transaction is done by admin on behalf on user"
  1673. },
  1674. "userId" : {
  1675. "type" : "string",
  1676. "description" : "Player's account number as created and stored in ESi database."
  1677. },
  1678. "username" : {
  1679. "type" : "string",
  1680. "description" : "Player's email address to be used as username"
  1681. },
  1682. "hintId1" : {
  1683. "type" : "number",
  1684. "description" : "ID corresponding to the hint question 1 picked by player; must not be 0"
  1685. },
  1686. "hintId2" : {
  1687. "type" : "number",
  1688. "description" : "ID corresponding to the hint question 2 picked by player; if set to 0 – no hint question number 2 (for newly registered players, after Grand Design), must be consistent with hint question 3 (one hint question or all three)"
  1689. },
  1690. "hintId3" : {
  1691. "type" : "number",
  1692. "description" : "ID corresponding to the hint question 3 picked by player; if set to 0 – no hint question number 3 (for newly registered players, after Grand Design), must be consistent with hint question 2 (one hint question or all three)"
  1693. },
  1694. "hint1Ans" : {
  1695. "type" : "string",
  1696. "description" : "Answer to hint question number 1 entered by player; must not be null"
  1697. },
  1698. "hint2Ans" : {
  1699. "type" : "string",
  1700. "description" : "Answer to hint question number 2 entered by player; ignored if hint id equals 0"
  1701. },
  1702. "hint3Ans" : {
  1703. "type" : "string",
  1704. "description" : "Answer to hint question number 3 entered by player; ignored if hint id equals 0"
  1705. }
  1706. },
  1707. "required": [ "password", "userId", "hintId1", "hint1Ans" ]
  1708. }
  1709. -
  1710. validateHintOutput: |
  1711. {
  1712. "$schema": "http://json-schema.org/draft-04/schema#",
  1713. "type" : "object",
  1714. "properties" : {
  1715. "hintAnswerTrue" : {
  1716. "type" : "boolean",
  1717. "description" : "Whether hint answer is true or not for the player"
  1718. }
  1719. }
  1720. }
  1721. -
  1722. ticketDetailsOutput: |
  1723. {
  1724. "$schema": "http://json-schema.org/draft-04/schema#",
  1725. "type": "object",
  1726. "properties": {
  1727. "gameName": {
  1728. "type": "string",
  1729. "description" : "Game name"
  1730. },
  1731. "numberOfBoards": {
  1732. "type": "integer",
  1733. "description" : "Number of boards wager is purchased for"
  1734. },
  1735. "numberOfDraws": {
  1736. "type": "integer",
  1737. "description" : "Number of draws wager is purchased for, starting from current draw"
  1738. },
  1739. "systemNumber": {
  1740. "type": "integer",
  1741. "description" : "System number for combo wagers."
  1742. },
  1743. "wagerAmount": {
  1744. "type": "number",
  1745. "description" : "Total purchase amount"
  1746. },
  1747. "pricePerBoard": {
  1748. "type": "number",
  1749. "description" : "Amount wagered per board"
  1750. },
  1751. "ticketNumber": {
  1752. "type": "string",
  1753. "description" : "Unique ticket number maintained in ESi"
  1754. },
  1755. "ticketType": {
  1756. "type": "string",
  1757. "description" : "Ticket type description"
  1758. },
  1759. "purchaseDate": {
  1760. "type": "string",
  1761. "description" : "Date ticket was purchased"
  1762. },
  1763. "ticketStatus": {
  1764. "type": "string",
  1765. "description" : "Ticket status"
  1766. },
  1767. "gameTransactionNumber": {
  1768. "type": "string",
  1769. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  1770. },
  1771. "couponType": {
  1772. "type": "boolean",
  1773. "description" : "Wager is played via manual entry of coupon"
  1774. },
  1775. "cancelDetails": {
  1776. "type": "array",
  1777. "items": {
  1778. "type": "object",
  1779. "properties": {
  1780. "cancelDate": {
  1781. "type": "string"
  1782. },
  1783. "cancelSerial": {
  1784. "type": "string"
  1785. },
  1786. "cancelTime": {
  1787. "type": "string"
  1788. }
  1789. }
  1790. }
  1791. },
  1792. "drawWinDetails": {
  1793. "type": "array",
  1794. "items": {
  1795. "type": "object",
  1796. "properties": {
  1797. "lottoNumber": {
  1798. "type": "integer",
  1799. "description" : ""
  1800. },
  1801. "bonusTickets": {
  1802. "type": "integer",
  1803. "description" : ""
  1804. },
  1805. "drawDate": {
  1806. "type": "string",
  1807. "description" : "Draw date"
  1808. },
  1809. "drawStatus": {
  1810. "type": "string",
  1811. "description" : "Draw status"
  1812. },
  1813. "winAmount": {
  1814. "type": "number",
  1815. "description" : "Winning amount for cash prizes"
  1816. },
  1817. "winningFlag": {
  1818. "type": "boolean",
  1819. "description" : "Flag to indicate ticket is a winner"
  1820. },
  1821. "drawTicketStatus": {
  1822. "type": "string",
  1823. "description" : ""
  1824. },
  1825. "megaDipType": {
  1826. "type": "boolean",
  1827. "description" : ""
  1828. },
  1829. "drawNumber": {
  1830. "type": "integer",
  1831. "description" : "Draw number"
  1832. },
  1833. "lottoLuckyDip": {
  1834. "type": "boolean",
  1835. "description" : ""
  1836. },
  1837. "lottoPowerDip": {
  1838. "type": "boolean",
  1839. "description" : ""
  1840. },
  1841. "lottoTripleDip": {
  1842. "type": "boolean",
  1843. "description" : ""
  1844. },
  1845. "winningNumbersSet": {
  1846. "type": "array",
  1847. "items": {
  1848. "type": "object",
  1849. "properties": {
  1850. "winningNumbers": {
  1851. "type": "array",
  1852. "items": {
  1853. "type": "object",
  1854. "properties": {
  1855. "individualWinningNumber": {
  1856. "type": "integer",
  1857. "description" : ""
  1858. }
  1859. }
  1860. }
  1861. }
  1862. },
  1863. "winningPowerballNumber": {
  1864. "type": "integer",
  1865. "description" : ""
  1866. }
  1867. }
  1868. },
  1869. "bullseyeDivisionRange": {
  1870. "type": "array",
  1871. "items": {
  1872. "type": "object",
  1873. "properties": {
  1874. "divisionNumber": {
  1875. "type": "integer",
  1876. "description" : ""
  1877. },
  1878. "divisionLowerNumber": {
  1879. "type": "integer",
  1880. "description" : ""
  1881. },
  1882. "divisionUpperNumber": {
  1883. "type": "integer",
  1884. "description" : ""
  1885. }
  1886. }
  1887. }
  1888. }
  1889. }
  1890. }
  1891. },
  1892. "strikeWagerDetails": {
  1893. "type": "array",
  1894. "items": {
  1895. "type": "object",
  1896. "properties": {
  1897. "strikeBoard": {
  1898. "type": "array",
  1899. "items": {
  1900. "type": "object",
  1901. "properties": {
  1902. "numbers": {
  1903. "type": "array",
  1904. "items": {
  1905. "type": "integer",
  1906. "description" : "Numbers selected"
  1907. }
  1908. }
  1909. }
  1910. }
  1911. },
  1912. "drawDays": {
  1913. "type": "array",
  1914. "items": [
  1915. {
  1916. "type": "string",
  1917. "description" : "Draw Day for example: Wed, Sat"
  1918. }
  1919. ]
  1920. }
  1921. }
  1922. }
  1923. },
  1924. "lottoWagerDetails": {
  1925. "type": "array",
  1926. "items": {
  1927. "type": "object",
  1928. "properties": {
  1929. "starterDipType": {
  1930. "type": "boolean",
  1931. "description" : ""
  1932. },
  1933. "lottoLuckyDip": {
  1934. "type": "boolean",
  1935. "description" : "Dip option corresponding to Lotto Lucky Dip"
  1936. },
  1937. "lottoPowerDip": {
  1938. "type": "boolean",
  1939. "description" : "Dip option corresponding to Lotto Power Dip"
  1940. },
  1941. "lottoTripleDip": {
  1942. "type": "boolean",
  1943. "description" : "Dip option corresponding to Lotto Triple Dip"
  1944. },
  1945. "basicDipType": {
  1946. "type": "boolean",
  1947. "description" : "Dip type - basic"
  1948. },
  1949. "superDipType": {
  1950. "type": "boolean",
  1951. "description" : "Dip type - super"
  1952. },
  1953. "superPlusDipType": {
  1954. "type": "boolean",
  1955. "description" : "Dip type - super plus"
  1956. },
  1957. "megaDipType": {
  1958. "type": "boolean",
  1959. "description" : "Dip type - mega"
  1960. },
  1961. "mega24DipType": {
  1962. "type": "boolean",
  1963. "description" : "Dip type - mega24, old type mega with wager amount of $24"
  1964. },
  1965. "lottoBoard": {
  1966. "type": "array",
  1967. "items": {
  1968. "type": "object",
  1969. "properties": {
  1970. "powerballNumber": {
  1971. "type": "integer",
  1972. "description" : "Powerball number for board if selected"
  1973. },
  1974. "numbers": {
  1975. "type": "array",
  1976. "items": {
  1977. "type": "integer",
  1978. "description" : "List of LottoNumberSelection objects which contains number selection for each board"
  1979. }
  1980. }
  1981. }
  1982. }
  1983. },
  1984. "drawDays": {
  1985. "type": "array",
  1986. "items": [
  1987. {
  1988. "type": "string",
  1989. "description" : "Draw Day for example: Wed, Sat"
  1990. }
  1991. ]
  1992. }
  1993. }
  1994. }
  1995. },
  1996. "bullseyeWagerDetails": {
  1997. "type": "array",
  1998. "items": {
  1999. "type": "object",
  2000. "properties": {
  2001. "bullseyeDip": {
  2002. "type": "integer",
  2003. "description" : "Dip option corresponding to Bullseye Dip. The Dip option can be 1, 3 and 7."
  2004. },
  2005. "bullseyeBoard": {
  2006. "type": "array",
  2007. "items": {
  2008. "type": "object",
  2009. "properties": {
  2010. "numbers": {
  2011. "type": "array",
  2012. "items": {
  2013. "type": "integer",
  2014. "description" : "List of BullseyeNumberSelection objects which contains digit selection for each board, the digits compose of the Bullseye number (the digit at 0 position is the most significant and the last is the less significant); there should be always six numbers provided with leading zeros"
  2015. }
  2016. }
  2017. }
  2018. }
  2019. }
  2020. }
  2021. }
  2022. },
  2023. "kenoWagerDetails": {
  2024. "type": "array",
  2025. "items": {
  2026. "type": "object",
  2027. "properties": {
  2028. "kenoDip": {
  2029. "type": "integer",
  2030. "description" : "Dip option corresponding to Keno Dip"
  2031. },
  2032. "drawTimes": {
  2033. "type": "array",
  2034. "items": [
  2035. {
  2036. "type": "string",
  2037. "description" : "Draw times set (Keno only) 10 - 10 AM Draw 13 - 1 PM Draw 15 - 3 PM Draw 18 - 6 PM draw"
  2038. }
  2039. ]
  2040. },
  2041. "kenoBoard": {
  2042. "type": "array",
  2043. "items": {
  2044. "type": "object",
  2045. "properties": {
  2046. "groupNumber": {
  2047. "type": "integer",
  2048. "description" : "Prize group played per board"
  2049. },
  2050. "numbers": {
  2051. "type": "array",
  2052. "items": {
  2053. "type": "integer",
  2054. "description" : "List of KenoNumberSelection objects which contains number selection for each board"
  2055. }
  2056. }
  2057. }
  2058. }
  2059. }
  2060. }
  2061. }
  2062. },
  2063. "play3WagerDetails": {
  2064. "type": "array",
  2065. "items": {
  2066. "type": "object",
  2067. "properties": {
  2068. "play3Boards": {
  2069. "type": "array",
  2070. "items": {
  2071. "type": "object",
  2072. "properties": {
  2073. "numbers": {
  2074. "type": "array",
  2075. "items": {
  2076. "type": "integer",
  2077. "description" : "List of play3NumberSelection objects which contains digit selection for each board, the are 3 digits "
  2078. }
  2079. },
  2080. "play3PlayType": {
  2081. "type": "string",
  2082. "description" : "possible values are 'Exact', 'Any', 'Pairs', 'ExactAny', 'ExactPairs', 'ExactAnyPairs' ,'Combo'"
  2083. },
  2084. "play3BoardAmount": {
  2085. "type": "number",
  2086. "description" : "price for purchased board. Just for validation purpose"
  2087. }
  2088. }
  2089. }
  2090. }
  2091. }
  2092. }
  2093. },
  2094. "promoTicketReturned": {
  2095. "type": "boolean",
  2096. "description" : "Wager qualified for a promotion/voucher ticket"
  2097. },
  2098. "startDraw": {
  2099. "type": "integer",
  2100. "description" : "Start draw number of wager."
  2101. },
  2102. "ticketMessage": {
  2103. "type": "string",
  2104. "description" : "Output string 4 lines of 26 characters."
  2105. },
  2106. "voucherDetails": {
  2107. "type": "array",
  2108. "items": {
  2109. "type": "object",
  2110. "properties": {
  2111. "voucherMessageField1": {
  2112. "type": "string",
  2113. "description" : "Output string 3 lines of 15 characters."
  2114. },
  2115. "voucherNumber": {
  2116. "type": "integer",
  2117. "description" : "Voucher serial number maintained in ESI"
  2118. },
  2119. "voucherMessageField2": {
  2120. "type": "string",
  2121. "description" : "Output string 5 lines of 25 characters."
  2122. },
  2123. "voucherFixedText1": {
  2124. "type": "string",
  2125. "description" : "Fixed text on voucher ticket."
  2126. },
  2127. "voucherFixedText2": {
  2128. "type": "string",
  2129. "description" : "Fixed text on voucher ticket."
  2130. },
  2131. "promotionNumber": {
  2132. "type": "string",
  2133. "description" : "The last three digits of the promotion number."
  2134. }
  2135. }
  2136. }
  2137. },
  2138. "ticketName": {
  2139. "type": "string",
  2140. "description" : "Name of the ticket as specified in OnlineGames SRS (predefined value); 'Bonus' string will be added at the end of the field if this is a bonus ticket"
  2141. }
  2142. }
  2143. }
  2144. -
  2145. loadWalletOutput: |
  2146. {
  2147. "$schema": "http://json-schema.org/draft-04/schema#",
  2148. "type" : "object",
  2149. "properties" : {
  2150. "truncatedCardNumber" : {
  2151. "type" : "string",
  2152. "description" : "First 6, last 2 digits of the player's credit card number"
  2153. },
  2154. "expirationDate" : {
  2155. "type" : "string",
  2156. "description" : "Credit card expiry date in MMYY format"
  2157. },
  2158. "walletStatus" : {
  2159. "type" : "number",
  2160. "description" : "Status code which reflects 'Active' or 'Suspended' to indicate player's wallet status"
  2161. },
  2162. "weeklyTransferredAmount" : {
  2163. "type" : "number",
  2164. "description" : "The cumulative amount the player has transferred for the given week"
  2165. },
  2166. "weeklyTransferredCount" : {
  2167. "type" : "number",
  2168. "description" : "The cumulative count of transfers the player has executed for the given week"
  2169. }
  2170. }
  2171. }
  2172. -
  2173. loadWalletConfirmInput: |
  2174. {
  2175. "$schema": "http://json-schema.org/draft-04/schema#",
  2176. "type" : "object",
  2177. "properties" : {
  2178. "transactionId" : {
  2179. "type" : "string",
  2180. "description" : "The transaction id as generated by validate"
  2181. }
  2182. },
  2183. "required": [ "transactionId" ]
  2184. }
  2185. -
  2186. loadWalletConfirmOutput: |
  2187. {
  2188. "$schema": "http://json-schema.org/draft-04/schema#",
  2189. "type" : "object",
  2190. "properties" : {
  2191. "walletBalance" : {
  2192. "type" : "number",
  2193. "description" : "Updated wallet balance"
  2194. }
  2195. }
  2196. }
  2197. -
  2198. loadWalletUpdateInput: |
  2199. {
  2200. "$schema": "http://json-schema.org/draft-04/schema#",
  2201. "type" : "object",
  2202. "properties" : {
  2203. "amount" : {
  2204. "type" : "number",
  2205. "description" : "The amount in dollars"
  2206. },
  2207. "cvc" : {
  2208. "type" : "number",
  2209. "description" : "The Credit Card's CVC code"
  2210. },
  2211. "password" : {
  2212. "type" : "string",
  2213. "description" : "The user's accoutn password"
  2214. }
  2215. },
  2216. "required": [ "amount", "cvc", "password" ]
  2217. }
  2218. -
  2219. loadWalletValidateInput: |
  2220. {
  2221. "$schema": "http://json-schema.org/draft-04/schema#",
  2222. "type" : "object",
  2223. "properties" : {
  2224. "password" : {
  2225. "type" : "string",
  2226. "description" : "Player entered password used to log into player web portal . Optional when admin user is used."
  2227. },
  2228. "returnUrl" : {
  2229. "type" : "string",
  2230. "description" : "The URL DPS will redirect the form submit to"
  2231. }
  2232. },
  2233. "required": [ "password", "returnUrl" ]
  2234. }
  2235. -
  2236. loadWalletValidateOutput: |
  2237. {
  2238. "$schema": "http://json-schema.org/draft-04/schema#",
  2239. "type" : "object",
  2240. "properties" : {
  2241. "transactionId" : {
  2242. "type" : "string",
  2243. "description" : "Transactionid for this operation"
  2244. }
  2245. }
  2246. }
  2247. -
  2248. unloadWalletInput: |
  2249. {
  2250. "$schema": "http://json-schema.org/draft-04/schema#",
  2251. "type" : "object",
  2252. "properties" : {
  2253. "password" : {
  2254. "type" : "string",
  2255. "description" : "Player entered password used to log into player web portal . Optional when admin user is used."
  2256. },
  2257. "transferAmount" : {
  2258. "type" : "number",
  2259. "description" : "The transfer amount requested by player at time of transfer"
  2260. }
  2261. },
  2262. "required": [ "password", "transferAmount" ]
  2263. }
  2264. -
  2265. unloadWalletOutput: |
  2266. {
  2267. "$schema": "http://json-schema.org/draft-04/schema#",
  2268. "type" : "object",
  2269. "properties" : {
  2270. "walletStatus" : {
  2271. "type" : "number",
  2272. "description" : "Status code which reflects 'Active' or 'Suspended' to indicate player's wallet status"
  2273. },
  2274. "walletBalance" : {
  2275. "type" : "number",
  2276. "description" : "Updated wallet balance"
  2277. }
  2278. }
  2279. }
  2280. -
  2281. getLockedGamesOutput: |
  2282. {
  2283. "$schema": "http://json-schema.org/draft-04/schema#",
  2284. "type": "array",
  2285. "items": [
  2286. {
  2287. "id": "http://jsonschema.net/games/1",
  2288. "type": "object",
  2289. "properties": {
  2290. "game": {
  2291. "type": "string",
  2292. "description" : "Game type, possibel valeus are Lotto, Play3, Keno and Bullseye"
  2293. },
  2294. "locked": {
  2295. "type": "boolean",
  2296. "description" : "'true' or 'false' to indicate if player has been excluded from this game"
  2297. },
  2298. "reactivationDate": {
  2299. "type": "string",
  2300. "description" : "Date of game to be re-activated"
  2301. }
  2302. }
  2303. }
  2304. ]
  2305. }
  2306. -
  2307. editLockedGamesInput: |
  2308. {
  2309. "$schema": "http://json-schema.org/draft-04/schema#",
  2310. "id": "http://jsonschema.net",
  2311. "type": "object",
  2312. "properties": {
  2313. "password": {
  2314. "type": "string",
  2315. "description" : "Password entered by player as part of login credentials"
  2316. },
  2317. "games": {
  2318. "type": "array",
  2319. "items": [
  2320. {
  2321. "id": "http://jsonschema.net/games/1",
  2322. "type": "object",
  2323. "properties": {
  2324. "game": {
  2325. "enum": [ "Lotto", "Play3", "Keno", "Bullseye" ],
  2326. "description" : "Game type, possible values are Lotto, Play3, Keno and Bullseye"
  2327. },
  2328. "locked": {
  2329. "type": "boolean",
  2330. "description" : "'true' or 'false' to indicate if player has been excluded from this game"
  2331. },
  2332. "reactivationDate": {
  2333. "type": "string",
  2334. "description" : "Date of game to be re-activated",
  2335. "pattern": "^[F0-9]{4}-[F0-9]{2}-[F0-9]{2}$"
  2336. }
  2337. }
  2338. }
  2339. ]
  2340. }
  2341. }
  2342. }
  2343. -
  2344. gameHistOutput: |
  2345. {
  2346. "$schema": "http://json-schema.org/draft-04/schema#",
  2347. "type": "object",
  2348. "properties": {
  2349. "drawStartDate": {
  2350. "type": "string",
  2351. "description" : ""
  2352. },
  2353. "drawEndDate": {
  2354. "type": "string",
  2355. "description" : ""
  2356. },
  2357. "gameHistory": {
  2358. "type": "array",
  2359. "items": {
  2360. "type": "object",
  2361. "properties": {
  2362. "gameName": {
  2363. "type": "string",
  2364. "description" : "Game name"
  2365. },
  2366. "ticketNumber": {
  2367. "type": "string",
  2368. "description" : "Unique ticket number maintained in ESi"
  2369. },
  2370. "drawId": {
  2371. "type": "string",
  2372. "description" : ""
  2373. },
  2374. "drawDate": {
  2375. "type": "string",
  2376. "description" : ""
  2377. },
  2378. "merchandiseDescription": {
  2379. "type": "string",
  2380. "description" : "Description of merchandise prize if applicable"
  2381. },
  2382. "ticketType": {
  2383. "type": "string",
  2384. "description" : "Ticket type description"
  2385. },
  2386. "drawStartDate": {
  2387. "type": "string",
  2388. "description" : "Draw start date for the ticket"
  2389. },
  2390. "drawEndDate": {
  2391. "type": "string",
  2392. "description" : "Draw end date for the ticket"
  2393. },
  2394. "purchaseDate": {
  2395. "type": "string",
  2396. "description" : "Date ticket was purchased"
  2397. },
  2398. "purchaseAmount": {
  2399. "type": "string",
  2400. "description" : ""
  2401. },
  2402. "ticketStatus": {
  2403. "type": "string",
  2404. "description" : "Ticket status"
  2405. },
  2406. "gameTransactionNumber": {
  2407. "type": "string",
  2408. "description" : "Unique transaction number maintained in ESi to link all wagers which are part of a dip"
  2409. },
  2410. "promoId": {
  2411. "type": "integer",
  2412. "description" : "Last three digits of the promotion id, if the ticket is of type voucher"
  2413. },
  2414. "drawHistoryInfo": {
  2415. "type": "array",
  2416. "items": {
  2417. "type": "object",
  2418. "properties": {
  2419. "drawId": {
  2420. "type": "integer",
  2421. "description" : "Draw number"
  2422. },
  2423. "drawDate": {
  2424. "type": "string",
  2425. "description" : "Date of draw"
  2426. },
  2427. "merchandiseDescription": {
  2428. "type": "string",
  2429. "description" : ""
  2430. },
  2431. "drawStatus": {
  2432. "type": "string",
  2433. "description" : "Draw status"
  2434. },
  2435. "winoutcome": {
  2436. "type": "string",
  2437. "description" : ""
  2438. },
  2439. "drawTicketStatus": {
  2440. "type": "string",
  2441. "description" : "Draw ticket status"
  2442. }
  2443. }
  2444. }
  2445. },
  2446. "drawStatus": {
  2447. "type": "string",
  2448. "description" : ""
  2449. },
  2450. "gamePrizeWon": {
  2451. "type": "string",
  2452. "description" : ""
  2453. },
  2454. "gameStatus": {
  2455. "type": "string",
  2456. "description" : ""
  2457. },
  2458. "gameTicketNumber": {
  2459. "type": "string",
  2460. "description" : ""
  2461. },
  2462. "gameTypeName": {
  2463. "type": "string",
  2464. "description" : ""
  2465. },
  2466. "gameWinStatus": {
  2467. "type": "string",
  2468. "description" : ""
  2469. },
  2470. "orderId": {
  2471. "type": "string",
  2472. "description" : ""
  2473. },
  2474. "outComeTier": {
  2475. "type": "string",
  2476. "description" : ""
  2477. },
  2478. "ticketTransasctionId": {
  2479. "type": "string",
  2480. "description" : ""
  2481. },
  2482. "chequeNo": {
  2483. "type": "string",
  2484. "description" : ""
  2485. },
  2486. "winAmount": {
  2487. "type": "number",
  2488. "description" : ""
  2489. },
  2490. "winningFlag": {
  2491. "type": "boolean",
  2492. "description" : ""
  2493. },
  2494. "winoutcome": {
  2495. "type": "string",
  2496. "description" : ""
  2497. }
  2498. }
  2499. }
  2500. }
  2501. },
  2502. "required": [
  2503. "gameHistory"
  2504. ]
  2505. }
  2506. -
  2507. listFavouriteOutput: |
  2508. {
  2509. "$schema": "http://json-schema.org/draft-04/schema#",
  2510. "id": "http://jsonschema.net",
  2511. "type": "object",
  2512. "properties": {
  2513. "favourites": {
  2514. "type": "array",
  2515. "items": [
  2516. {
  2517. "$schema": "http://json-schema.org/draft-04/schema#",
  2518. "type": "object",
  2519. "properties": {
  2520. "favouriteName": {
  2521. "type": "string",
  2522. "description" : ""
  2523. },
  2524. "sequenceId": {
  2525. "type": "integer",
  2526. "description" : "Sequence ID of favourite play"
  2527. },
  2528. "gameName": {
  2529. "type": "string",
  2530. "description" : "Game name for which favourite play is configured"
  2531. },
  2532. "playSlipId": {
  2533. "type": "string",
  2534. "description" : ""
  2535. },
  2536. "numberOfBoards": {
  2537. "type": "integer",
  2538. "description" : "Number of boards wager is purchased for"
  2539. },
  2540. "numberOfDraws": {
  2541. "type": "integer",
  2542. "description" : "Number of draws wager is purchased for, starting from current draw"
  2543. },
  2544. "pricePerBoard": {
  2545. "type": "number",
  2546. "description" : "Amount wagered per board"
  2547. },
  2548. "systemNumber": {
  2549. "type": "integer",
  2550. "description" : "System number for combo wagers"
  2551. },
  2552. "numberStrikeBoards": {
  2553. "type": "integer",
  2554. "description" : "Number of boards wager is purchased for"
  2555. },
  2556. "numberPowerballBoards": {
  2557. "type": "integer",
  2558. "description" : "Number of boards wager is purchased for"
  2559. },
  2560. "drawTimes": {
  2561. "type": "array",
  2562. "items": [
  2563. {
  2564. "type": "string",
  2565. "description" : "Draw times set (Keno only) 10 - 10 AM Draw 13 - 1 PM Draw 15 - 3 PM Draw 18 - 6 PM draw"
  2566. }
  2567. ]
  2568. },
  2569. "lottoBoard": {
  2570. "type": "array",
  2571. "items": {
  2572. "type": "object",
  2573. "properties": {
  2574. "powerballNumber": {
  2575. "type": "integer",
  2576. "description" : "Powerball number for board if selected"
  2577. },
  2578. "numbers": {
  2579. "type": "array",
  2580. "items": {
  2581. "type": "integer",
  2582. "description" : "List of LottoNumberSelection objects which contains number selection for each board"
  2583. }
  2584. }
  2585. }
  2586. }
  2587. },
  2588. "kenoBoard": {
  2589. "type": "array",
  2590. "items": {
  2591. "type": "object",
  2592. "properties": {
  2593. "groupNumber": {
  2594. "type": "integer",
  2595. "description" : "Prize group played per board"
  2596. },
  2597. "numbers": {
  2598. "type": "array",
  2599. "items": {
  2600. "type": "integer",
  2601. "description" : "List of KenoNumberSelection objects which contains number selection for each board"
  2602. }
  2603. }
  2604. }
  2605. }
  2606. },
  2607. "strikeBoard": {
  2608. "type": "array",
  2609. "items": {
  2610. "type": "object",
  2611. "properties": {
  2612. "numbers": {
  2613. "type": "array",
  2614. "items": {
  2615. "type": "integer",
  2616. "description" : "Numbers selected"
  2617. }
  2618. }
  2619. }
  2620. }
  2621. },
  2622. "bullseyeBoard": {
  2623. "type": "array",
  2624. "items": {
  2625. "type": "object",
  2626. "properties": {
  2627. "numbers": {
  2628. "type": "array",
  2629. "items": {
  2630. "type": "integer",
  2631. "description" : "List of BullseyeNumberSelection objects which contains digit selection for each board, the digits compose of the Bullseye number (the digit at 0 position is the most significant and the last is the less significant); there should be always six numbers provided with leading zeros"
  2632. }
  2633. }
  2634. }
  2635. }
  2636. },
  2637. "play3Boards": {
  2638. "type": "array",
  2639. "items": {
  2640. "type": "object",
  2641. "properties": {
  2642. "numbers": {
  2643. "type": "array",
  2644. "items": {
  2645. "type": "integer",
  2646. "description" : "List of play3NumberSelection objects which contains digit selection for each board, the are 3 digits "
  2647. }
  2648. },
  2649. "play3PlayType": {
  2650. "type": "string",
  2651. "description" : "possible values are 'Exact', 'Any', 'Pairs', 'ExactAny', 'ExactPairs', 'ExactAnyPairs' ,'Combo'"
  2652. },
  2653. "play3BoardAmount": {
  2654. "type": "integer",
  2655. "description" : "price for purchased board. Just for validation purpose"
  2656. }
  2657. }
  2658. }
  2659. }
  2660. }
  2661. }
  2662. ]
  2663. }
  2664. }
  2665. }
  2666. -
  2667. editFavouriteInput: |
  2668. {
  2669. "$schema": "http://json-schema.org/draft-04/schema#",
  2670. "type": "object",
  2671. "properties": {
  2672. "favouriteId": {
  2673. "type": "string",
  2674. "description" : ""
  2675. },
  2676. "sequenceId": {
  2677. "type": "integer",
  2678. "description" : "Sequence ID of favourite play"
  2679. },
  2680. "gameName": {
  2681. "type": "string",
  2682. "description" : "Game name for which favourite play is configured"
  2683. },
  2684. "playSlipId": {
  2685. "type": "string",
  2686. "description" : ""
  2687. },
  2688. "numberOfBoards": {
  2689. "type": "integer",
  2690. "description" : "Number of boards wager is purchased for"
  2691. },
  2692. "numberOfDraws": {
  2693. "type": "integer",
  2694. "description" : "Number of draws wager is purchased for, starting from current draw"
  2695. },
  2696. "pricePerBoard": {
  2697. "type": "number",
  2698. "description" : "Amount wagered per board"
  2699. },
  2700. "systemNumber": {
  2701. "type": "integer",
  2702. "description" : "System number for combo wagers"
  2703. },
  2704. "numberStrikeBoards": {
  2705. "type": "integer",
  2706. "description" : "Number of boards wager is purchased for"
  2707. },
  2708. "drawTimes": {
  2709. "type": "array",
  2710. "items": [
  2711. {
  2712. "type": "string",
  2713. "description" : "Draw times set (Keno only) 10 - 10 AM Draw 13 - 1 PM Draw 15 - 3 PM Draw 18 - 6 PM draw"
  2714. }
  2715. ]
  2716. },
  2717. "lottoBoard": {
  2718. "type": "array",
  2719. "items": {
  2720. "type": "object",
  2721. "properties": {
  2722. "powerballNumber": {
  2723. "type": "integer",
  2724. "description" : "Powerball number for board if selected"
  2725. },
  2726. "numbers": {
  2727. "type": "array",
  2728. "items": {
  2729. "type": "integer",
  2730. "description" : "List of LottoNumberSelection objects which contains number selection for each board"
  2731. }
  2732. }
  2733. }
  2734. }
  2735. },
  2736. "kenoBoard": {
  2737. "type": "array",
  2738. "items": {
  2739. "type": "object",
  2740. "properties": {
  2741. "groupNumber": {
  2742. "type": "integer",
  2743. "description" : "Prize group played per board"
  2744. },
  2745. "numbers": {
  2746. "type": "array",
  2747. "items": {
  2748. "type": "integer",
  2749. "description" : "List of KenoNumberSelection objects which contains number selection for each board"
  2750. }
  2751. }
  2752. }
  2753. }
  2754. },
  2755. "strikeBoard": {
  2756. "type": "array",
  2757. "items": {
  2758. "type": "object",
  2759. "properties": {
  2760. "numbers": {
  2761. "type": "array",
  2762. "items": {
  2763. "type": "integer",
  2764. "description" : "Numbers selected"
  2765. }
  2766. }
  2767. }
  2768. }
  2769. },
  2770. "bullseyeBoard": {
  2771. "type": "array",
  2772. "items": {
  2773. "type": "object",
  2774. "properties": {
  2775. "numbers": {
  2776. "type": "array",
  2777. "items": {
  2778. "type": "integer",
  2779. "description" : "List of BullseyeNumberSelection objects which contains digit selection for each board, the digits compose of the Bullseye number (the digit at 0 position is the most significant and the last is the less significant); there should be always six numbers provided with leading zeros"
  2780. }
  2781. }
  2782. }
  2783. }
  2784. },
  2785. "play3Boards": {
  2786. "type": "array",
  2787. "items": {
  2788. "type": "object",
  2789. "properties": {
  2790. "numbers": {
  2791. "type": "array",
  2792. "items": {
  2793. "type": "integer",
  2794. "description" : "List of play3NumberSelection objects which contains digit selection for each board, the are 3 digits "
  2795. }
  2796. },
  2797. "play3PlayType": {
  2798. "type": "string",
  2799. "description" : "possible values are 'Exact', 'Any', 'Pairs', 'ExactAny', 'ExactPairs', 'ExactAnyPairs' ,'Combo'"
  2800. },
  2801. "play3BoardAmount": {
  2802. "type": "integer",
  2803. "description" : "price for purchased board. Just for validation purpose"
  2804. }
  2805. }
  2806. }
  2807. }
  2808. }
  2809. }
  2810. -
  2811. saveFavouriteInput: |
  2812. {
  2813. "$schema": "http://json-schema.org/draft-04/schema#",
  2814. "type": "object",
  2815. "properties": {
  2816. "favouriteId": {
  2817. "type": "string",
  2818. "description" : ""
  2819. },
  2820. "favouriteName": {
  2821. "type": "string",
  2822. "description" : "Name of favourite play"
  2823. },
  2824. "sequenceId": {
  2825. "type": "integer",
  2826. "description" : "Sequence ID of favourite play"
  2827. },
  2828. "gameName": {
  2829. "type": "string",
  2830. "description" : "Game name for which favourite play is configured"
  2831. },
  2832. "playSlipId": {
  2833. "type": "string",
  2834. "description" : ""
  2835. },
  2836. "numberOfBoards": {
  2837. "type": "integer",
  2838. "description" : "Number of boards wager is purchased for"
  2839. },
  2840. "numberOfDraws": {
  2841. "type": "integer",
  2842. "description" : "Number of draws wager is purchased for, starting from current draw"
  2843. },
  2844. "pricePerBoard": {
  2845. "type": "number",
  2846. "description" : "Amount wagered per board"
  2847. },
  2848. "systemNumber": {
  2849. "type": "integer",
  2850. "description" : "System number for combo wagers"
  2851. },
  2852. "numberStrikeBoards": {
  2853. "type": "integer",
  2854. "description" : "Number of boards wager is purchased for"
  2855. },
  2856. "drawTimes": {
  2857. "type": "array",
  2858. "items": [
  2859. {
  2860. "type": "string",
  2861. "description" : "Draw times set (Keno only) 10 - 10 AM Draw 13 - 1 PM Draw 15 - 3 PM Draw 18 - 6 PM draw"
  2862. }
  2863. ]
  2864. },
  2865. "lottoBoard": {
  2866. "type": "array",
  2867. "items": {
  2868. "type": "object",
  2869. "properties": {
  2870. "powerballNumber": {
  2871. "type": "integer",
  2872. "description" : "Powerball number for board if selected"
  2873. },
  2874. "numbers": {
  2875. "type": "array",
  2876. "items": {
  2877. "type": "integer",
  2878. "description" : "List of LottoNumberSelection objects which contains number selection for each board"
  2879. }
  2880. }
  2881. }
  2882. }
  2883. },
  2884. "kenoBoard": {
  2885. "type": "array",
  2886. "items": {
  2887. "type": "object",
  2888. "properties": {
  2889. "groupNumber": {
  2890. "type": "integer",
  2891. "description" : "Prize group played per board"
  2892. },
  2893. "numbers": {
  2894. "type": "array",
  2895. "items": {
  2896. "type": "integer",
  2897. "description" : "List of KenoNumberSelection objects which contains number selection for each board"
  2898. }
  2899. }
  2900. }
  2901. }
  2902. },
  2903. "strikeBoard": {
  2904. "type": "array",
  2905. "items": {
  2906. "type": "object",
  2907. "properties": {
  2908. "numbers": {
  2909. "type": "array",
  2910. "items": {
  2911. "type": "integer",
  2912. "description" : "Numbers selected"
  2913. }
  2914. }
  2915. }
  2916. }
  2917. },
  2918. "bullseyeBoard": {
  2919. "type": "array",
  2920. "items": {
  2921. "type": "object",
  2922. "properties": {
  2923. "numbers": {
  2924. "type": "array",
  2925. "items": {
  2926. "type": "integer",
  2927. "description" : "List of BullseyeNumberSelection objects which contains digit selection for each board, the digits compose of the Bullseye number (the digit at 0 position is the most significant and the last is the less significant); there should be always six numbers provided with leading zeros"
  2928. }
  2929. }
  2930. }
  2931. }
  2932. },
  2933. "play3Boards": {
  2934. "type": "array",
  2935. "items": {
  2936. "type": "object",
  2937. "properties": {
  2938. "numbers": {
  2939. "type": "array",
  2940. "items": {
  2941. "type": "integer",
  2942. "description" : "List of play3NumberSelection objects which contains digit selection for each board, the are 3 digits "
  2943. }
  2944. },
  2945. "play3PlayType": {
  2946. "type": "string",
  2947. "description" : "possible values are 'Exact', 'Any', 'Pairs', 'ExactAny', 'ExactPairs', 'ExactAnyPairs' ,'Combo'"
  2948. },
  2949. "play3BoardAmount": {
  2950. "type": "integer",
  2951. "description" : "price for purchased board. Just for validation purpose"
  2952. }
  2953. }
  2954. }
  2955. }
  2956. },
  2957. "required": [
  2958. "favouriteName"
  2959. ]
  2960. }
  2961. -
  2962. TlaAreaLocationOutput: |
  2963. {
  2964. "type": "object",
  2965. "properties": {
  2966. "tlaAreaLocationList": {
  2967. "type": "array",
  2968. "items": [
  2969. {
  2970. "type": "object",
  2971. "properties": {
  2972. "tlaAreaCode": {
  2973. "type": "string",
  2974. "description" : "TLA Area unique code"
  2975. },
  2976. "tlaAreaDescription": {
  2977. "type": "string",
  2978. "description" : "TLA Area Description"
  2979. },
  2980. "tlaLocationList": {
  2981. "type": "array",
  2982. "description" : "List of tlaLocation objects associated with the Area",
  2983. "items": [
  2984. {
  2985. "type": "object",
  2986. "properties": {
  2987. "tlaLocationCode": {
  2988. "type": "string",
  2989. "description" : "TLA Location unique code"
  2990. },
  2991. "tlaLocationDescription": {
  2992. "type": "string",
  2993. "description" : "TLA Location Description"
  2994. }
  2995. }
  2996. }
  2997. ]
  2998. }
  2999. }
  3000. }
  3001. ]
  3002. }
  3003. }
  3004. }
  3005. -
  3006. closeAccountInput: |
  3007. {
  3008. "$schema": "http://json-schema.org/draft-04/schema#",
  3009. "type": "object",
  3010. "properties": {
  3011. "password": {
  3012. "type": "string",
  3013. "description" : "Player's password as stored in ESi database."
  3014. },
  3015. "reasonText": {
  3016. "type": "string",
  3017. "description" : "The reason for closing the account"
  3018. }
  3019. },
  3020. "required": [
  3021. "password"
  3022. ]
  3023. }
  3024. -
  3025. fastValidateInput: |
  3026. {
  3027. "$schema": "http://json-schema.org/draft-04/schema#",
  3028. "type": "object",
  3029. "properties": {
  3030. "drawId": {
  3031. "type": "integer",
  3032. "description" : "Draw number"
  3033. }
  3034. },
  3035. "required": [
  3036. "drawId"
  3037. ]
  3038. }
  3039. -
  3040. fastValidateOutput: |
  3041. {
  3042. "$schema": "http://json-schema.org/draft-04/schema#",
  3043. "type": "object",
  3044. "properties": {
  3045. "ticketNumber": {
  3046. "type": "string",
  3047. "description" : "Unique ticket number maintained in ESi"
  3048. },
  3049. "walletSuspended": {
  3050. "type": "boolean",
  3051. "description" : "WalletSuspended attribute"
  3052. },
  3053. "bonusTickets": {
  3054. "type": "integer",
  3055. "description" : "Count of bonus tickets won if applicable"
  3056. },
  3057. "gameDescription": {
  3058. "type": "string",
  3059. "description" : "Game name and/or description"
  3060. },
  3061. "merchandiseDescription": {
  3062. "type": "string",
  3063. "description" : "Description of merchandise prize if applicable"
  3064. },
  3065. "prizeAmount": {
  3066. "type": "number",
  3067. "description" : "Winning amount for cash prizes"
  3068. },
  3069. "ticketType": {
  3070. "type": "string",
  3071. "description" : "Ticket type description"
  3072. },
  3073. "wagerDate": {
  3074. "type": "string",
  3075. "description" : "Date and time ticket was purchased"
  3076. },
  3077. "drawID": {
  3078. "type": "integer",
  3079. "description" : "Draw number"
  3080. },
  3081. "winOutcome": {
  3082. "type": "string",
  3083. "description" : "Winning amount for cash prizes"
  3084. }
  3085. }
  3086. }
  3087. -
  3088. validationInquiryInstantOutput: |
  3089. {
  3090. "$schema": "http://json-schema.org/draft-04/schema#",
  3091. "type": "object",
  3092. "properties": {
  3093. "amount": {
  3094. "type": "number",
  3095. "description" : "Win amount"
  3096. },
  3097. "resultText": {
  3098. "type": "string",
  3099. "description" : "Description of inquiry result."
  3100. },
  3101. "freeTicketsNumber": {
  3102. "type": "integer",
  3103. "description" : "Free tickets number as bonus prize"
  3104. },
  3105. "prizeLevel": {
  3106. "type": "integer",
  3107. "description" : ""
  3108. }
  3109.  
  3110. }
  3111. }
  3112. -
  3113. validationInquiryOnlineOutput: |
  3114. {
  3115. "$schema": "http://json-schema.org/draft-04/schema#",
  3116. "type": "object",
  3117. "properties": {
  3118. "cashAmount": {
  3119. "type": "number",
  3120. "description" : "Win amount"
  3121. },
  3122. "claimAmount": {
  3123. "type": "number",
  3124. "description" : "Claim amount"
  3125. },
  3126. "resultText": {
  3127. "type": "string",
  3128. "description" : "Description of inquiry result."
  3129. },
  3130. "freeTicketsNumber": {
  3131. "type": "integer",
  3132. "description" : "Free tickets number as bonus prize"
  3133. },
  3134. "refundAmount": {
  3135. "type": "number",
  3136. "description" : "Refund amount"
  3137. }
  3138. }
  3139. }
  3140. -
  3141. listClaimsOutput: |
  3142. {
  3143. "$schema": "http://json-schema.org/draft-04/schema#",
  3144. "type": "object",
  3145. "properties": {
  3146. "bankAccountNumber": {
  3147. "type": "string",
  3148. "description": "Player's bank account number."
  3149. },
  3150. "bankAccountConfirmed": {
  3151. "type": "boolean",
  3152. "description": "Status confirmation of player's bank account"
  3153. },
  3154. "walletSuspended": {
  3155. "type": "boolean",
  3156. "description": "WalletSuspended attribute"
  3157. },
  3158. "claimWinsInfo": {
  3159. "type": "array",
  3160. "items": {
  3161. "type": "object",
  3162. "properties": {
  3163. "bankAccountNumber": {
  3164. "type": "string",
  3165. "description": "Player's bank account number."
  3166. },
  3167. "bankAccountConfirmed": {
  3168. "type": "boolean",
  3169. "description": "Status confirmation of player's bank account"
  3170. },
  3171. "drawId": {
  3172. "type": "integer",
  3173. "description": "Draw number"
  3174. },
  3175. "ticketNumber": {
  3176. "type": "string",
  3177. "description": "Unique ticket number maintained in ESi"
  3178. },
  3179. "walletSuspended": {
  3180. "type": "boolean",
  3181. "description": "WalletSuspended attribute"
  3182. },
  3183. "bonusTickets": {
  3184. "type": "integer",
  3185. "description": "Count of bonus tickets won if applicable"
  3186. },
  3187. "drawDate": {
  3188. "type": "string",
  3189. "description": "Draw date"
  3190. },
  3191. "gameDescription": {
  3192. "type": "string",
  3193. "description": "Game name and or description"
  3194. },
  3195. "merchandiseDescription": {
  3196. "type": "string",
  3197. "description": "Description of merchandise prize if applicable"
  3198. },
  3199. "prizeAmount": {
  3200. "type": "number",
  3201. "description": "Winning amount for cash prizes"
  3202. },
  3203. "ticketType": {
  3204. "type": "string",
  3205. "description": "Ticket type description"
  3206. },
  3207. "wagerDate": {
  3208. "type": "string",
  3209. "description": "Date and time ticket was purchased"
  3210. }
  3211. }
  3212. }
  3213. }
  3214. }
  3215. }
  3216. -
  3217. payPrizeInput: |
  3218. {
  3219. "$schema": "http://json-schema.org/draft-04/schema#",
  3220. "type": "object",
  3221. "properties": {
  3222. "password": {
  3223. "type": "string",
  3224. "description" : "Player's password as stored in ESi database."
  3225. },
  3226. "addressLine1": {
  3227. "type": "string",
  3228. "description" : "Player's address line 1"
  3229. },
  3230. "addressLine2": {
  3231. "type": "string",
  3232. "description" : "Player's address line 2"
  3233. },
  3234. "city": {
  3235. "type": "string",
  3236. "description" : "Player's town or city"
  3237. },
  3238. "phonenumber": {
  3239. "type": "string",
  3240. "description" : "Player's phone number"
  3241. },
  3242. "drawId": {
  3243. "type": "integer",
  3244. "description" : "Draw number"
  3245. },
  3246. "poBox": {
  3247. "type": "integer",
  3248. "description" : "Player's POBox"
  3249. },
  3250. "postalCode": {
  3251. "type": "integer",
  3252. "description" : "Player's postal code"
  3253. }
  3254. },
  3255. "required": [
  3256. "password"
  3257. ]
  3258. }
  3259. -
  3260. loadGlobalOutput: |
  3261. {
  3262. "$schema": "http://json-schema.org/draft-04/schema#",
  3263. "type": "object",
  3264. "properties": {
  3265. "kenoPricePerBoard": {
  3266. "type": "number",
  3267. "description": "Cost of Keno price per board or line"
  3268. },
  3269. "lottoPowerballPricePerBoard": {
  3270. "type": "number",
  3271. "description": "Cost of Lotto Powerball price per board or line"
  3272. },
  3273. "lottoPricePerBoard": {
  3274. "type": "number",
  3275. "description": "Cost of Lotto price per board or line"
  3276. },
  3277. "strikePricePerBoard": {
  3278. "type": "number",
  3279. "description": "Cost of Lotto Strike price per board or line"
  3280. },
  3281. "systemMonthlyLimit": {
  3282. "type": "string",
  3283. "description": "System Monthly Limit"
  3284. },
  3285. "systemWeeklyLimit": {
  3286. "type": "string",
  3287. "description": "System Weekly Limit"
  3288. },
  3289. "tcCurrentVersion": {
  3290. "type": "number",
  3291. "description": "Terms and Conditions most current version"
  3292. },
  3293. "viewGamingHistoryDefaultNumberDays": {
  3294. "type": "number",
  3295. "description": "Time period for viewing historical game play history"
  3296. },
  3297. "viewTransHistoryDefaultNumberDays": {
  3298. "type": "number",
  3299. "description": "Time period for viewing historical financial transaction history"
  3300. },
  3301. "walletMaxTransfer": {
  3302. "type": "number",
  3303. "description": "Maximum amount allowed to be transferred to wallet"
  3304. },
  3305. "walletMinTransfer": {
  3306. "type": "number",
  3307. "description": "Minimum amount allowed to be transferred to wallet"
  3308. },
  3309. "maxWalletWeeklyTransferAmountTo": {
  3310. "type": "number",
  3311. "description": "Maximum amount of transfers per week to wallet"
  3312. },
  3313. "maxWalletWeeklyTransfersTo": {
  3314. "type": "number",
  3315. "description": "Maximum number of transfers per week to wallet"
  3316. },
  3317. "maxWalletWeeklyTransfersFrom": {
  3318. "type": "number"
  3319. },
  3320. "maxWalletWeeklyTransferAmountFrom": {
  3321. "type": "number",
  3322. "description": "Maximum number of transfers per week from wallet"
  3323. },
  3324. "lottoGameActive": {
  3325. "type": "boolean",
  3326. "description": "true if Lotto Game is Active, otherwise returns false"
  3327. },
  3328. "kenoGameActive": {
  3329. "type": "boolean",
  3330. "description": "true if Ken o Game is active, otherwise returns false"
  3331. },
  3332. "bullseyePricePerBoardFor1Draw": {
  3333. "type": "number",
  3334. "description": "Cost of Bullseye per board for a single draw ticket"
  3335. },
  3336. "bullseyePricePerBoardFor7Draws": {
  3337. "type": "number",
  3338. "description": "Cost of Bullseye per board for a 7 draw ticket"
  3339. },
  3340. "bullseyePricePerBoardFor14Draws": {
  3341. "type": "number",
  3342. "description": "Cost of Bullseye per board for a 14 draw ticket"
  3343. },
  3344. "bullseyeGameActive": {
  3345. "type": "boolean",
  3346. "description": "true if Bullseye game is active, otherwise returns false"
  3347. },
  3348. "play3PricePerBoard": {
  3349. "type": "array",
  3350. "description": "key value list of name and Cost of Play3 price per board or line in cents",
  3351. "items": [
  3352. {
  3353. "type": "object",
  3354. "properties": {
  3355. "key": {
  3356. "type": "string",
  3357. "description": "Name of board"
  3358. },
  3359. "value": {
  3360. "type": "number",
  3361. "description": "Price of board"
  3362. }
  3363. }
  3364. }
  3365. ]
  3366. },
  3367. "play3GameActive": {
  3368. "type": "boolean"
  3369. }
  3370. }
  3371. }
  3372. -
  3373. viewSpendingLimitsOutput: |
  3374. {
  3375. "$schema": "http://json-schema.org/draft-04/schema#",
  3376. "type": "object",
  3377. "properties": {
  3378. "playerStatus": {
  3379. "type": "number",
  3380. "description" : ""
  3381. },
  3382. "weeklySpendingLimit": {
  3383. "type": "number",
  3384. "description" : "The cumulative amount a player can spend in a week"
  3385. },
  3386. "monthlySpendingLimit": {
  3387. "type": "number",
  3388. "description" : "The cumulative amount a player can spend in a month"
  3389. },
  3390. "spentToDateWeek": {
  3391. "type": "number",
  3392. "description" : "The amount a player spent for the remaining week"
  3393. },
  3394. "spentToDateMonth": {
  3395. "type": "number",
  3396. "description" : "The amount a player spent for the remaining month"
  3397. }
  3398. }
  3399. }
  3400. -
  3401. editSpendingLimitsInput: |
  3402. {
  3403. "$schema": "http://json-schema.org/draft-04/schema#",
  3404. "type": "object",
  3405. "properties": {
  3406. "password": {
  3407. "type": "string",
  3408. "description" : "Password entered by player as part of login credentials"
  3409. },
  3410. "userId": {
  3411. "type": "string",
  3412. "description" : "Player's account number as created and stored in ESi database"
  3413. },
  3414. "weeklyActualLimit": {
  3415. "type": "number",
  3416. "description" : "The cumulative amount a player can spend in a week"
  3417. },
  3418. "monthlyActualLimit": {
  3419. "type": "number",
  3420. "description" : "The cumulative amount a player can spend in a month"
  3421. },
  3422. "acctNumber": {
  3423. "type": "string",
  3424. "description" : "Bank account number"
  3425. }
  3426. },
  3427. "required": [
  3428. "password",
  3429. "weeklyActualLimit",
  3430. "monthlyActualLimit"
  3431. ]
  3432. }
  3433. -
  3434. spendingLimitsInput: |
  3435. {
  3436. "$schema": "http://json-schema.org/draft-04/schema#",
  3437. "type": "object",
  3438. "properties": {
  3439. "weeklyActualLimit": {
  3440. "type": "number",
  3441. "description" : "The cumulative amount a player can spend in a week"
  3442. },
  3443. "monthlyActualLimit": {
  3444. "type": "number",
  3445. "description" : "The cumulative amount a player can spend in a month"
  3446. },
  3447. "acctNumber": {
  3448. "type": "string",
  3449. "description" : "Bank account number"
  3450. }
  3451. },
  3452. "required": [
  3453. "weeklyActualLimit",
  3454. "monthlyActualLimit",
  3455. "acctNumber"
  3456. ]
  3457. }
  3458. -
  3459. spendingLimitsOutput: |
  3460. {
  3461. "$schema": "http://json-schema.org/draft-04/schema#",
  3462. "type": "object",
  3463. "properties": {
  3464. "playerStatus" : {
  3465. "type" : "object",
  3466. "properties" : {
  3467. "playerCode" : {
  3468. "type" : "number",
  3469. "description" : "Status code which reflects “Non-Confirmed”, “Verified ID” or “Confirmed” to indicate player’s status"
  3470. },
  3471. "playerDescription" : {
  3472. "type" : "string",
  3473. "description" : "Text description of the playerCode, e.g. Full MyLotto User"
  3474. }
  3475. }
  3476. },
  3477. "weeklySpendingLimit": {
  3478. "type": "number",
  3479. "description" : "The cumulative amount a player can spend in a week"
  3480. },
  3481. "monthlySpendingLimit": {
  3482. "type": "number",
  3483. "description" : "The cumulative amount a player can spend in a month"
  3484. },
  3485. "spentToDateWeek": {
  3486. "type": "number",
  3487. "description" : "The amount a player spent for the remaining week"
  3488. },
  3489. "spentToDateMonth": {
  3490. "type": "number",
  3491. "description" : "The amount a player spent for the remaining month"
  3492. }
  3493. }
  3494. }
  3495. -
  3496. resetPasswordInput: |
  3497. {
  3498. "$schema": "http://json-schema.org/draft-04/schema#",
  3499. "type" : "object",
  3500. "properties" : {
  3501. "dateOfBirth" : {
  3502. "type" : "string",
  3503. "description" : "Date Of Birth of the player",
  3504. "pattern": "^[F0-9]{4}-[F0-9]{2}-[F0-9]{2}$"
  3505. },
  3506. "type" : {
  3507. "type" : "number",
  3508. "description" : "ID corresponding random hint question"
  3509. },
  3510. "answer" : {
  3511. "type" : "string",
  3512. "description" : "Player's answer to the hint question"
  3513. }
  3514. },
  3515. "required": [ "dateOfBirth", "type", "answer" ]
  3516. }
  3517. -
  3518. resetPasswordOutput: |
  3519. {
  3520. "$schema": "http://json-schema.org/draft-04/schema#",
  3521. "type" : "object",
  3522. "properties" : {
  3523. "emailAddress" : {
  3524. "type" : "string",
  3525. "description" : "Player's email address as stored in ESi database"
  3526. }
  3527. }
  3528. }
  3529. -
  3530. updatePasswordInput: |
  3531. {
  3532. "$schema": "http://json-schema.org/draft-04/schema#",
  3533. "type" : "object",
  3534. "properties" : {
  3535. "newPassword" : {
  3536. "type" : "string",
  3537. "description" : "Newly entered password"
  3538. },
  3539. "verifyNewPassword" : {
  3540. "type" : "string",
  3541. "description" : "Verify password"
  3542. }
  3543. },
  3544. "required": [ "newPassword", "verifyNewPassword" ]
  3545. }
  3546. -
  3547. updatePasswordOutput: |
  3548. {
  3549. "$schema": "http://json-schema.org/draft-04/schema#",
  3550. "type" : "object",
  3551. "properties" : {
  3552. "passwordUpdated" : {
  3553. "type" : "boolean",
  3554. "description" : "Flag to check whether new password has been updated or not"
  3555. }
  3556. }
  3557. }
  3558. -
  3559. termsAndConditionsInput: |
  3560. {
  3561. "$schema": "http://json-schema.org/draft-04/schema#",
  3562. "type" : "object",
  3563. "properties" : {
  3564. "userName" : {
  3565. "type" : "string",
  3566. "description" : "Player's email address to be used as username"
  3567. },
  3568. "pageId" : {
  3569. "type" : "string",
  3570. "description" : "Page or screen id corresponding to screen on web portal where player clicks a button to initiate on-line application, if set to NULL the command only updates terms and condition version"
  3571. },
  3572. "applicationNumber" : {
  3573. "type" : "string",
  3574. "description" : "Player's application id upon successful generation of application number, if set to NULL the command only updates terms and condition version"
  3575. },
  3576. "userAgreed" : {
  3577. "type" : "boolean",
  3578. "description" : "Indication that player has agreed and accepted terms and conditions. 'true' or 'false'"
  3579. }
  3580. },
  3581. "required": [ "userName", "userAgreed" ]
  3582. }
  3583. -
  3584. termsAndConditionsOutput: |
  3585. {
  3586. "$schema": "http://json-schema.org/draft-04/schema#",
  3587. "type" : "object",
  3588. "properties" : {
  3589. "userId" : {
  3590. "type" : "string",
  3591. "description" : "Player's account number as stored in ESi database; NULL indicates and thus terms and conditions version was not updated (alternatively palyer not registered)userAgreed flag was set to FALSE"
  3592. },
  3593. "playerStatus" : {
  3594. "type" : "number",
  3595. "description" : "Status code which reflects 'Non-Confirmed', 'Verified ID' or 'Confirmed' to indicate player's status; NULL indicates userAgreed flag was set to FALSE and thus terms and conditions version was not updated (alternatively palyer not registered)"
  3596. }
  3597. }
  3598. }
  3599. -
  3600. versionOutput: |
  3601. {
  3602. "$schema": "http://json-schema.org/draft-04/schema#",
  3603. "type" : "object",
  3604. "properties" : {
  3605. "version" : {
  3606. "type" : "string",
  3607. "description" : "Version number of the ESi WebService"
  3608. }
  3609. }
  3610. }
  3611. -
  3612. transHistOutput: |
  3613. {
  3614. "$schema": "http://json-schema.org/draft-04/schema#",
  3615. "type": "object",
  3616. "properties": {
  3617. "transHistory": {
  3618. "type": "array",
  3619. "items": [
  3620. {
  3621. "type": "object",
  3622. "properties": {
  3623. "gameName": {
  3624. "type": "string",
  3625. "description": "Game name"
  3626. },
  3627. "ticketNumber": {
  3628. "type": "string",
  3629. "description": "ESI ticket number"
  3630. },
  3631. "ticketType": {
  3632. "type": "string",
  3633. "description": "Ticket type description"
  3634. },
  3635. "transactionType": {
  3636. "type": "string",
  3637. "description": "Type of transaction (All or Deposits or Purchase or Wins or Withdrawal)"
  3638. },
  3639. "amount": {
  3640. "type": "number",
  3641. "description": "Amount transferred"
  3642. },
  3643. "externalTransactionReference": {
  3644. "type": "number",
  3645. "description": "Unique transaction number maintained in DPS "
  3646. },
  3647. "transactionDate": {
  3648. "type": "string",
  3649. "description": "Date of transaction"
  3650. },
  3651. "transactionReference": {
  3652. "type": "number",
  3653. "description": "Unique transaction number maintained in ESi "
  3654. },
  3655. "transferAccountNumber": {
  3656. "type": "string",
  3657. "description": "Bank account number for transfers from wallet. Truncated credit card number (from DPS) for transfers to wallet by credit card"
  3658. },
  3659. "walletBalance": {
  3660. "type": "number",
  3661. "description": "Updated wallet balance"
  3662. },
  3663. "description": {
  3664. "type": "string",
  3665. "description": "Detailed description of financial transaction"
  3666. }
  3667. }
  3668. }
  3669. ]
  3670. }
  3671. }
  3672. }
  3673. -
  3674. notificationsOutput: |
  3675. {
  3676. "$schema": "http://json-schema.org/draft-04/schema#",
  3677. "type": "object",
  3678. "properties": {
  3679. "notifications": {
  3680. "type": "array",
  3681. "items": [
  3682. {
  3683. "type": "object",
  3684. "properties": {
  3685. "header": {
  3686. "type": "string",
  3687. "description": "Header content"
  3688. },
  3689. "messageId": {
  3690. "type": "number",
  3691. "description": "Notification identifier"
  3692. },
  3693. "messageType": {
  3694. "type": "number",
  3695. "description": "Notification type"
  3696. },
  3697. "messageDate": {
  3698. "type": "string",
  3699. "description": "Date notification was created"
  3700. },
  3701. "subject": {
  3702. "type": "string",
  3703. "description": "Subject content "
  3704. },
  3705. "greeting": {
  3706. "type": "string",
  3707. "description": "Greeting content "
  3708. },
  3709. "body": {
  3710. "type": "string",
  3711. "description": "Body content "
  3712. },
  3713. "signature": {
  3714. "type": "string",
  3715. "description": "Signature "
  3716. },
  3717. "notificationClass": {
  3718. "type": "string",
  3719. "description": "ENotification class – standard, winning, claim"
  3720. },
  3721. "linkId": {
  3722. "type": "number",
  3723. "description": "Link ID used by the front end to identify a link "
  3724. }
  3725. }
  3726. }
  3727. ]
  3728. }
  3729. }
  3730. }
  3731. -
  3732. validateHintQuestion: |
  3733. {
  3734. "$schema": "http://json-schema.org/draft-04/schema#",
  3735. "type": "object",
  3736. "properties": {
  3737. "type": {
  3738. "type": "integer",
  3739. "description": "ID corresponding random hint question"
  3740. },
  3741. "answer": {
  3742. "type": "string",
  3743. "description": "Player's answer to the hint question"
  3744. }
  3745. },
  3746. "required": [
  3747. "type",
  3748. "answer"
  3749. ]
  3750. }
  3751. traits:
  3752. -
  3753. error-responses:
  3754. displayName: error-responses
  3755. -
  3756. header-params:
  3757. displayName: header-params
  3758. -
  3759. header-username-param:
  3760. displayName: header-username-param
  3761. -
  3762. header-userid-sessionid-params:
  3763. displayName: header-userid-sessionid-params
  3764. /accounts:
  3765. displayName: accounts
  3766. description: An account is a logged in user profile in the Gaming System.
  3767. post:
  3768. description: Sign up of new user
  3769. body:
  3770. application/json:
  3771. schema: securityTnCRegistrationInput
  3772. example: |
  3773. {
  3774. "password": "notpassword99",
  3775. "firstName": "mule",
  3776. "lastName": "transform",
  3777. "gender": "F",
  3778. "dateOfBirth": "1981-04-23",
  3779. "tlaArea": "Auckland",
  3780. "tlaLocation": "Auckland City",
  3781. "phone": "44 7900550078",
  3782. "emailAddress": "mule2@test.com",
  3783. "optInLottoResults": false,
  3784. "securityQuestionId": 1,
  3785. "securityAnswer": "I don not know",
  3786. "userAgreed": true,
  3787. "geofilterInfo":
  3788. {
  3789. "language": "en-GB,en-US;q=0.8,en;q=0.6",
  3790. "encoding": "gzip,deflate,sdch",
  3791. "charset": "ISO-8859-1,utf-8;q=0.7,*;q=0.3",
  3792. "clientIP": "202.160.48.160",
  3793. "browser": "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36"
  3794. },
  3795. "optInLottoJackpotThreshold": 0,
  3796. "optInLottoJackpot": false,
  3797. "optInMarketing": false,
  3798. "optInInstantKiwi": false
  3799. }
  3800. responses:
  3801. "200":
  3802. body:
  3803. application/json:
  3804. schema: securityTnCRegistrationOutput
  3805. example: |
  3806. {
  3807. "playerStatus": {
  3808. "playerCode": 2,
  3809. "playerDescription": "Full MyLotto User"
  3810. },
  3811. "userId": "100980037"
  3812. }
  3813. "400":
  3814. body:
  3815. application/json:
  3816. schema: simpleResponse
  3817. example: |
  3818. {
  3819. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  3820. }
  3821. "500":
  3822. body:
  3823. application/json:
  3824. schema: simpleResponse
  3825. example: |
  3826. {
  3827. "message": "Runtime Exception - Contact Administrator"
  3828. }
  3829. is: [error-responses]
  3830. /{userid}:
  3831. uriParameters:
  3832. userid:
  3833. displayName: userid
  3834. type: string
  3835. required: true
  3836. repeat: false
  3837. get:
  3838. description: loadPlayerProfile for the given userid and sessionid
  3839. headers:
  3840. ESI_SID:
  3841. description: The ESi Session Id
  3842. type: string
  3843. required: true
  3844. repeat: false
  3845. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  3846. USER_ID:
  3847. description: Esi User Id
  3848. type: string
  3849. required: true
  3850. repeat: false
  3851. example: "100980037"
  3852. queryParameters:
  3853. engageFields:
  3854. description: Fetch user data from Engage DB along with ESi
  3855. type: boolean
  3856. required: false
  3857. repeat: false
  3858. default: "false"
  3859. example: "false"
  3860. responses:
  3861. "200":
  3862. body:
  3863. application/json:
  3864. schema: loadPlayerProfileOutput
  3865. example: |
  3866. {
  3867. "firstName": "Graham",
  3868. "lastName": "McDermid",
  3869. "dateOfBirth": "1980-04-01+12:00",
  3870. "gender": "M",
  3871. "tlaArea": "Auckland",
  3872. "tlaLocation": "Auckland City",
  3873. "phone": "447900550079",
  3874. "emailAddress": "userid004@testme.co.nz",
  3875. "optInEmailResultsNotify": true,
  3876. "optInLottoResults": true,
  3877. "bankAccountNumber": "1200000000000000",
  3878. "bankAccountConfirmed": true,
  3879. "helpFlagEnabled": true,
  3880. "newPasswordRequired": false,
  3881. "accountStatus": 0,
  3882. "loginStatus": 0,
  3883. "playerStatus": 5,
  3884. "walletStatus": false,
  3885. "cashBalance": 61.6,
  3886. "tokenBalance": 0,
  3887. "weeklySpendingLimit": 999,
  3888. "monthlySpendingLimit": 999,
  3889. "weeklyXferAmt": 0,
  3890. "loginTime": "2015-12-02T10:58:43.077+13:00",
  3891. "claimTypeNotificationsCount": 0,
  3892. "totalNotifications": 23,
  3893. "weeklyTransferCount": 0,
  3894. "winningTypeNotificationsCount": 15,
  3895. "ageConfirmStatus": 1,
  3896. "acctNumber": "1007850118",
  3897. "sessionActive": false,
  3898. "tcVersion": "8.00",
  3899. "playerGreeting": "Graham",
  3900. "spentToDateWeek": 984.6,
  3901. "spentToDateMonth": 984.6,
  3902. "optInInstantKiwi": false,
  3903. "optInLottoJackpot": false,
  3904. "optInLottoJackpotThreshold": 0,
  3905. "optInMarketing": false
  3906. }
  3907. "400":
  3908. body:
  3909. application/json:
  3910. schema: simpleResponse
  3911. example: |
  3912. {
  3913. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  3914. }
  3915. "500":
  3916. body:
  3917. application/json:
  3918. schema: simpleResponse
  3919. example: |
  3920. {
  3921. "message": "Runtime Exception - Contact Administrator"
  3922. }
  3923. is: [error-responses, header-userid-sessionid-params]
  3924. put:
  3925. description: Update player profile for a given userid, password and sessionid
  3926. headers:
  3927. ESI_SID:
  3928. description: The ESi Session Id
  3929. type: string
  3930. required: true
  3931. repeat: false
  3932. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  3933. USER_ID:
  3934. description: Esi User Id
  3935. type: string
  3936. required: true
  3937. repeat: false
  3938. example: "100980037"
  3939. body:
  3940. application/json:
  3941. schema: updatePlayerProfileInput
  3942. example: |
  3943. {
  3944. "password": "test123",
  3945. "tlaArea": "Auckland",
  3946. "tlaLocation": "Auckland City",
  3947. "phone": "44 7900550078",
  3948. "dateOfBirth": "2016-01-28"
  3949. }
  3950. responses:
  3951. "200":
  3952. body:
  3953. application/json:
  3954. schema: simpleResponse
  3955. example: |
  3956. {
  3957. "message": "success"
  3958. }
  3959. "400":
  3960. body:
  3961. application/json:
  3962. schema: simpleResponse
  3963. example: |
  3964. {
  3965. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  3966. }
  3967. "500":
  3968. body:
  3969. application/json:
  3970. schema: simpleResponse
  3971. example: |
  3972. {
  3973. "message": "Runtime Exception - Contact Administrator"
  3974. }
  3975. is: [error-responses, header-userid-sessionid-params]
  3976. /terminations:
  3977. post:
  3978. description: Delete a account (closing the account)
  3979. headers:
  3980. ESI_SID:
  3981. description: The ESi Session Id
  3982. type: string
  3983. required: true
  3984. repeat: false
  3985. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  3986. USER_ID:
  3987. description: Esi User Id
  3988. type: string
  3989. required: true
  3990. repeat: false
  3991. example: "100980037"
  3992. body:
  3993. application/json:
  3994. schema: closeAccountInput
  3995. example: |
  3996. {
  3997. "password": "test123"
  3998. }
  3999. responses:
  4000. "200":
  4001. body:
  4002. application/json:
  4003. schema: simpleResponse
  4004. example: |
  4005. {
  4006. "message": "success"
  4007. }
  4008. "400":
  4009. body:
  4010. application/json:
  4011. schema: simpleResponse
  4012. example: |
  4013. {
  4014. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4015. }
  4016. "500":
  4017. body:
  4018. application/json:
  4019. schema: simpleResponse
  4020. example: |
  4021. {
  4022. "message": "Runtime Exception - Contact Administrator"
  4023. }
  4024. is: [error-responses, header-userid-sessionid-params]
  4025. /passwords:
  4026. put:
  4027. description: Update player profile for a given userid, password and sessionid
  4028. headers:
  4029. ESI_SID:
  4030. description: The ESi Session Id
  4031. type: string
  4032. required: true
  4033. repeat: false
  4034. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4035. USER_ID:
  4036. description: Esi User Id
  4037. type: string
  4038. required: true
  4039. repeat: false
  4040. example: "100980037"
  4041. body:
  4042. application/json:
  4043. schema: changePasswordInput
  4044. example: |
  4045. {
  4046. "currentPassword" : "test123",
  4047. "newPassword" : "testXYZ123"
  4048. }
  4049. responses:
  4050. "200":
  4051. body:
  4052. application/json:
  4053. schema: simpleResponse
  4054. example: |
  4055. {
  4056. "message": "success"
  4057. }
  4058. "400":
  4059. body:
  4060. application/json:
  4061. schema: simpleResponse
  4062. example: |
  4063. {
  4064. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4065. }
  4066. "500":
  4067. body:
  4068. application/json:
  4069. schema: simpleResponse
  4070. example: |
  4071. {
  4072. "message": "Runtime Exception - Contact Administrator"
  4073. }
  4074. is: [error-responses, header-userid-sessionid-params]
  4075. /spendinglimits:
  4076. get:
  4077. description: Retrieve and return the spending limits for the logged in player
  4078. headers:
  4079. ESI_SID:
  4080. description: The ESi Session Id
  4081. type: string
  4082. required: true
  4083. repeat: false
  4084. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4085. USER_ID:
  4086. description: Esi User Id
  4087. type: string
  4088. required: true
  4089. repeat: false
  4090. example: "100980037"
  4091. responses:
  4092. "200":
  4093. body:
  4094. application/json:
  4095. schema: viewSpendingLimitsOutput
  4096. example: |
  4097. {
  4098. "playerStatus": 0,
  4099. "weeklySpendingLimit": 999.0,
  4100. "monthlySpendingLimit": 999.0,
  4101. "spentToDateWeek": 996.2,
  4102. "spentToDateMonth": 996.2
  4103. }
  4104. "400":
  4105. body:
  4106. application/json:
  4107. schema: simpleResponse
  4108. example: |
  4109. {
  4110. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4111. }
  4112. "500":
  4113. body:
  4114. application/json:
  4115. schema: simpleResponse
  4116. example: |
  4117. {
  4118. "message": "Runtime Exception - Contact Administrator"
  4119. }
  4120. is: [error-responses, header-userid-sessionid-params]
  4121. put:
  4122. description: Send and persist in ESi the spending limits for the logged in player.
  4123. headers:
  4124. ESI_SID:
  4125. description: The ESi Session Id
  4126. type: string
  4127. required: true
  4128. repeat: false
  4129. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4130. USER_ID:
  4131. description: Esi User Id
  4132. type: string
  4133. required: true
  4134. repeat: false
  4135. example: "100980037"
  4136. body:
  4137. application/json:
  4138. schema: editSpendingLimitsInput
  4139. example: |
  4140. {
  4141. "password": "notpassword99",
  4142. "weeklyActualLimit": 150,
  4143. "monthlyActualLimit": 300
  4144. }
  4145. responses:
  4146. "200":
  4147. body:
  4148. application/json:
  4149. schema: simpleResponse
  4150. example: |
  4151. {
  4152. "message": "success"
  4153. }
  4154. "400":
  4155. body:
  4156. application/json:
  4157. schema: simpleResponse
  4158. example: |
  4159. {
  4160. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4161. }
  4162. "500":
  4163. body:
  4164. application/json:
  4165. schema: simpleResponse
  4166. example: |
  4167. {
  4168. "message": "Runtime Exception - Contact Administrator"
  4169. }
  4170. is: [error-responses, header-userid-sessionid-params]
  4171. post:
  4172. description: API to create ESi spending limits and bank account number entered by player as part of the registration process.
  4173. headers:
  4174. ESI_SID:
  4175. description: The ESi Session Id
  4176. type: string
  4177. required: true
  4178. repeat: false
  4179. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4180. USER_ID:
  4181. description: Esi User Id
  4182. type: string
  4183. required: true
  4184. repeat: false
  4185. example: "100980037"
  4186. body:
  4187. application/json:
  4188. schema: spendingLimitsInput
  4189. example: |
  4190. {
  4191. "weeklyActualLimit": 150,
  4192. "monthlyActualLimit": 300,
  4193. "acctNumber": "1539664689709000"
  4194. }
  4195. responses:
  4196. "200":
  4197. body:
  4198. application/json:
  4199. schema: spendingLimitsOutput
  4200. example: |
  4201. {
  4202. "playerStatus": 5
  4203. }
  4204. "400":
  4205. body:
  4206. application/json:
  4207. schema: simpleResponse
  4208. example: |
  4209. {
  4210. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4211. }
  4212. "500":
  4213. body:
  4214. application/json:
  4215. schema: simpleResponse
  4216. example: |
  4217. {
  4218. "message": "Runtime Exception - Contact Administrator"
  4219. }
  4220. is: [error-responses, header-userid-sessionid-params]
  4221. /lockedgames:
  4222. get:
  4223. description: Return a list of game categories and an indication whether the logged in player is excluded from that game family.
  4224. headers:
  4225. ESI_SID:
  4226. description: The ESi Session Id
  4227. type: string
  4228. required: true
  4229. repeat: false
  4230. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4231. USER_ID:
  4232. description: Esi User Id
  4233. type: string
  4234. required: true
  4235. repeat: false
  4236. example: "100980037"
  4237. responses:
  4238. "200":
  4239. body:
  4240. application/json:
  4241. schema: getLockedGamesOutput
  4242. example: |
  4243. [
  4244. {
  4245. "game": "Lotto",
  4246. "locked": false
  4247. },
  4248. {
  4249. "game": "Keno",
  4250. "locked": true,
  4251. "reactivationDate": "2015-12-19+13:00"
  4252. },
  4253. {
  4254. "game": "Bullseye",
  4255. "locked": false
  4256. },
  4257. {
  4258. "game": "Play3",
  4259. "locked": true,
  4260. "reactivationDate": "2015-12-19+13:00"
  4261. }
  4262. ]
  4263. "400":
  4264. body:
  4265. application/json:
  4266. schema: simpleResponse
  4267. example: |
  4268. {
  4269. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4270. }
  4271. "500":
  4272. body:
  4273. application/json:
  4274. schema: simpleResponse
  4275. example: |
  4276. {
  4277. "message": "Runtime Exception - Contact Administrator"
  4278. }
  4279. is: [error-responses, header-userid-sessionid-params]
  4280. put:
  4281. description: Sets a game category to be excluded from the logged in player’s profile. This prevents the player from playing the game.
  4282. headers:
  4283. ESI_SID:
  4284. description: The ESi Session Id
  4285. type: string
  4286. required: true
  4287. repeat: false
  4288. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4289. USER_ID:
  4290. description: Esi User Id
  4291. type: string
  4292. required: true
  4293. repeat: false
  4294. example: "100980037"
  4295. body:
  4296. application/json:
  4297. schema: editLockedGamesInput
  4298. example: |
  4299. {
  4300. "password": "test123",
  4301. "games": [
  4302. {
  4303. "game": "Lotto",
  4304. "locked": false
  4305. },
  4306. {
  4307. "game": "Keno",
  4308. "locked": true,
  4309. "reactivationDate": "2016-02-19"
  4310. },
  4311. {
  4312. "game": "Bullseye",
  4313. "locked": false
  4314. },
  4315. {
  4316. "game": "Play3",
  4317. "locked": true,
  4318. "reactivationDate": "2016-02-19"
  4319. }
  4320. ]
  4321. }
  4322. responses:
  4323. "200":
  4324. body:
  4325. application/json:
  4326. schema: simpleResponse
  4327. example: |
  4328. {
  4329. "message": "success"
  4330. }
  4331. "400":
  4332. body:
  4333. application/json:
  4334. schema: simpleResponse
  4335. example: |
  4336. {
  4337. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4338. }
  4339. "500":
  4340. body:
  4341. application/json:
  4342. schema: simpleResponse
  4343. example: |
  4344. {
  4345. "message": "Runtime Exception - Contact Administrator"
  4346. }
  4347. is: [error-responses, header-userid-sessionid-params]
  4348. /activations:
  4349. post:
  4350. description: Creates a new activation and emails it to the given user
  4351. responses:
  4352. "200":
  4353. body:
  4354. application/json:
  4355. schema: simpleResponse
  4356. example: |
  4357. {
  4358. "message": "success"
  4359. }
  4360. "400":
  4361. body:
  4362. application/json:
  4363. schema: simpleResponse
  4364. example: |
  4365. {
  4366. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4367. }
  4368. "500":
  4369. body:
  4370. application/json:
  4371. schema: simpleResponse
  4372. example: |
  4373. {
  4374. "message": "Runtime Exception - Contact Administrator"
  4375. }
  4376. is: [error-responses]
  4377. /claims:
  4378. get:
  4379. description: Get all claims for a specific user
  4380. headers:
  4381. ESI_SID:
  4382. description: The ESi Session Id
  4383. type: string
  4384. required: true
  4385. repeat: false
  4386. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4387. USER_ID:
  4388. description: Esi User Id
  4389. type: string
  4390. required: true
  4391. repeat: false
  4392. example: "100980037"
  4393. responses:
  4394. "200":
  4395. body:
  4396. application/json:
  4397. schema: listClaimsOutput
  4398. example: |
  4399. {
  4400. "claimWinsInfo": [
  4401. {
  4402. "bankAccountNumber": "01-2345-6789012",
  4403. "bankAccountConfirmed": true,
  4404. "drawId": 1240,
  4405. "ticketNumber": 30550008,
  4406. "walletSuspended": false,
  4407. "bonusTickets": 0,
  4408. "drawDate": "2015-12-04+13:00",
  4409. "gameDescription": "Lotto/Powerball",
  4410. "merchandiseDescription": "Lotto/Powerball",
  4411. "prizeAmount": 1.5,
  4412. "ticketType": "Lotto",
  4413. "wagerDate": "2015-12-04+13:00"
  4414. }
  4415. ]
  4416. }
  4417. "400":
  4418. body:
  4419. application/json:
  4420. schema: simpleResponse
  4421. example: |
  4422. {
  4423. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4424. }
  4425. "500":
  4426. body:
  4427. application/json:
  4428. schema: simpleResponse
  4429. example: |
  4430. {
  4431. "message": "Runtime Exception - Contact Administrator"
  4432. }
  4433. is: [error-responses, header-userid-sessionid-params]
  4434. /{ticketnumber}:
  4435. uriParameters:
  4436. ticketnumber:
  4437. displayName: ticketnumber
  4438. type: string
  4439. required: true
  4440. repeat: false
  4441. put:
  4442. description: Updates a specific claim and pays the prize to the winner
  4443. headers:
  4444. ESI_SID:
  4445. description: The ESi Session Id
  4446. type: string
  4447. required: true
  4448. repeat: false
  4449. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4450. USER_ID:
  4451. description: Esi User Id
  4452. type: string
  4453. required: true
  4454. repeat: false
  4455. example: "100980037"
  4456. body:
  4457. application/json:
  4458. schema: payPrizeInput
  4459. example: |
  4460. {
  4461. "password": "test123",
  4462. "addressLine1": "Crombie Lockwood Tower",
  4463. "addressLine2": "191 Queen Street",
  4464. "city": "Auckland",
  4465. "phonenumber": "23565454343",
  4466. "drawId":1348,
  4467. "poBox": 1001,
  4468. "postalCode": 1010
  4469. }
  4470. responses:
  4471. "200":
  4472. body:
  4473. application/json:
  4474. schema: simpleResponse
  4475. example: |
  4476. {
  4477. "message": "success"
  4478. }
  4479. "400":
  4480. body:
  4481. application/json:
  4482. schema: simpleResponse
  4483. example: |
  4484. {
  4485. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4486. }
  4487. "500":
  4488. body:
  4489. application/json:
  4490. schema: simpleResponse
  4491. example: |
  4492. {
  4493. "message": "Runtime Exception - Contact Administrator"
  4494. }
  4495. is: [error-responses, header-userid-sessionid-params]
  4496. /passwords:
  4497. /{username}:
  4498. uriParameters:
  4499. username:
  4500. displayName: username
  4501. type: string
  4502. required: true
  4503. repeat: false
  4504. post:
  4505. description: Resets the user's password and sends temporary password to player's designated email address.
  4506. body:
  4507. application/json:
  4508. schema: resetPasswordInput
  4509. example: |
  4510. {
  4511. "dateOfBirth": "1980-04-01",
  4512. "type" : 1,
  4513. "answer" : "pink"
  4514. }
  4515. responses:
  4516. "200":
  4517. body:
  4518. application/json:
  4519. schema: resetPasswordOutput
  4520. example: |
  4521. {
  4522. "emailAddress": "userid003@testme.co.nz"
  4523. }
  4524. "400":
  4525. body:
  4526. application/json:
  4527. schema: simpleResponse
  4528. example: |
  4529. {
  4530. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4531. }
  4532. "500":
  4533. body:
  4534. application/json:
  4535. schema: simpleResponse
  4536. example: |
  4537. {
  4538. "message": "Runtime Exception - Contact Administrator"
  4539. }
  4540. is: [error-responses]
  4541. put:
  4542. description: Send the newly entered password for specified username to ESi, and upon successful execution newly enetered password will be assigned and updated to player.
  4543. headers:
  4544. USER_NAME:
  4545. description: User name of the user
  4546. type: string
  4547. required: true
  4548. repeat: false
  4549. example: mule@test.com
  4550. body:
  4551. application/json:
  4552. schema: updatePasswordInput
  4553. example: |
  4554. {
  4555. "newPassword": "test123",
  4556. "verifyNewPassword" : "test123"
  4557. }
  4558. responses:
  4559. "200":
  4560. body:
  4561. application/json:
  4562. schema: updatePasswordOutput
  4563. example: |
  4564. {
  4565. "passwordUpdated": true
  4566. }
  4567. "400":
  4568. body:
  4569. application/json:
  4570. schema: simpleResponse
  4571. example: |
  4572. {
  4573. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4574. }
  4575. "500":
  4576. body:
  4577. application/json:
  4578. schema: simpleResponse
  4579. example: |
  4580. {
  4581. "message": "Runtime Exception - Contact Administrator"
  4582. }
  4583. is: [error-responses, header-username-param]
  4584. /status:
  4585. put:
  4586. description: Activation confirmed of a specified activationId
  4587. body:
  4588. application/json:
  4589. schema: activationConfirmInput
  4590. example: |
  4591. {
  4592. "geofilterInfo":
  4593. {
  4594. "language": "en-GB,en-US;q=0.8,en;q=0.6",
  4595. "encoding": "gzip,deflate,sdch",
  4596. "charset": "ISO-8859-1,utf-8;q=0.7,*;q=0.3",
  4597. "clientIP": "202.160.48.160",
  4598. "browser": "Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36"
  4599. },
  4600. "activationId": "6900204399"
  4601. }
  4602. responses:
  4603. "200":
  4604. body:
  4605. application/json:
  4606. schema: activationConfirmOutput
  4607. example: |
  4608. {
  4609. "userId": "100980037",
  4610. "emailAddress": "mule2@test.com",
  4611. "playerStatus": 4,
  4612. "activationIdExpired": false
  4613. }
  4614. "400":
  4615. body:
  4616. application/json:
  4617. schema: simpleResponse
  4618. example: |
  4619. {
  4620. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4621. }
  4622. "500":
  4623. body:
  4624. application/json:
  4625. schema: simpleResponse
  4626. example: |
  4627. {
  4628. "message": "Runtime Exception - Contact Administrator"
  4629. }
  4630. is: [error-responses]
  4631. /hintquestions:
  4632. get:
  4633. description: Get random hint Questions
  4634. responses:
  4635. "200":
  4636. body:
  4637. application/json:
  4638. schema: getHintQuestionsOutput
  4639. example: |
  4640. [
  4641. {
  4642. "type": 1,
  4643. "question": "What was my first pet's name?"
  4644. },
  4645. {
  4646. "type": 2,
  4647. "question": "What town was I born in?"
  4648. },
  4649. {
  4650. "type": 3,
  4651. "question": "What is the name of my first school?"
  4652. },
  4653. {
  4654. "type": 4,
  4655. "question": "What street did I grow up in?"
  4656. },
  4657. {
  4658. "type": 5,
  4659. "question": "What is my mother's maiden name?"
  4660. },
  4661. {
  4662. "type": 6,
  4663. "question": "What was the make of my first car?"
  4664. },
  4665. {
  4666. "type": 7,
  4667. "question": "What is my dad's middle name?"
  4668. },
  4669. {
  4670. "type": 8,
  4671. "question": "What is my favourite movie?"
  4672. },
  4673. {
  4674. "type": 9,
  4675. "question": "What was the last name of my best friend in school?"
  4676. }
  4677. ]
  4678. "400":
  4679. body:
  4680. application/json:
  4681. schema: simpleResponse
  4682. example: |
  4683. {
  4684. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4685. }
  4686. "500":
  4687. body:
  4688. application/json:
  4689. schema: simpleResponse
  4690. example: |
  4691. {
  4692. "message": "Runtime Exception - Contact Administrator"
  4693. }
  4694. is: [error-responses]
  4695. /{username}:
  4696. uriParameters:
  4697. username:
  4698. displayName: username
  4699. type: string
  4700. required: true
  4701. repeat: false
  4702. get:
  4703. description: Get hint question of specified user
  4704. queryParameters:
  4705. firstname:
  4706. description: Player's first name
  4707. type: string
  4708. required: true
  4709. repeat: false
  4710. example: John
  4711. lastname:
  4712. description: Player's last name
  4713. type: string
  4714. required: true
  4715. repeat: false
  4716. example: blog
  4717. responses:
  4718. "200":
  4719. body:
  4720. application/json:
  4721. schema: getHintQuestionOutput
  4722. example: |
  4723. {
  4724. "type": 1,
  4725. "question": "What was my first pet's name?"
  4726. }
  4727. "400":
  4728. body:
  4729. application/json:
  4730. schema: simpleResponse
  4731. example: |
  4732. {
  4733. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4734. }
  4735. "500":
  4736. body:
  4737. application/json:
  4738. schema: simpleResponse
  4739. example: |
  4740. {
  4741. "message": "Runtime Exception - Contact Administrator"
  4742. }
  4743. is: [error-responses]
  4744. put:
  4745. description: Change Hint Question and Answer of specified user
  4746. headers:
  4747. ESI_SID:
  4748. description: The ESi Session Id
  4749. type: string
  4750. required: true
  4751. repeat: false
  4752. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4753. USER_ID:
  4754. description: Esi User Id
  4755. type: string
  4756. required: true
  4757. repeat: false
  4758. example: "100980037"
  4759. USER_NAME:
  4760. description: User name of the user
  4761. type: string
  4762. required: true
  4763. repeat: false
  4764. example: mule@test.com
  4765. body:
  4766. application/json:
  4767. schema: changeHintQuestionsAnswersInput
  4768. example: |
  4769. {
  4770. "password": "test123",
  4771. "hintId1": 1,
  4772. "hint1Ans": "pink",
  4773. "userId": "100785011"
  4774. }
  4775. responses:
  4776. "200":
  4777. body:
  4778. application/json:
  4779. schema: simpleResponse
  4780. example: |
  4781. {
  4782. "message": "success"
  4783. }
  4784. "400":
  4785. body:
  4786. application/json:
  4787. schema: simpleResponse
  4788. example: |
  4789. {
  4790. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4791. }
  4792. "500":
  4793. body:
  4794. application/json:
  4795. schema: simpleResponse
  4796. example: |
  4797. {
  4798. "message": "Runtime Exception - Contact Administrator"
  4799. }
  4800. is: [error-responses, header-params]
  4801. /validations:
  4802. post:
  4803. description: Validate whether the specified hint question and answer of the player is correct or not.
  4804. body:
  4805. application/json:
  4806. schema: validateHintQuestion
  4807. example: |
  4808. {
  4809. "type": 1,
  4810. "answer": "Pink"
  4811. }
  4812. responses:
  4813. "200":
  4814. body:
  4815. application/json:
  4816. schema: validateHintOutput
  4817. example: |
  4818. {
  4819. "hintAnswerTrue" : true
  4820. }
  4821. "400":
  4822. body:
  4823. application/json:
  4824. schema: simpleResponse
  4825. example: |
  4826. {
  4827. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4828. }
  4829. "500":
  4830. body:
  4831. application/json:
  4832. schema: simpleResponse
  4833. example: |
  4834. {
  4835. "message": "Runtime Exception - Contact Administrator"
  4836. }
  4837. is: [error-responses]
  4838. /sessions:
  4839. displayName: sessions
  4840. description: Create and delete a session in the Gaming System
  4841. post:
  4842. description: Generate a new Session for a given username and password
  4843. body:
  4844. application/json:
  4845. schema: loginUserInput
  4846. example: |
  4847. {
  4848. "userName": "userid001@testme.co.nz",
  4849. "password": "test123",
  4850. "geofilterInfo":
  4851. {
  4852. "language": "en-GB,en-US;q=0.8,en;q=0.6",
  4853. "encoding": "gzip,deflate,sdch",
  4854. "charset": "ISO-8859-1,utf-8;q=0.7,*;q=0.3",
  4855. "clientIP": "202.160.48.160",
  4856. "browser": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.43 Safari/537.31"
  4857. }
  4858. }
  4859. responses:
  4860. "200":
  4861. body:
  4862. application/json:
  4863. schema: loginUserOutput
  4864. example: |
  4865. {
  4866. "userId": "100785008",
  4867. "sessionId": "RQ6UYO5YI2SKPSNIXKEEGS1F7496YH5I",
  4868. "lastLogon": "2015-10-28T12:14:04.801+13:00"
  4869. }
  4870. "400":
  4871. body:
  4872. application/json:
  4873. schema: simpleResponse
  4874. example: |
  4875. {
  4876. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4877. }
  4878. "500":
  4879. body:
  4880. application/json:
  4881. schema: simpleResponse
  4882. example: |
  4883. {
  4884. "message": "Runtime Exception - Contact Administrator"
  4885. }
  4886. is: [error-responses]
  4887. /{userid}:
  4888. uriParameters:
  4889. userid:
  4890. displayName: userid
  4891. type: string
  4892. required: true
  4893. repeat: false
  4894. delete:
  4895. description: Delete a session for a user
  4896. headers:
  4897. ESI_SID:
  4898. description: The ESi Session Id
  4899. type: string
  4900. required: true
  4901. repeat: false
  4902. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4903. USER_ID:
  4904. description: Esi User Id
  4905. type: string
  4906. required: true
  4907. repeat: false
  4908. example: "100980037"
  4909. responses:
  4910. "200":
  4911. body:
  4912. application/json:
  4913. schema: simpleResponse
  4914. example: |
  4915. {
  4916. "message": "success"
  4917. }
  4918. "400":
  4919. body:
  4920. application/json:
  4921. schema: simpleResponse
  4922. example: |
  4923. {
  4924. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  4925. }
  4926. "500":
  4927. body:
  4928. application/json:
  4929. schema: simpleResponse
  4930. example: |
  4931. {
  4932. "message": "Runtime Exception - Contact Administrator"
  4933. }
  4934. is: [error-responses, header-userid-sessionid-params]
  4935. /wagers:
  4936. displayName: wagers
  4937. description: A wager is a logical representation of tickets. It can be one or multiple tickets. A wager can be for any game type.
  4938. /{userid}:
  4939. uriParameters:
  4940. userid:
  4941. displayName: userid
  4942. type: string
  4943. required: true
  4944. repeat: false
  4945. get:
  4946. description: Returns the ticket history for a user
  4947. headers:
  4948. ESI_SID:
  4949. description: The ESi Session Id
  4950. type: string
  4951. required: true
  4952. repeat: false
  4953. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  4954. USER_ID:
  4955. description: Esi User Id
  4956. type: string
  4957. required: true
  4958. repeat: false
  4959. example: "100980037"
  4960. queryParameters:
  4961. startdate:
  4962. description: Start date to filter on tickets
  4963. type: string
  4964. required: true
  4965. repeat: false
  4966. pattern: |
  4967. (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).(\d{3})Z
  4968. example: "2015-10-10T00:00:00.000Z"
  4969. enddate:
  4970. description: End date to filter on tickets
  4971. type: string
  4972. required: true
  4973. repeat: false
  4974. pattern: |
  4975. (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).(\d{3})Z
  4976. example: "2016-01-10T00:00:00.000Z"
  4977. lotto:
  4978. description: Return tickets for the Lotto game
  4979. type: boolean
  4980. required: false
  4981. repeat: false
  4982. default: "false"
  4983. example: "true"
  4984. keno:
  4985. description: Return tickets for the Keno game
  4986. type: boolean
  4987. required: false
  4988. repeat: false
  4989. default: "false"
  4990. example: "true"
  4991. strikeCategory:
  4992. description: Return tickets for the Strike game
  4993. type: boolean
  4994. required: false
  4995. repeat: false
  4996. default: "true"
  4997. example: "true"
  4998. bullseye:
  4999. description: Return tickets for the Bullseye game
  5000. type: boolean
  5001. required: false
  5002. repeat: false
  5003. default: "false"
  5004. example: "true"
  5005. play3:
  5006. description: Return tickets for the Play3 game
  5007. type: boolean
  5008. required: false
  5009. repeat: false
  5010. default: "false"
  5011. example: "true"
  5012. responses:
  5013. "200":
  5014. body:
  5015. application/json:
  5016. schema: gameHistOutput
  5017. example: |
  5018. {
  5019. "gameHistory": [
  5020. {
  5021. "gameName": "Play3",
  5022. "ticketNumber": "19351567",
  5023. "ticketType": "Coupon",
  5024. "drawStartDate": "2012-01-01+13:00",
  5025. "drawEndDate": "2012-01-01+13:00",
  5026. "purchaseDate": "2015-12-04+13:00",
  5027. "purchaseAmount": "1.00",
  5028. "ticketStatus": "OPEN",
  5029. "gameTransactionNumber": "2976051",
  5030. "promoId": 0,
  5031. "drawHistoryInfo": {
  5032. "drawId": 1,
  5033. "drawDate": "2012-01-01+13:00",
  5034. "drawStatus": "Active",
  5035. "drawTicketStatus": "PURCH"
  5036. },
  5037. "orderId": "19351567",
  5038. "winAmount": 0,
  5039. "winningFlag": false,
  5040. "winoutcome": "-"
  5041. },
  5042. {
  5043. "gameName": "Bullseye",
  5044. "ticketNumber": "19351566",
  5045. "ticketType": "Coupon",
  5046. "drawStartDate": "2009-10-15+13:00",
  5047. "drawEndDate": "2009-10-15+13:00",
  5048. "purchaseDate": "2015-12-04+13:00",
  5049. "purchaseAmount": "2.00",
  5050. "ticketStatus": "OPEN",
  5051. "gameTransactionNumber": "2976050",
  5052. "promoId": 0,
  5053. "drawHistoryInfo": {
  5054. "drawId": 1,
  5055. "drawDate": "2009-10-15+13:00",
  5056. "drawStatus": "Active",
  5057. "drawTicketStatus": "PURCH"
  5058. },
  5059. "orderId": "19351566",
  5060. "winAmount": 0,
  5061. "winningFlag": false,
  5062. "winoutcome": "-"
  5063. },
  5064. {
  5065. "gameName": "Keno",
  5066. "ticketNumber": "19351565",
  5067. "ticketType": "Coupon",
  5068. "drawStartDate": "2009-11-14+13:00",
  5069. "drawEndDate": "2009-11-15+13:00",
  5070. "purchaseDate": "2015-12-04+13:00",
  5071. "purchaseAmount": "6.00",
  5072. "ticketStatus": "OPEN",
  5073. "gameTransactionNumber": "2976049",
  5074. "promoId": 0,
  5075. "drawHistoryInfo": [
  5076. {
  5077. "drawId": 6290,
  5078. "drawDate": "2009-11-14+13:00",
  5079. "drawStatus": "Active",
  5080. "drawTicketStatus": "PURCH"
  5081. },
  5082. {
  5083. "drawId": 6291,
  5084. "drawDate": "2009-11-14+13:00",
  5085. "drawStatus": "Announced",
  5086. "drawTicketStatus": "PURCH"
  5087. },
  5088. {
  5089. "drawId": 6292,
  5090. "drawDate": "2009-11-15+13:00",
  5091. "drawStatus": "Announced",
  5092. "drawTicketStatus": "PURCH"
  5093. }
  5094. ],
  5095. "orderId": "19351565",
  5096. "winAmount": 0,
  5097. "winningFlag": false,
  5098. "winoutcome": "-"
  5099. },
  5100. {
  5101. "gameName": "Lotto Powerball",
  5102. "ticketNumber": "19351564",
  5103. "ticketType": "Starter Lucky Dip",
  5104. "drawStartDate": "2012-10-06+13:00",
  5105. "drawEndDate": "2012-10-06+13:00",
  5106. "purchaseDate": "2015-12-04+13:00",
  5107. "purchaseAmount": "4.80",
  5108. "ticketStatus": "OPEN",
  5109. "gameTransactionNumber": "2976048",
  5110. "promoId": 0,
  5111. "drawHistoryInfo": {
  5112. "drawId": 1156,
  5113. "drawDate": "2012-10-06+13:00",
  5114. "drawStatus": "Active",
  5115. "drawTicketStatus": "PURCH"
  5116. },
  5117. "orderId": "19351564",
  5118. "winAmount": 0,
  5119. "winningFlag": false,
  5120. "winoutcome": "-"
  5121. }
  5122. ]
  5123. }
  5124. "400":
  5125. body:
  5126. application/json:
  5127. schema: simpleResponse
  5128. example: |
  5129. {
  5130. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  5131. }
  5132. "500":
  5133. body:
  5134. application/json:
  5135. schema: simpleResponse
  5136. example: |
  5137. {
  5138. "message": "Runtime Exception - Contact Administrator"
  5139. }
  5140. is: [error-responses, header-userid-sessionid-params]
  5141. post:
  5142. description: Purchase a wager for the different game types
  5143. headers:
  5144. ESI_SID:
  5145. description: The ESi Session Id
  5146. type: string
  5147. required: true
  5148. repeat: false
  5149. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  5150. USER_ID:
  5151. description: Esi User Id
  5152. type: string
  5153. required: true
  5154. repeat: false
  5155. example: "100980037"
  5156. queryParameters:
  5157. returntickets:
  5158. description: Whether ticket details should be fetched and returned with each ticket
  5159. type: boolean
  5160. required: false
  5161. repeat: false
  5162. body:
  5163. application/json:
  5164. schema: purchaseWagerInput
  5165. example: |
  5166. {
  5167. "channelId": 1,
  5168. "lottoWagers": [
  5169. {
  5170. "purchaseType": "DIP",
  5171. "wagerAmount": 4.8,
  5172. "numberOfBoards": 8,
  5173. "numberStrikeBoards": 0,
  5174. "numberPowerballBoards": 0,
  5175. "powerballNumber": "Random",
  5176. "numberOfDraws": 1,
  5177. "advanceDraw": 0,
  5178. "couponType": false,
  5179. "lottoWagerDetails": [
  5180. {
  5181. "starterDipType": true,
  5182. "lottoLuckyDip": true,
  5183. "lottoPowerDip": false,
  5184. "lottoTripleDip": false,
  5185. "basicDipType": false,
  5186. "superDipType": false,
  5187. "superPlusDipType": false,
  5188. "megaDipType": false,
  5189. "mega24DipType": false,
  5190. "drawDays": [
  5191. "Wed"
  5192. ]
  5193. }
  5194. ]
  5195. },
  5196. {
  5197. "purchaseType": "Pick Your Own",
  5198. "wagerAmount": 13.6,
  5199. "numberOfBoards": 4,
  5200. "numberStrikeBoards": 2,
  5201. "numberPowerballBoards": 4,
  5202. "numberOfDraws": 2,
  5203. "couponType": true,
  5204. "strikeWagerDetails": [
  5205. {
  5206. "strikeBoard": [
  5207. {
  5208. "numbers": [ 1,26,13,5 ]
  5209. },
  5210. {
  5211. "numbers": [ 9, 17, 25, 22 ]
  5212. }
  5213. ],
  5214. "drawDays": [
  5215. "Sat",
  5216. "Wed"
  5217. ]
  5218. }
  5219. ],
  5220. "lottoWagerDetails": [
  5221. {
  5222. "lottoBoard": [
  5223. {
  5224. "powerballNumber": 8,
  5225. "numbers": [ 8, 15, 21, 26, 29, 32 ]
  5226. },
  5227. {
  5228. "powerballNumber": 1,
  5229. "numbers": [ 3, 8, 12, 14, 20, 25 ]
  5230. },
  5231. {
  5232. "powerballNumber": 2,
  5233. "numbers": [ 4, 7, 25, 34, 35, 40 ]
  5234. },
  5235. {
  5236. "powerballNumber": 1,
  5237. "numbers": [ 18, 19, 20, 21, 26, 36 ]
  5238. }
  5239. ],
  5240. "drawDays": [
  5241. "Sat",
  5242. "Wed"
  5243. ]
  5244. }
  5245. ]
  5246. }
  5247. ],
  5248. "bullseyeWagers": [
  5249. {
  5250. "purchaseType": "DIP",
  5251. "wagerAmount": 2,
  5252. "numberOfBoards": 1,
  5253. "numberOfDraws": 1,
  5254. "couponType": true,
  5255. "bullseyeWagerDetails": [
  5256. {
  5257. "bullseyeBoard": [
  5258. {
  5259. "numbers": [ 5, 6, 5, 8, 8, 5 ]
  5260. }
  5261. ]
  5262. }
  5263. ]
  5264. },
  5265. {
  5266. "purchaseType": "Pick Your Own",
  5267. "wagerAmount": 12,
  5268. "numberOfBoards": 2,
  5269. "numberOfDraws": 3,
  5270. "couponType": true,
  5271. "bullseyeWagerDetails": [
  5272. {
  5273. "bullseyeBoard": [
  5274. {
  5275. "numbers": [ 7, 8, 1, 8, 6, 3 ]
  5276. },
  5277. {
  5278. "numbers": [ 8, 2, 9, 3, 1, 3 ]
  5279. }
  5280. ]
  5281. }
  5282. ]
  5283. }
  5284. ],
  5285. "kenoWagers": [
  5286. {
  5287. "purchaseType": "DIP",
  5288. "wagerAmount": 5,
  5289. "pricePerBoard": 1,
  5290. "numberOfBoards": 1,
  5291. "numberOfDraws": 5,
  5292. "couponType": true,
  5293. "kenoWagerDetails": [
  5294. {
  5295. "kenoDip": 0,
  5296. "drawTimes": [ 10, 13, 15, 18 ],
  5297. "kenoBoard": [
  5298. {
  5299. "groupNumber": 10,
  5300. "numbers": [ 4, 71, 5, 12, 29, 58, 11, 16, 8, 73 ]
  5301. }
  5302. ]
  5303. }
  5304. ]
  5305. },
  5306. {
  5307. "purchaseType": "Pick Your Own",
  5308. "wagerAmount": 6,
  5309. "pricePerBoard": 3,
  5310. "numberOfBoards": 1,
  5311. "numberOfDraws": 2,
  5312. "couponType": true,
  5313. "kenoWagerDetails": [
  5314. {
  5315. "drawTimes": [ 10, 13, 15, 18 ],
  5316. "kenoBoard": [
  5317. {
  5318. "groupNumber": 4,
  5319. "numbers": [ 35, 62, 1, 71 ]
  5320. }
  5321. ]
  5322. }
  5323. ]
  5324. }
  5325. ],
  5326. "play3Wagers": [
  5327. {
  5328. "purchaseType": "Pick Your Own",
  5329. "wagerAmount": 6,
  5330. "numberOfBoards": 2,
  5331. "numberOfDraws": 2,
  5332. "couponType": true,
  5333. "play3WagerDetails": [
  5334. {
  5335. "play3Boards": [
  5336. {
  5337. "numbers": [ 0, 6, 3 ],
  5338. "play3PlayType": "Any",
  5339. "play3BoardAmount": 1
  5340. },
  5341. {
  5342. "numbers": [ 5, 6, 5 ],
  5343. "play3PlayType": "ExactPairs",
  5344. "play3BoardAmount": 2
  5345. }
  5346. ]
  5347. }
  5348. ]
  5349. }
  5350. ]
  5351. }
  5352. responses:
  5353. "200":
  5354. body:
  5355. application/json:
  5356. schema: purchaseWagerOutput
  5357. example: |
  5358. {
  5359. "lottoWagers": [
  5360. {
  5361. "gameTransactionNumber": "2985114",
  5362. "wagerAmount": 4.8,
  5363. "walletBalance": 64.2,
  5364. "numberOfTicketsGenerated": 1,
  5365. "promoTicketReturned": false,
  5366. "numberOfStrikeTicketsGenerated": 0,
  5367. "lottoTickets": [
  5368. {
  5369. "transactionId": "23000163",
  5370. "ticketNumber": "19450170",
  5371. "ticketDetails": {
  5372. "gameName": "Lotto Powerball",
  5373. "numberOfBoards": 8,
  5374. "numberOfDraws": 1,
  5375. "systemNumber": 0,
  5376. "wagerAmount": 4.8,
  5377. "ticketNumber": "19450170",
  5378. "ticketType": "Starter Lucky Dip",
  5379. "purchaseDate": "2016-06-22+12:00",
  5380. "ticketStatus": "OPEN",
  5381. "gameTransactionNumber": "2985114",
  5382. "couponType": false,
  5383. "drawWinDetails": [
  5384. {
  5385. "lottoNumber": 0,
  5386. "bonusTickets": 0,
  5387. "drawDate": "2012-10-10+13:00",
  5388. "drawStatus": "Announced",
  5389. "winAmount": 0,
  5390. "winningFlag": false,
  5391. "drawTicketStatus": "PURCH",
  5392. "megaDipType": false,
  5393. "drawNumber": 1157,
  5394. "lottoLuckyDip": false,
  5395. "lottoPowerDip": false,
  5396. "lottoTripleDip": false
  5397. }
  5398. ],
  5399. "lottoWagerDetails": [
  5400. {
  5401. "lottoLuckyDip": true,
  5402. "lottoPowerDip": false,
  5403. "lottoTripleDip": false,
  5404. "starterDipType": true,
  5405. "basicDipType": false,
  5406. "superDipType": false,
  5407. "superPlusDipType": false,
  5408. "megaDipType": false,
  5409. "mega24DipType": false,
  5410. "lottoBoard": [
  5411. {
  5412. "powerballNumber": 0,
  5413. "numbers": [
  5414. 16,
  5415. 17,
  5416. 20,
  5417. 21,
  5418. 34,
  5419. 38
  5420. ]
  5421. },
  5422. {
  5423. "powerballNumber": 0,
  5424. "numbers": [
  5425. 6,
  5426. 26,
  5427. 29,
  5428. 30,
  5429. 33,
  5430. 36
  5431. ]
  5432. },
  5433. {
  5434. "powerballNumber": 0,
  5435. "numbers": [
  5436. 3,
  5437. 4,
  5438. 9,
  5439. 14,
  5440. 15,
  5441. 25
  5442. ]
  5443. },
  5444. {
  5445. "powerballNumber": 0,
  5446. "numbers": [
  5447. 19,
  5448. 27,
  5449. 28,
  5450. 35,
  5451. 39,
  5452. 40
  5453. ]
  5454. },
  5455. {
  5456. "powerballNumber": 0,
  5457. "numbers": [
  5458. 5,
  5459. 6,
  5460. 9,
  5461. 11,
  5462. 27,
  5463. 31
  5464. ]
  5465. },
  5466. {
  5467. "powerballNumber": 0,
  5468. "numbers": [
  5469. 1,
  5470. 3,
  5471. 10,
  5472. 33,
  5473. 35,
  5474. 36
  5475. ]
  5476. },
  5477. {
  5478. "powerballNumber": 0,
  5479. "numbers": [
  5480. 8,
  5481. 15,
  5482. 20,
  5483. 23,
  5484. 30,
  5485. 39
  5486. ]
  5487. },
  5488. {
  5489. "powerballNumber": 0,
  5490. "numbers": [
  5491. 17,
  5492. 22,
  5493. 29,
  5494. 32,
  5495. 38,
  5496. 40
  5497. ]
  5498. }
  5499. ],
  5500. "drawDays": [
  5501. "Wed"
  5502. ]
  5503. }
  5504. ],
  5505. "promoTicketReturned": false,
  5506. "startDraw": 1157,
  5507. "ticketName": "Lucky Dip"
  5508. }
  5509. }
  5510. ],
  5511. "spentToDateWeek": 4.8,
  5512. "spentToDateMonth": 4.8
  5513. },
  5514. {
  5515. "gameTransactionNumber": "2985115",
  5516. "wagerAmount": 13.6,
  5517. "walletBalance": 50.6,
  5518. "numberOfTicketsGenerated": 1,
  5519. "strikeTickets": [
  5520. {
  5521. "strikeTransactionId": "23000164",
  5522. "strikeTicketNumber": "19450172",
  5523. "ticketDetails": {
  5524. "gameName": "Lotto Strike",
  5525. "numberOfBoards": 2,
  5526. "numberOfDraws": 2,
  5527. "systemNumber": 0,
  5528. "wagerAmount": 4,
  5529. "ticketNumber": "19450172",
  5530. "ticketType": "Coupon",
  5531. "purchaseDate": "2016-06-22+12:00",
  5532. "ticketStatus": "OPEN",
  5533. "gameTransactionNumber": "2985115",
  5534. "couponType": true,
  5535. "drawWinDetails": [
  5536. {
  5537. "lottoNumber": 0,
  5538. "bonusTickets": 0,
  5539. "drawDate": "2012-10-06+13:00",
  5540. "drawStatus": "Active",
  5541. "winAmount": 0,
  5542. "winningFlag": false,
  5543. "drawTicketStatus": "PURCH",
  5544. "megaDipType": false,
  5545. "drawNumber": 1156,
  5546. "lottoLuckyDip": false,
  5547. "lottoPowerDip": false,
  5548. "lottoTripleDip": false
  5549. },
  5550. {
  5551. "lottoNumber": 0,
  5552. "bonusTickets": 0,
  5553. "drawDate": "2012-10-10+13:00",
  5554. "drawStatus": "Announced",
  5555. "winAmount": 0,
  5556. "winningFlag": false,
  5557. "drawTicketStatus": "PURCH",
  5558. "megaDipType": false,
  5559. "drawNumber": 1157,
  5560. "lottoLuckyDip": false,
  5561. "lottoPowerDip": false,
  5562. "lottoTripleDip": false
  5563. }
  5564. ],
  5565. "strikeWagerDetails": [
  5566. {
  5567. "strikeBoard": [
  5568. {
  5569. "numbers": [
  5570. 1,
  5571. 26,
  5572. 13,
  5573. 5
  5574. ]
  5575. },
  5576. {
  5577. "numbers": [
  5578. 9,
  5579. 17,
  5580. 25,
  5581. 22
  5582. ]
  5583. }
  5584. ],
  5585. "drawDays": [
  5586. "Wed",
  5587. "Sat"
  5588. ]
  5589. }
  5590. ],
  5591. "promoTicketReturned": false,
  5592. "startDraw": 1156,
  5593. "ticketMessage": " YOU MAY HAVE JUST HELPED\r FUND A KIWI BLOCKBUSTER.\r NZ LOTTERIES PROFITS HELP\r FUND NZ FILM COMMISSION.",
  5594. "ticketName": "Lotto Strike"
  5595. }
  5596. }
  5597. ],
  5598. "promoTicketReturned": false,
  5599. "numberOfStrikeTicketsGenerated": 1,
  5600. "lottoTickets": [
  5601. {
  5602. "transactionId": "23000164",
  5603. "ticketNumber": "19450171",
  5604. "ticketDetails": {
  5605. "gameName": "Lotto Powerball",
  5606. "numberOfBoards": 4,
  5607. "numberOfDraws": 2,
  5608. "systemNumber": 0,
  5609. "wagerAmount": 9.6,
  5610. "ticketNumber": "19450171",
  5611. "ticketType": "Coupon",
  5612. "purchaseDate": "2016-06-22+12:00",
  5613. "ticketStatus": "OPEN",
  5614. "gameTransactionNumber": "2985115",
  5615. "couponType": true,
  5616. "drawWinDetails": [
  5617. {
  5618. "lottoNumber": 0,
  5619. "bonusTickets": 0,
  5620. "drawDate": "2012-10-06+13:00",
  5621. "drawStatus": "Active",
  5622. "winAmount": 0,
  5623. "winningFlag": false,
  5624. "drawTicketStatus": "PURCH",
  5625. "megaDipType": false,
  5626. "drawNumber": 1156,
  5627. "lottoLuckyDip": false,
  5628. "lottoPowerDip": false,
  5629. "lottoTripleDip": false
  5630. },
  5631. {
  5632. "lottoNumber": 0,
  5633. "bonusTickets": 0,
  5634. "drawDate": "2012-10-10+13:00",
  5635. "drawStatus": "Announced",
  5636. "winAmount": 0,
  5637. "winningFlag": false,
  5638. "drawTicketStatus": "PURCH",
  5639. "megaDipType": false,
  5640. "drawNumber": 1157,
  5641. "lottoLuckyDip": false,
  5642. "lottoPowerDip": false,
  5643. "lottoTripleDip": false
  5644. }
  5645. ],
  5646. "lottoWagerDetails": [
  5647. {
  5648. "lottoLuckyDip": false,
  5649. "lottoPowerDip": false,
  5650. "lottoTripleDip": false,
  5651. "starterDipType": false,
  5652. "basicDipType": false,
  5653. "superDipType": false,
  5654. "superPlusDipType": false,
  5655. "megaDipType": false,
  5656. "mega24DipType": false,
  5657. "lottoBoard": [
  5658. {
  5659. "powerballNumber": 8,
  5660. "numbers": [
  5661. 8,
  5662. 15,
  5663. 21,
  5664. 26,
  5665. 29,
  5666. 32
  5667. ]
  5668. },
  5669. {
  5670. "powerballNumber": 1,
  5671. "numbers": [
  5672. 3,
  5673. 8,
  5674. 12,
  5675. 14,
  5676. 20,
  5677. 25
  5678. ]
  5679. },
  5680. {
  5681. "powerballNumber": 2,
  5682. "numbers": [
  5683. 4,
  5684. 7,
  5685. 25,
  5686. 34,
  5687. 35,
  5688. 40
  5689. ]
  5690. },
  5691. {
  5692. "powerballNumber": 1,
  5693. "numbers": [
  5694. 18,
  5695. 19,
  5696. 20,
  5697. 21,
  5698. 26,
  5699. 36
  5700. ]
  5701. }
  5702. ],
  5703. "drawDays": [
  5704. "Wed",
  5705. "Sat"
  5706. ]
  5707. }
  5708. ],
  5709. "promoTicketReturned": false,
  5710. "startDraw": 1156,
  5711. "ticketName": "Lotto Powerball"
  5712. }
  5713. }
  5714. ],
  5715. "spentToDateWeek": 18.4,
  5716. "spentToDateMonth": 18.4
  5717. }
  5718. ],
  5719. "bullseyeWagers": [
  5720. {
  5721. "transactionId": "19450173",
  5722. "ticketNumber": "19450173",
  5723. "gameTransactionNumber": "2985116",
  5724. "wagerAmount": 2,
  5725. "walletBalance": 48.6,
  5726. "promoTicketReturned": false,
  5727. "spentToDateWeek": 20.4,
  5728. "spentToDateMonth": 20.4,
  5729. "ticketDetails": {
  5730. "gameName": "Bullseye",
  5731. "numberOfBoards": 1,
  5732. "numberOfDraws": 1,
  5733. "systemNumber": 0,
  5734. "wagerAmount": 2,
  5735. "pricePerBoard": 2,
  5736. "ticketNumber": "19450173",
  5737. "ticketType": "Coupon",
  5738. "purchaseDate": "2016-06-22+12:00",
  5739. "ticketStatus": "OPEN",
  5740. "gameTransactionNumber": "2985116",
  5741. "couponType": true,
  5742. "drawWinDetails": [
  5743. {
  5744. "lottoNumber": 0,
  5745. "bonusTickets": 0,
  5746. "drawDate": "2009-10-15+13:00",
  5747. "drawStatus": "Active",
  5748. "winAmount": 0,
  5749. "winningFlag": false,
  5750. "drawTicketStatus": "PURCH",
  5751. "megaDipType": false,
  5752. "drawNumber": 1,
  5753. "lottoLuckyDip": false,
  5754. "lottoPowerDip": false,
  5755. "lottoTripleDip": false
  5756. }
  5757. ],
  5758. "bullseyeWagerDetails": [
  5759. {
  5760. "bullseyeBoard": [
  5761. {
  5762. "numbers": [
  5763. 5,
  5764. 6,
  5765. 5,
  5766. 8,
  5767. 8,
  5768. 5
  5769. ]
  5770. }
  5771. ],
  5772. "bullseyeDip": 0
  5773. }
  5774. ],
  5775. "promoTicketReturned": false,
  5776. "startDraw": 1,
  5777. "ticketMessage": "2 DAW BULLSEYE TICKET MSG",
  5778. "ticketName": "Bullseye"
  5779. }
  5780. },
  5781. {
  5782. "transactionId": "19450174",
  5783. "ticketNumber": "19450174",
  5784. "gameTransactionNumber": "2985117",
  5785. "wagerAmount": 12,
  5786. "walletBalance": 36.6,
  5787. "promoTicketReturned": false,
  5788. "spentToDateWeek": 32.4,
  5789. "spentToDateMonth": 32.4,
  5790. "ticketDetails": {
  5791. "gameName": "Bullseye",
  5792. "numberOfBoards": 2,
  5793. "numberOfDraws": 3,
  5794. "systemNumber": 0,
  5795. "wagerAmount": 12,
  5796. "pricePerBoard": 2,
  5797. "ticketNumber": "19450174",
  5798. "ticketType": "Coupon",
  5799. "purchaseDate": "2016-06-22+12:00",
  5800. "ticketStatus": "OPEN",
  5801. "gameTransactionNumber": "2985117",
  5802. "couponType": true,
  5803. "drawWinDetails": [
  5804. {
  5805. "lottoNumber": 0,
  5806. "bonusTickets": 0,
  5807. "drawDate": "2009-10-15+13:00",
  5808. "drawStatus": "Active",
  5809. "winAmount": 0,
  5810. "winningFlag": false,
  5811. "drawTicketStatus": "PURCH",
  5812. "megaDipType": false,
  5813. "drawNumber": 1,
  5814. "lottoLuckyDip": false,
  5815. "lottoPowerDip": false,
  5816. "lottoTripleDip": false
  5817. },
  5818. {
  5819. "lottoNumber": 0,
  5820. "bonusTickets": 0,
  5821. "drawDate": "2009-10-16+13:00",
  5822. "drawStatus": "Announced",
  5823. "winAmount": 0,
  5824. "winningFlag": false,
  5825. "drawTicketStatus": "PURCH",
  5826. "megaDipType": false,
  5827. "drawNumber": 2,
  5828. "lottoLuckyDip": false,
  5829. "lottoPowerDip": false,
  5830. "lottoTripleDip": false
  5831. },
  5832. {
  5833. "lottoNumber": 0,
  5834. "bonusTickets": 0,
  5835. "drawDate": "2009-10-17+13:00",
  5836. "drawStatus": "Announced",
  5837. "winAmount": 0,
  5838. "winningFlag": false,
  5839. "drawTicketStatus": "PURCH",
  5840. "megaDipType": false,
  5841. "drawNumber": 3,
  5842. "lottoLuckyDip": false,
  5843. "lottoPowerDip": false,
  5844. "lottoTripleDip": false
  5845. }
  5846. ],
  5847. "bullseyeWagerDetails": [
  5848. {
  5849. "bullseyeBoard": [
  5850. {
  5851. "numbers": [
  5852. 7,
  5853. 8,
  5854. 1,
  5855. 8,
  5856. 6,
  5857. 3
  5858. ]
  5859. },
  5860. {
  5861. "numbers": [
  5862. 8,
  5863. 2,
  5864. 9,
  5865. 3,
  5866. 1,
  5867. 3
  5868. ]
  5869. }
  5870. ],
  5871. "bullseyeDip": 0
  5872. }
  5873. ],
  5874. "promoTicketReturned": false,
  5875. "startDraw": 1,
  5876. "ticketMessage": "2 DAW BULLSEYE TICKET MSG",
  5877. "ticketName": "Bullseye"
  5878. }
  5879. }
  5880. ],
  5881. "kenoWagers": [
  5882. {
  5883. "transactionId": "23000167",
  5884. "ticketNumber": "19450175",
  5885. "gameTransactionNumber": "2985118",
  5886. "wagerAmount": 5,
  5887. "walletBalance": 31.6,
  5888. "promoTicketReturned": false,
  5889. "spentToDateWeek": 37.4,
  5890. "spentToDateMonth": 37.4,
  5891. "ticketDetails": {
  5892. "gameName": "Keno",
  5893. "numberOfBoards": 1,
  5894. "numberOfDraws": 5,
  5895. "systemNumber": 0,
  5896. "wagerAmount": 5,
  5897. "pricePerBoard": 1,
  5898. "ticketNumber": "19450175",
  5899. "ticketType": "Coupon",
  5900. "purchaseDate": "2016-06-22+12:00",
  5901. "ticketStatus": "OPEN",
  5902. "gameTransactionNumber": "2985118",
  5903. "couponType": true,
  5904. "drawWinDetails": [
  5905. {
  5906. "lottoNumber": 0,
  5907. "bonusTickets": 0,
  5908. "drawDate": "2009-11-14+13:00",
  5909. "drawStatus": "Active",
  5910. "winAmount": 0,
  5911. "winningFlag": false,
  5912. "drawTicketStatus": "PURCH",
  5913. "megaDipType": false,
  5914. "drawNumber": 6290,
  5915. "lottoLuckyDip": false,
  5916. "lottoPowerDip": false,
  5917. "lottoTripleDip": false
  5918. },
  5919. {
  5920. "lottoNumber": 0,
  5921. "bonusTickets": 0,
  5922. "drawDate": "2009-11-14+13:00",
  5923. "drawStatus": "Announced",
  5924. "winAmount": 0,
  5925. "winningFlag": false,
  5926. "drawTicketStatus": "PURCH",
  5927. "megaDipType": false,
  5928. "drawNumber": 6291,
  5929. "lottoLuckyDip": false,
  5930. "lottoPowerDip": false,
  5931. "lottoTripleDip": false
  5932. },
  5933. {
  5934. "lottoNumber": 0,
  5935. "bonusTickets": 0,
  5936. "drawDate": "2009-11-15+13:00",
  5937. "drawStatus": "Announced",
  5938. "winAmount": 0,
  5939. "winningFlag": false,
  5940. "drawTicketStatus": "PURCH",
  5941. "megaDipType": false,
  5942. "drawNumber": 6292,
  5943. "lottoLuckyDip": false,
  5944. "lottoPowerDip": false,
  5945. "lottoTripleDip": false
  5946. },
  5947. {
  5948. "lottoNumber": 0,
  5949. "bonusTickets": 0,
  5950. "drawDate": "2009-11-15+13:00",
  5951. "drawStatus": "Announced",
  5952. "winAmount": 0,
  5953. "winningFlag": false,
  5954. "drawTicketStatus": "PURCH",
  5955. "megaDipType": false,
  5956. "drawNumber": 6293,
  5957. "lottoLuckyDip": false,
  5958. "lottoPowerDip": false,
  5959. "lottoTripleDip": false
  5960. },
  5961. {
  5962. "lottoNumber": 0,
  5963. "bonusTickets": 0,
  5964. "drawDate": "2009-11-16+13:00",
  5965. "drawStatus": "Announced",
  5966. "winAmount": 0,
  5967. "winningFlag": false,
  5968. "drawTicketStatus": "PURCH",
  5969. "megaDipType": false,
  5970. "drawNumber": 6294,
  5971. "lottoLuckyDip": false,
  5972. "lottoPowerDip": false,
  5973. "lottoTripleDip": false
  5974. }
  5975. ],
  5976. "kenoWagerDetails": [
  5977. {
  5978. "kenoDip": 0,
  5979. "kenoBoard": [
  5980. {
  5981. "groupNumber": 0,
  5982. "numbers": [
  5983. 4,
  5984. 71,
  5985. 5,
  5986. 12,
  5987. 29,
  5988. 58,
  5989. 11,
  5990. 16,
  5991. 8,
  5992. 73
  5993. ]
  5994. }
  5995. ],
  5996. "drawTimes": [
  5997. "10",
  5998. "18",
  5999. "15",
  6000. "13"
  6001. ]
  6002. }
  6003. ],
  6004. "promoTicketReturned": false,
  6005. "startDraw": 6290,
  6006. "ticketName": "Keno"
  6007. }
  6008. },
  6009. {
  6010. "transactionId": "23000168",
  6011. "ticketNumber": "19450176",
  6012. "gameTransactionNumber": "2985119",
  6013. "wagerAmount": 6,
  6014. "walletBalance": 25.6,
  6015. "promoTicketReturned": false,
  6016. "spentToDateWeek": 43.4,
  6017. "spentToDateMonth": 43.4,
  6018. "ticketDetails": {
  6019. "gameName": "Keno",
  6020. "numberOfBoards": 1,
  6021. "numberOfDraws": 2,
  6022. "systemNumber": 0,
  6023. "wagerAmount": 6,
  6024. "pricePerBoard": 3,
  6025. "ticketNumber": "19450176",
  6026. "ticketType": "Coupon",
  6027. "purchaseDate": "2016-06-22+12:00",
  6028. "ticketStatus": "OPEN",
  6029. "gameTransactionNumber": "2985119",
  6030. "couponType": true,
  6031. "drawWinDetails": [
  6032. {
  6033. "lottoNumber": 0,
  6034. "bonusTickets": 0,
  6035. "drawDate": "2009-11-14+13:00",
  6036. "drawStatus": "Active",
  6037. "winAmount": 0,
  6038. "winningFlag": false,
  6039. "drawTicketStatus": "PURCH",
  6040. "megaDipType": false,
  6041. "drawNumber": 6290,
  6042. "lottoLuckyDip": false,
  6043. "lottoPowerDip": false,
  6044. "lottoTripleDip": false
  6045. },
  6046. {
  6047. "lottoNumber": 0,
  6048. "bonusTickets": 0,
  6049. "drawDate": "2009-11-14+13:00",
  6050. "drawStatus": "Announced",
  6051. "winAmount": 0,
  6052. "winningFlag": false,
  6053. "drawTicketStatus": "PURCH",
  6054. "megaDipType": false,
  6055. "drawNumber": 6291,
  6056. "lottoLuckyDip": false,
  6057. "lottoPowerDip": false,
  6058. "lottoTripleDip": false
  6059. }
  6060. ],
  6061. "kenoWagerDetails": [
  6062. {
  6063. "kenoDip": 0,
  6064. "kenoBoard": [
  6065. {
  6066. "groupNumber": 0,
  6067. "numbers": [
  6068. 35,
  6069. 62,
  6070. 1,
  6071. 71
  6072. ]
  6073. }
  6074. ],
  6075. "drawTimes": [
  6076. "10",
  6077. "18",
  6078. "15",
  6079. "13"
  6080. ]
  6081. }
  6082. ],
  6083. "promoTicketReturned": false,
  6084. "startDraw": 6290,
  6085. "ticketName": "Keno"
  6086. }
  6087. }
  6088. ],
  6089. "play3Wagers": [
  6090. {
  6091. "transactionId": "23000169",
  6092. "ticketNumber": "19450177",
  6093. "gameTransactionNumber": "2985120",
  6094. "wagerAmount": 6,
  6095. "walletBalance": 19.6,
  6096. "promoTicketReturned": false,
  6097. "spentToDateWeek": 49.4,
  6098. "spentToDateMonth": 49.4,
  6099. "ticketDetails": {
  6100. "gameName": "Play3",
  6101. "numberOfBoards": 2,
  6102. "numberOfDraws": 2,
  6103. "systemNumber": 0,
  6104. "wagerAmount": 6,
  6105. "ticketNumber": "19450177",
  6106. "ticketType": "Coupon",
  6107. "purchaseDate": "2016-06-22+12:00",
  6108. "ticketStatus": "OPEN",
  6109. "gameTransactionNumber": "2985120",
  6110. "couponType": true,
  6111. "drawWinDetails": [
  6112. {
  6113. "lottoNumber": 0,
  6114. "bonusTickets": 0,
  6115. "drawDate": "2012-01-01+13:00",
  6116. "drawStatus": "Active",
  6117. "winAmount": 0,
  6118. "winningFlag": false,
  6119. "drawTicketStatus": "PURCH",
  6120. "megaDipType": false,
  6121. "drawNumber": 1,
  6122. "lottoLuckyDip": false,
  6123. "lottoPowerDip": false,
  6124. "lottoTripleDip": false
  6125. },
  6126. {
  6127. "lottoNumber": 0,
  6128. "bonusTickets": 0,
  6129. "drawDate": "2012-01-02+13:00",
  6130. "drawStatus": "Announced",
  6131. "winAmount": 0,
  6132. "winningFlag": false,
  6133. "drawTicketStatus": "PURCH",
  6134. "megaDipType": false,
  6135. "drawNumber": 2,
  6136. "lottoLuckyDip": false,
  6137. "lottoPowerDip": false,
  6138. "lottoTripleDip": false
  6139. }
  6140. ],
  6141. "play3WagerDetails": [
  6142. {
  6143. "play3Boards": [
  6144. {
  6145. "play3BoardAmount": 1,
  6146. "play3PlayType": "Any",
  6147. "numbers": [
  6148. 0,
  6149. 6,
  6150. 3
  6151. ]
  6152. },
  6153. {
  6154. "play3BoardAmount": 2,
  6155. "play3PlayType": "ExactPairs",
  6156. "numbers": [
  6157. 5,
  6158. 6,
  6159. 5
  6160. ]
  6161. }
  6162. ]
  6163. }
  6164. ],
  6165. "promoTicketReturned": false,
  6166. "startDraw": 1,
  6167. "ticketMessage": "PLAY3 TICKET MSG"
  6168. }
  6169. }
  6170. ]
  6171. }
  6172. "400":
  6173. body:
  6174. application/json:
  6175. schema: simpleResponse
  6176. example: |
  6177. {
  6178. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6179. }
  6180. "500":
  6181. body:
  6182. application/json:
  6183. schema: simpleResponse
  6184. example: |
  6185. {
  6186. "message": "Runtime Exception - Contact Administrator"
  6187. }
  6188. is: [error-responses, header-userid-sessionid-params]
  6189. /tickets:
  6190. /{ticketnumber}:
  6191. uriParameters:
  6192. ticketnumber:
  6193. displayName: ticketnumber
  6194. type: string
  6195. required: true
  6196. repeat: false
  6197. get:
  6198. description: Returns the Ticket detailes for a specific ticketNumber
  6199. headers:
  6200. ESI_SID:
  6201. description: The ESi Session Id
  6202. type: string
  6203. required: true
  6204. repeat: false
  6205. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6206. USER_ID:
  6207. description: Esi User Id
  6208. type: string
  6209. required: true
  6210. repeat: false
  6211. example: "100980037"
  6212. responses:
  6213. "200":
  6214. body:
  6215. application/json:
  6216. schema: ticketDetailsOutput
  6217. example: |
  6218. {
  6219. "gameName": "Lotto Powerball",
  6220. "numberOfBoards": 8,
  6221. "numberOfDraws": 1,
  6222. "systemNumber": 0,
  6223. "wagerAmount": 9.6,
  6224. "ticketNumber": "19351562",
  6225. "ticketType": "Starter Lucky Dip",
  6226. "purchaseDate": "2015-12-03+13:00",
  6227. "ticketStatus": "OPEN",
  6228. "gameTransactionNumber": "2976047",
  6229. "couponType": false,
  6230. "drawWinDetails": {
  6231. "lottoNumber": 0,
  6232. "bonusTickets": 0,
  6233. "drawDate": "2012-10-06+13:00",
  6234. "drawStatus": "Active",
  6235. "winAmount": 0.0,
  6236. "winningFlag": false,
  6237. "drawTicketStatus": "PURCH",
  6238. "megaDipType": false,
  6239. "drawNumber": 1156,
  6240. "lottoLuckyDip": false,
  6241. "lottoPowerDip": false,
  6242. "lottoTripleDip": false,
  6243. "winningNumbersSet": [
  6244. {
  6245. "winningNumbers": [
  6246. {
  6247. "individualWinningNumber": 1
  6248. },
  6249. {
  6250. "individualWinningNumber": 2
  6251. },
  6252. {
  6253. "individualWinningNumber": 3
  6254. },
  6255. {
  6256. "individualWinningNumber": 4
  6257. },
  6258. {
  6259. "individualWinningNumber": 5
  6260. },
  6261. {
  6262. "individualWinningNumber": 6
  6263. }
  6264. ],
  6265. "winningPowerballNumber": 7
  6266. }
  6267. ]
  6268. },
  6269. "lottoWagerDetails": {
  6270. "lottoLuckyDip": true,
  6271. "lottoPowerDip": false,
  6272. "lottoTripleDip": false,
  6273. "starterDipType": true,
  6274. "basicDipType": false,
  6275. "superDipType": false,
  6276. "superPlusDipType": false,
  6277. "megaDipType": false,
  6278. "mega24DipType": false,
  6279. "lottoBoard": [
  6280. {
  6281. "powerballNumber": 9,
  6282. "numbers": [ 4, 7, 10, 30, 36, 38 ]
  6283. },
  6284. {
  6285. "powerballNumber": 4,
  6286. "numbers": [ 15, 19, 22, 26, 31, 35 ]
  6287. },
  6288. {
  6289. "powerballNumber": 3,
  6290. "numbers": [ 1, 11, 23, 24, 25, 33 ]
  6291. },
  6292. {
  6293. "powerballNumber": 7,
  6294. "lottoNumbersPicked": [ 2, 3, 5, 12, 17, 29 ]
  6295. },
  6296. {
  6297. "powerballNumber": 10,
  6298. "lottoNumbersPicked": [ 1, 3, 6, 7, 18, 27 ]
  6299. },
  6300. {
  6301. "powerballNumber": 4,
  6302. "lottoNumbersPicked": [ 9, 20, 29, 30, 36, 37 ]
  6303. },
  6304. {
  6305. "powerballNumber": 7,
  6306. "lottoNumbersPicked": [ 4, 13, 16, 22, 33, 39 ]
  6307. },
  6308. {
  6309. "powerballNumber": 5,
  6310. "lottoNumbersPicked": [ 2, 10, 15, 21, 34, 38 ]
  6311. }
  6312. ],
  6313. "drawDays": [
  6314. "Sat",
  6315. "Wed"
  6316. ]
  6317. },
  6318. "promoTicketReturned": false,
  6319. "startDraw": 1156,
  6320. "ticketName": "Lucky Dip"
  6321. }
  6322. "400":
  6323. body:
  6324. application/json:
  6325. schema: simpleResponse
  6326. example: |
  6327. {
  6328. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6329. }
  6330. "500":
  6331. body:
  6332. application/json:
  6333. schema: simpleResponse
  6334. example: |
  6335. {
  6336. "message": "Runtime Exception - Contact Administrator"
  6337. }
  6338. is: [error-responses, header-userid-sessionid-params]
  6339. /validations:
  6340. post:
  6341. description: validates a ticket and returns the winoutcome (Fastvalidation). Fastvalidation is only possible during the period where the draw is closed but the ticket is not validated yet.
  6342. headers:
  6343. ESI_SID:
  6344. description: The ESi Session Id
  6345. type: string
  6346. required: true
  6347. repeat: false
  6348. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6349. USER_ID:
  6350. description: Esi User Id
  6351. type: string
  6352. required: true
  6353. repeat: false
  6354. example: "100980037"
  6355. body:
  6356. application/json:
  6357. schema: fastValidateInput
  6358. example: |
  6359. {
  6360. "drawId": 1384
  6361. }
  6362. responses:
  6363. "200":
  6364. body:
  6365. application/json:
  6366. schema: fastValidateOutput
  6367. example: |
  6368. {
  6369. "drawID": 1384,
  6370. "ticketNumber": "5433455343"
  6371. }
  6372. "400":
  6373. body:
  6374. application/json:
  6375. schema: simpleResponse
  6376. example: |
  6377. {
  6378. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6379. }
  6380. "500":
  6381. body:
  6382. application/json:
  6383. schema: simpleResponse
  6384. example: |
  6385. {
  6386. "message": "Runtime Exception - Contact Administrator"
  6387. }
  6388. is: [error-responses, header-userid-sessionid-params]
  6389. /instanttickets:
  6390. /{ticketserial}:
  6391. uriParameters:
  6392. ticketserial:
  6393. displayName: ticketserial
  6394. type: string
  6395. required: true
  6396. repeat: false
  6397. get:
  6398. description: Command to allow to attempt to inquiry a purchased ticket. User doesn’t have tobe logged in and ticket could be non ESI. See Apendix F for detailed list of all possible results.
  6399. queryParameters:
  6400. checkdigits:
  6401. description: check digits located on printed tickets. Integer numbers, might be separated with '-'
  6402. type: string
  6403. required: true
  6404. repeat: false
  6405. channelid:
  6406. description: by default 1, use 1 for Desktop and 2 mobile
  6407. type: integer
  6408. required: true
  6409. repeat: false
  6410. responses:
  6411. "200":
  6412. body:
  6413. application/json:
  6414. schema: validationInquiryInstantOutput
  6415. example: |
  6416. {
  6417. "amount": 25.8,
  6418. "resultText": "Prize payable"
  6419. }
  6420. "400":
  6421. body:
  6422. application/json:
  6423. schema: simpleResponse
  6424. example: |
  6425. {
  6426. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6427. }
  6428. "500":
  6429. body:
  6430. application/json:
  6431. schema: simpleResponse
  6432. example: |
  6433. {
  6434. "message": "Runtime Exception - Contact Administrator"
  6435. }
  6436. is: [error-responses]
  6437. /onlinetickets:
  6438. /{ticketserial}:
  6439. uriParameters:
  6440. ticketserial:
  6441. displayName: ticketserial
  6442. type: string
  6443. required: true
  6444. repeat: false
  6445. get:
  6446. description: Command to allow to attempt to inquiry a purchased ticket. User doesn’t have tobe logged in and ticket could be non ESI. Please see appendix E for detailed list of results.
  6447. queryParameters:
  6448. channelid:
  6449. description: by default 1, use 1 for Desktop and 2 mobile
  6450. type: integer
  6451. required: true
  6452. repeat: false
  6453. responses:
  6454. "200":
  6455. body:
  6456. application/json:
  6457. schema: validationInquiryOnlineOutput
  6458. example: |
  6459. {
  6460. "cashAmount": 25.8,
  6461. "claimAmount": 25.8,
  6462. "resultText": "Prize payable"
  6463. }
  6464. "400":
  6465. body:
  6466. application/json:
  6467. schema: simpleResponse
  6468. example: |
  6469. {
  6470. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6471. }
  6472. "500":
  6473. body:
  6474. application/json:
  6475. schema: simpleResponse
  6476. example: |
  6477. {
  6478. "message": "Runtime Exception - Contact Administrator"
  6479. }
  6480. is: [error-responses]
  6481. /favourites:
  6482. displayName: favourites
  6483. description: A favourite is a basic wager and can be of any game type
  6484. /{userid}:
  6485. description: Returns a collection of favourites for a specific user
  6486. uriParameters:
  6487. userid:
  6488. displayName: userid
  6489. type: string
  6490. required: true
  6491. repeat: false
  6492. get:
  6493. description: Get a list of favourites for a specific user
  6494. headers:
  6495. ESI_SID:
  6496. description: The ESi Session Id
  6497. type: string
  6498. required: true
  6499. repeat: false
  6500. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6501. USER_ID:
  6502. description: Esi User Id
  6503. type: string
  6504. required: true
  6505. repeat: false
  6506. example: "100980037"
  6507. queryParameters:
  6508. favouriteid:
  6509. description: Id of favourite
  6510. type: string
  6511. required: false
  6512. repeat: false
  6513. favouritename:
  6514. description: The name of the favourite
  6515. type: string
  6516. required: false
  6517. repeat: false
  6518. lotto:
  6519. description: Return favourites for the Lotto game
  6520. type: boolean
  6521. required: false
  6522. repeat: false
  6523. default: "true"
  6524. example: "true"
  6525. keno:
  6526. description: Return favourites for the Keno game
  6527. type: boolean
  6528. required: false
  6529. repeat: false
  6530. default: "false"
  6531. example: "true"
  6532. strikeCategory:
  6533. description: Return favourites for the Strike game
  6534. type: boolean
  6535. required: false
  6536. repeat: false
  6537. default: "true"
  6538. example: "true"
  6539. bullseye:
  6540. description: Return favourites for the Bullseye game
  6541. type: boolean
  6542. required: false
  6543. repeat: false
  6544. default: "false"
  6545. example: "true"
  6546. play3:
  6547. description: Return tickets for the Play3 game
  6548. type: boolean
  6549. required: false
  6550. repeat: false
  6551. default: "false"
  6552. example: "true"
  6553. responses:
  6554. "200":
  6555. body:
  6556. application/json:
  6557. schema: listFavouriteOutput
  6558. example: |
  6559. {
  6560. "favourites": [
  6561. {
  6562. "favouriteName": "bullseyeFav",
  6563. "sequenceId": 1,
  6564. "gameName": "Bullseye",
  6565. "numberOfBoards": 2,
  6566. "numberOfDraws": 1,
  6567. "systemNumber": 0,
  6568. "numberStrikeBoards": 0,
  6569. "numberPowerballBoards": 0,
  6570. "bullseyeBoardDetails": [
  6571. {
  6572. "numbers": [ 7, 5, 6, 5, 6, 0 ]
  6573. },
  6574. {
  6575. "numbers": [ 0, 1, 6, 7, 4, 1 ]
  6576. }
  6577. ]
  6578. },
  6579. {
  6580. "favouriteName": "qwe123",
  6581. "sequenceId": 1,
  6582. "gameName": "Lotto Powerball",
  6583. "numberOfBoards": 4,
  6584. "numberOfDraws": 0,
  6585. "systemNumber": 0,
  6586. "numberStrikeBoards": 0,
  6587. "numberPowerballBoards": 4,
  6588. "lottoBoard": [
  6589. {
  6590. "powerballNumber": 2,
  6591. "numbers": [ 3, 5, 14, 21, 27, 32 ]
  6592. },
  6593. {
  6594. "powerballNumber": 3,
  6595. "numbers": [ 2, 12, 13, 22, 24, 33 ]
  6596. },
  6597. {
  6598. "powerballNumber": 6,
  6599. "numbers": [ 25, 28, 32, 34, 39, 40 ]
  6600. },
  6601. {
  6602. "powerballNumber": 3,
  6603. "numbers": [ 11, 12, 17, 23, 32, 34 ]
  6604. }
  6605. ]
  6606. },
  6607. {
  6608. "favouriteName": "qwe123",
  6609. "sequenceId": 2,
  6610. "gameName": "Lotto Strike",
  6611. "numberOfBoards": 4,
  6612. "numberOfDraws": 0,
  6613. "systemNumber": 0,
  6614. "numberStrikeBoards": 4,
  6615. "numberPowerballBoards": 0,
  6616. "strikeBoard": [
  6617. {
  6618. "numbers": [ 39, 16, 14, 6 ]
  6619. },
  6620. {
  6621. "numbers": [ 26, 33, 9, 23 ]
  6622. },
  6623. {
  6624. "numbers": [ 40, 18, 4, 11 ]
  6625. },
  6626. {
  6627. "numbers": [ 37, 15, 18, 4 ]
  6628. }
  6629. ]
  6630. }
  6631. ]
  6632. }
  6633. "400":
  6634. body:
  6635. application/json:
  6636. schema: simpleResponse
  6637. example: |
  6638. {
  6639. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6640. }
  6641. "500":
  6642. body:
  6643. application/json:
  6644. schema: simpleResponse
  6645. example: |
  6646. {
  6647. "message": "Runtime Exception - Contact Administrator"
  6648. }
  6649. is: [error-responses, header-userid-sessionid-params]
  6650. post:
  6651. description: Save a new favourite. Command to save a recently purchased wager as a favourite play for the logged in player.
  6652. headers:
  6653. ESI_SID:
  6654. description: The ESi Session Id
  6655. type: string
  6656. required: true
  6657. repeat: false
  6658. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6659. USER_ID:
  6660. description: Esi User Id
  6661. type: string
  6662. required: true
  6663. repeat: false
  6664. example: "100980037"
  6665. body:
  6666. application/json:
  6667. schema: saveFavouriteInput
  6668. example: |
  6669. {
  6670. "favouriteName": "qwe123",
  6671. "sequenceId": 1,
  6672. "gameName": "Lotto Powerball",
  6673. "numberOfBoards": 4,
  6674. "numberOfDraws": 1,
  6675. "numberStrikeBoards": 0,
  6676. "lottoBoard": [
  6677. {
  6678. "powerballNumber": 2,
  6679. "numbers": [ 3, 5, 14, 21, 27, 32 ]
  6680. },
  6681. {
  6682. "powerballNumber": 3,
  6683. "numbers": [ 2, 12, 13, 22, 24, 33 ]
  6684. },
  6685. {
  6686. "powerballNumber": 6,
  6687. "numbers": [ 25, 28, 32, 34, 39, 40 ]
  6688. },
  6689. {
  6690. "powerballNumber": 3,
  6691. "numbers": [ 11, 12, 17, 23, 32, 34 ]
  6692. }
  6693. ]
  6694. }
  6695. responses:
  6696. "200":
  6697. body:
  6698. application/json:
  6699. schema: simpleResponse
  6700. example: |
  6701. {
  6702. "message": "success"
  6703. }
  6704. "400":
  6705. body:
  6706. application/json:
  6707. schema: simpleResponse
  6708. example: |
  6709. {
  6710. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6711. }
  6712. "500":
  6713. body:
  6714. application/json:
  6715. schema: simpleResponse
  6716. example: |
  6717. {
  6718. "message": "Runtime Exception - Contact Administrator"
  6719. }
  6720. is: [error-responses, header-userid-sessionid-params]
  6721. /{favouritename}:
  6722. uriParameters:
  6723. favouritename:
  6724. displayName: favouritename
  6725. type: string
  6726. required: true
  6727. repeat: false
  6728. put:
  6729. description: Edit a favourite. Name has to be unique. Restricted by Gaming System.
  6730. headers:
  6731. ESI_SID:
  6732. description: The ESi Session Id
  6733. type: string
  6734. required: true
  6735. repeat: false
  6736. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6737. USER_ID:
  6738. description: Esi User Id
  6739. type: string
  6740. required: true
  6741. repeat: false
  6742. example: "100980037"
  6743. body:
  6744. application/json:
  6745. schema: editFavouriteInput
  6746. example: |
  6747. {
  6748. "sequenceId": 1,
  6749. "gameName": "Lotto Powerball",
  6750. "numberOfBoards": 4,
  6751. "numberOfDraws": 1,
  6752. "numberStrikeBoards": 0,
  6753. "lottoBoard": [
  6754. {
  6755. "powerballNumber": 2,
  6756. "numbers": [ 3, 5, 14, 21, 27, 32 ]
  6757. },
  6758. {
  6759. "powerballNumber": 3,
  6760. "numbers": [ 2, 12, 13, 22, 24, 33 ]
  6761. },
  6762. {
  6763. "powerballNumber": 6,
  6764. "numbers": [ 25, 28, 32, 34, 39, 40 ]
  6765. },
  6766. {
  6767. "powerballNumber": 3,
  6768. "numbers": [ 11, 12, 17, 23, 32, 34 ]
  6769. }
  6770. ]
  6771. }
  6772. responses:
  6773. "200":
  6774. body:
  6775. application/json:
  6776. schema: simpleResponse
  6777. example: |
  6778. {
  6779. "message": "success"
  6780. }
  6781. "400":
  6782. body:
  6783. application/json:
  6784. schema: simpleResponse
  6785. example: |
  6786. {
  6787. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6788. }
  6789. "500":
  6790. body:
  6791. application/json:
  6792. schema: simpleResponse
  6793. example: |
  6794. {
  6795. "message": "Runtime Exception - Contact Administrator"
  6796. }
  6797. is: [error-responses, header-userid-sessionid-params]
  6798. delete:
  6799. description: Delete a Favourite by name for a user
  6800. headers:
  6801. ESI_SID:
  6802. description: The ESi Session Id
  6803. type: string
  6804. required: true
  6805. repeat: false
  6806. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6807. USER_ID:
  6808. description: Esi User Id
  6809. type: string
  6810. required: true
  6811. repeat: false
  6812. example: "100980037"
  6813. queryParameters:
  6814. gamename:
  6815. description: Game name for which favourite play is configured
  6816. type: string
  6817. required: true
  6818. repeat: false
  6819. default: Bullseye
  6820. example: Bullseye
  6821. sequenceid:
  6822. description: Sequence ID of favourite play
  6823. type: integer
  6824. required: true
  6825. repeat: false
  6826. default: "1"
  6827. example: "1"
  6828. favouriteid:
  6829. description: Favourite ID
  6830. type: string
  6831. required: false
  6832. repeat: false
  6833. default: "123"
  6834. example: "123"
  6835. responses:
  6836. "200":
  6837. body:
  6838. application/json:
  6839. schema: simpleResponse
  6840. example: |
  6841. {
  6842. "message": "success"
  6843. }
  6844. "400":
  6845. body:
  6846. application/json:
  6847. schema: simpleResponse
  6848. example: |
  6849. {
  6850. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6851. }
  6852. "500":
  6853. body:
  6854. application/json:
  6855. schema: simpleResponse
  6856. example: |
  6857. {
  6858. "message": "Runtime Exception - Contact Administrator"
  6859. }
  6860. is: [error-responses, header-userid-sessionid-params]
  6861. /wallets:
  6862. displayName: wallets
  6863. description: A wallet is the result of transactions and billings from the payment provider and the ESi Back End
  6864. /{userid}:
  6865. uriParameters:
  6866. userid:
  6867. displayName: userid
  6868. type: string
  6869. required: true
  6870. repeat: false
  6871. get:
  6872. description: Load wallet details of given user
  6873. headers:
  6874. ESI_SID:
  6875. description: The ESi Session Id
  6876. type: string
  6877. required: true
  6878. repeat: false
  6879. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6880. USER_ID:
  6881. description: Esi User Id
  6882. type: string
  6883. required: true
  6884. repeat: false
  6885. example: "100980037"
  6886. responses:
  6887. "200":
  6888. body:
  6889. application/json:
  6890. schema: loadWalletOutput
  6891. example: |
  6892. {
  6893. "truncatedCardNumber": "411111........11",
  6894. "expirationDate": "1020",
  6895. "walletStatus": 0,
  6896. "weeklyTransferredAmount": 10.0,
  6897. "weeklyTransferredCount": 1.0
  6898. }
  6899. "400":
  6900. body:
  6901. application/json:
  6902. schema: simpleResponse
  6903. example: |
  6904. {
  6905. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6906. }
  6907. "500":
  6908. body:
  6909. application/json:
  6910. schema: simpleResponse
  6911. example: |
  6912. {
  6913. "message": "Runtime Exception - Contact Administrator"
  6914. }
  6915. is: [error-responses, header-userid-sessionid-params]
  6916. /banktransfers:
  6917. post:
  6918. description: Removes balance from the users wallet (withdrawal)
  6919. headers:
  6920. ESI_SID:
  6921. description: The ESi Session Id
  6922. type: string
  6923. required: true
  6924. repeat: false
  6925. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6926. USER_ID:
  6927. description: Esi User Id
  6928. type: string
  6929. required: true
  6930. repeat: false
  6931. example: "100980037"
  6932. body:
  6933. application/json:
  6934. schema: unloadWalletInput
  6935. example: |
  6936. {
  6937. "transferAmount": 10.0,
  6938. "password": "test123"
  6939. }
  6940. responses:
  6941. "200":
  6942. body:
  6943. application/json:
  6944. schema: unloadWalletOutput
  6945. example: |
  6946. {
  6947. "walletStatus": 0,
  6948. "walletBalance": 50.0
  6949. }
  6950. "400":
  6951. body:
  6952. application/json:
  6953. schema: simpleResponse
  6954. example: |
  6955. {
  6956. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  6957. }
  6958. "500":
  6959. body:
  6960. application/json:
  6961. schema: simpleResponse
  6962. example: |
  6963. {
  6964. "message": "Runtime Exception - Contact Administrator"
  6965. }
  6966. is: [error-responses, header-userid-sessionid-params]
  6967. /topups:
  6968. post:
  6969. description: Register a new Credit Card
  6970. headers:
  6971. ESI_SID:
  6972. description: The ESi Session Id
  6973. type: string
  6974. required: true
  6975. repeat: false
  6976. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  6977. USER_ID:
  6978. description: Esi User Id
  6979. type: string
  6980. required: true
  6981. repeat: false
  6982. example: "100980037"
  6983. body:
  6984. application/json:
  6985. schema: loadWalletConfirmInput
  6986. example: |
  6987. {
  6988. "transactionId": "000003006022096500a849a2f68f4343"
  6989. }
  6990. responses:
  6991. "200":
  6992. body:
  6993. application/json:
  6994. schema: simpleResponse
  6995. example: |
  6996. {
  6997. "message": "success"
  6998. }
  6999. "400":
  7000. body:
  7001. application/json:
  7002. schema: simpleResponse
  7003. example: |
  7004. {
  7005. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7006. }
  7007. "500":
  7008. body:
  7009. application/json:
  7010. schema: simpleResponse
  7011. example: |
  7012. {
  7013. "message": "Runtime Exception - Contact Administrator"
  7014. }
  7015. is: [error-responses, header-userid-sessionid-params]
  7016. put:
  7017. description: Top up with registered Credit Card
  7018. headers:
  7019. ESI_SID:
  7020. description: The ESi Session Id
  7021. type: string
  7022. required: true
  7023. repeat: false
  7024. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  7025. USER_ID:
  7026. description: Esi User Id
  7027. type: string
  7028. required: true
  7029. repeat: false
  7030. example: "100980037"
  7031. body:
  7032. application/json:
  7033. schema: loadWalletUpdateInput
  7034. example: |
  7035. {
  7036. "amount": 15.00,
  7037. "cvc": 192,
  7038. "password": "password1"
  7039. }
  7040. responses:
  7041. "200":
  7042. body:
  7043. application/json:
  7044. schema: loadWalletConfirmOutput
  7045. example: |
  7046. {
  7047. "walletBalance" : 60
  7048. }
  7049. "400":
  7050. body:
  7051. application/json:
  7052. schema: simpleResponse
  7053. example: |
  7054. {
  7055. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7056. }
  7057. "500":
  7058. body:
  7059. application/json:
  7060. schema: simpleResponse
  7061. example: |
  7062. {
  7063. "message": "Runtime Exception - Contact Administrator"
  7064. }
  7065. is: [error-responses, header-userid-sessionid-params]
  7066. /validations:
  7067. post:
  7068. description: Verify payment details and generate a new DPS billing ID.
  7069. headers:
  7070. ESI_SID:
  7071. description: The ESi Session Id
  7072. type: string
  7073. required: true
  7074. repeat: false
  7075. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  7076. USER_ID:
  7077. description: Esi User Id
  7078. type: string
  7079. required: true
  7080. repeat: false
  7081. example: "100980037"
  7082. body:
  7083. application/json:
  7084. schema: loadWalletValidateInput
  7085. example: |
  7086. {
  7087. "password" : "test123",
  7088. "returnUrl": "http://test.com"
  7089. }
  7090. responses:
  7091. "200":
  7092. body:
  7093. application/json:
  7094. schema: loadWalletValidateOutput
  7095. example: |
  7096. {
  7097. "transactionId": "0000030021996668"
  7098. }
  7099. "400":
  7100. body:
  7101. application/json:
  7102. schema: simpleResponse
  7103. example: |
  7104. {
  7105. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7106. }
  7107. "500":
  7108. body:
  7109. application/json:
  7110. schema: simpleResponse
  7111. example: |
  7112. {
  7113. "message": "Runtime Exception - Contact Administrator"
  7114. }
  7115. is: [error-responses, header-userid-sessionid-params]
  7116. /systems:
  7117. displayName: systems
  7118. description: System wide operations not related to a specific user
  7119. /areacodes:
  7120. get:
  7121. description: Returns TLA Area unique codes and list of TLA location unique codes associated with each area.
  7122. responses:
  7123. "200":
  7124. body:
  7125. application/json:
  7126. schema: TlaAreaLocationOutput
  7127. example: |
  7128. {
  7129. "tlaAreaLocationList": [
  7130. {
  7131. "tlaAreaCode": "2",
  7132. "tlaAreaDescription": "Auckland",
  7133. "tlaLocationList": [
  7134. {
  7135. "tlaLocationCode": "7",
  7136. "tlaLocationDescription": "Auckland City"
  7137. },
  7138. {
  7139. "tlaLocationCode": "10",
  7140. "tlaLocationDescription": "Franklin"
  7141. },
  7142. {
  7143. "tlaLocationCode": "8",
  7144. "tlaLocationDescription": "Manukau"
  7145. },
  7146. {
  7147. "tlaLocationCode": "5",
  7148. "tlaLocationDescription": "North Shore"
  7149. },
  7150. {
  7151. "tlaLocationCode": "9",
  7152. "tlaLocationDescription": "Papakura"
  7153. },
  7154. {
  7155. "tlaLocationCode": "4",
  7156. "tlaLocationDescription": "Rodney"
  7157. },
  7158. {
  7159. "tlaLocationCode": "6",
  7160. "tlaLocationDescription": "Waitakere"
  7161. }
  7162. ]
  7163. },
  7164. {
  7165. "tlaAreaCode": "4",
  7166. "tlaAreaDescription": "Bay of Plenty",
  7167. "tlaLocationList": [
  7168. {
  7169. "tlaLocationCode": "25",
  7170. "tlaLocationDescription": "Kawerau"
  7171. },
  7172. {
  7173. "tlaLocationCode": "26",
  7174. "tlaLocationDescription": "Opotiki"
  7175. },
  7176. {
  7177. "tlaLocationCode": "21",
  7178. "tlaLocationDescription": "Rotorua"
  7179. },
  7180. {
  7181. "tlaLocationCode": "20",
  7182. "tlaLocationDescription": "Taupo"
  7183. },
  7184. {
  7185. "tlaLocationCode": "23",
  7186. "tlaLocationDescription": "Tauranga"
  7187. },
  7188. {
  7189. "tlaLocationCode": "22",
  7190. "tlaLocationDescription": "Western B.O.P"
  7191. },
  7192. {
  7193. "tlaLocationCode": "24",
  7194. "tlaLocationDescription": "Whakatane"
  7195. }
  7196. ]
  7197. },
  7198. {
  7199. "tlaAreaCode": "13",
  7200. "tlaAreaDescription": "Canterbury",
  7201. "tlaLocationList": [
  7202. {
  7203. "tlaLocationCode": "61",
  7204. "tlaLocationDescription": "Ashburton"
  7205. },
  7206. {
  7207. "tlaLocationCode": "59",
  7208. "tlaLocationDescription": "Banks Peninsula"
  7209. },
  7210. {
  7211. "tlaLocationCode": "58",
  7212. "tlaLocationDescription": "Christchurch City"
  7213. },
  7214. {
  7215. "tlaLocationCode": "56",
  7216. "tlaLocationDescription": "Huranui"
  7217. },
  7218. {
  7219. "tlaLocationCode": "55",
  7220. "tlaLocationDescription": "Kaikoura"
  7221. },
  7222. {
  7223. "tlaLocationCode": "63",
  7224. "tlaLocationDescription": "Mackenzie"
  7225. },
  7226. {
  7227. "tlaLocationCode": "60",
  7228. "tlaLocationDescription": "Selwyn"
  7229. },
  7230. {
  7231. "tlaLocationCode": "62",
  7232. "tlaLocationDescription": "Timaru"
  7233. },
  7234. {
  7235. "tlaLocationCode": "57",
  7236. "tlaLocationDescription": "Waimakariri"
  7237. },
  7238. {
  7239. "tlaLocationCode": "64",
  7240. "tlaLocationDescription": "Waimate"
  7241. },
  7242. {
  7243. "tlaLocationCode": "65",
  7244. "tlaLocationDescription": "Waitaki"
  7245. }
  7246. ]
  7247. },
  7248. {
  7249. "tlaAreaCode": "17",
  7250. "tlaAreaDescription": "Chatham Islands",
  7251. "tlaLocationList": {
  7252. "tlaLocationCode": "74",
  7253. "tlaLocationDescription": "Chatham Islands"
  7254. }
  7255. },
  7256. {
  7257. "tlaAreaCode": "5",
  7258. "tlaAreaDescription": "Gisborne",
  7259. "tlaLocationList": {
  7260. "tlaLocationCode": "27",
  7261. "tlaLocationDescription": "Gisborne"
  7262. }
  7263. },
  7264. {
  7265. "tlaAreaCode": "6",
  7266. "tlaAreaDescription": "Hawkes Bay",
  7267. "tlaLocationList": [
  7268. {
  7269. "tlaLocationCode": "31",
  7270. "tlaLocationDescription": "Central Hawkes Bay"
  7271. },
  7272. {
  7273. "tlaLocationCode": "29",
  7274. "tlaLocationDescription": "Hastings"
  7275. },
  7276. {
  7277. "tlaLocationCode": "30",
  7278. "tlaLocationDescription": "Napier"
  7279. },
  7280. {
  7281. "tlaLocationCode": "32",
  7282. "tlaLocationDescription": "Rangitikei"
  7283. },
  7284. {
  7285. "tlaLocationCode": "20",
  7286. "tlaLocationDescription": "Taupo"
  7287. },
  7288. {
  7289. "tlaLocationCode": "28",
  7290. "tlaLocationDescription": "Wairoa"
  7291. }
  7292. ]
  7293. },
  7294. {
  7295. "tlaAreaCode": "8",
  7296. "tlaAreaDescription": "Manawatu - Wanganui",
  7297. "tlaLocationList": [
  7298. {
  7299. "tlaLocationCode": "41",
  7300. "tlaLocationDescription": "Horowhenua"
  7301. },
  7302. {
  7303. "tlaLocationCode": "38",
  7304. "tlaLocationDescription": "Manawatu"
  7305. },
  7306. {
  7307. "tlaLocationCode": "39",
  7308. "tlaLocationDescription": "Palmerston North"
  7309. },
  7310. {
  7311. "tlaLocationCode": "32",
  7312. "tlaLocationDescription": "Rangitikei"
  7313. },
  7314. {
  7315. "tlaLocationCode": "34",
  7316. "tlaLocationDescription": "Stratford"
  7317. },
  7318. {
  7319. "tlaLocationCode": "40",
  7320. "tlaLocationDescription": "Tararua"
  7321. },
  7322. {
  7323. "tlaLocationCode": "20",
  7324. "tlaLocationDescription": "Taupo"
  7325. },
  7326. {
  7327. "tlaLocationCode": "19",
  7328. "tlaLocationDescription": "Waitomo"
  7329. },
  7330. {
  7331. "tlaLocationCode": "37",
  7332. "tlaLocationDescription": "Wanganui"
  7333. }
  7334. ]
  7335. },
  7336. {
  7337. "tlaAreaCode": "11",
  7338. "tlaAreaDescription": "Marlborough",
  7339. "tlaLocationList": {
  7340. "tlaLocationCode": "51",
  7341. "tlaLocationDescription": "Marlborough"
  7342. }
  7343. },
  7344. {
  7345. "tlaAreaCode": "14",
  7346. "tlaAreaDescription": "Nelson",
  7347. "tlaLocationList": {
  7348. "tlaLocationCode": "66",
  7349. "tlaLocationDescription": "Nelson City"
  7350. }
  7351. },
  7352. {
  7353. "tlaAreaCode": "1",
  7354. "tlaAreaDescription": "Northland",
  7355. "tlaLocationList": [
  7356. {
  7357. "tlaLocationCode": "1",
  7358. "tlaLocationDescription": "Far North"
  7359. },
  7360. {
  7361. "tlaLocationCode": "3",
  7362. "tlaLocationDescription": "Kaipara"
  7363. },
  7364. {
  7365. "tlaLocationCode": "2",
  7366. "tlaLocationDescription": "Whangarei"
  7367. }
  7368. ]
  7369. },
  7370. {
  7371. "tlaAreaCode": "15",
  7372. "tlaAreaDescription": "Otago",
  7373. "tlaLocationList": [
  7374. {
  7375. "tlaLocationCode": "67",
  7376. "tlaLocationDescription": "Central Otago"
  7377. },
  7378. {
  7379. "tlaLocationCode": "70",
  7380. "tlaLocationDescription": "Clutha"
  7381. },
  7382. {
  7383. "tlaLocationCode": "69",
  7384. "tlaLocationDescription": "Dunedin City"
  7385. },
  7386. {
  7387. "tlaLocationCode": "68",
  7388. "tlaLocationDescription": "Queenstown Lakes"
  7389. },
  7390. {
  7391. "tlaLocationCode": "65",
  7392. "tlaLocationDescription": "Waitaki"
  7393. }
  7394. ]
  7395. },
  7396. {
  7397. "tlaAreaCode": "16",
  7398. "tlaAreaDescription": "Southland",
  7399. "tlaLocationList": [
  7400. {
  7401. "tlaLocationCode": "72",
  7402. "tlaLocationDescription": "Gore"
  7403. },
  7404. {
  7405. "tlaLocationCode": "73",
  7406. "tlaLocationDescription": "Invercargill City"
  7407. },
  7408. {
  7409. "tlaLocationCode": "71",
  7410. "tlaLocationDescription": "Southland"
  7411. }
  7412. ]
  7413. },
  7414. {
  7415. "tlaAreaCode": "7",
  7416. "tlaAreaDescription": "Taranaki",
  7417. "tlaLocationList": [
  7418. {
  7419. "tlaLocationCode": "33",
  7420. "tlaLocationDescription": "New Plymouth"
  7421. },
  7422. {
  7423. "tlaLocationCode": "35",
  7424. "tlaLocationDescription": "South Taranaki"
  7425. },
  7426. {
  7427. "tlaLocationCode": "34",
  7428. "tlaLocationDescription": "Stratford"
  7429. }
  7430. ]
  7431. },
  7432. {
  7433. "tlaAreaCode": "10",
  7434. "tlaAreaDescription": "Tasman",
  7435. "tlaLocationList": {
  7436. "tlaLocationCode": "50",
  7437. "tlaLocationDescription": "Tasman"
  7438. }
  7439. },
  7440. {
  7441. "tlaAreaCode": "3",
  7442. "tlaAreaDescription": "Waikato",
  7443. "tlaLocationList": [
  7444. {
  7445. "tlaLocationCode": "10",
  7446. "tlaLocationDescription": "Franklin"
  7447. },
  7448. {
  7449. "tlaLocationCode": "15",
  7450. "tlaLocationDescription": "Hamilton"
  7451. },
  7452. {
  7453. "tlaLocationCode": "12",
  7454. "tlaLocationDescription": "Hauraki"
  7455. },
  7456. {
  7457. "tlaLocationCode": "14",
  7458. "tlaLocationDescription": "Matamata-Piako"
  7459. },
  7460. {
  7461. "tlaLocationCode": "17",
  7462. "tlaLocationDescription": "Otorohanga"
  7463. },
  7464. {
  7465. "tlaLocationCode": "21",
  7466. "tlaLocationDescription": "Rotorua"
  7467. },
  7468. {
  7469. "tlaLocationCode": "18",
  7470. "tlaLocationDescription": "South Waikato"
  7471. },
  7472. {
  7473. "tlaLocationCode": "20",
  7474. "tlaLocationDescription": "Taupo"
  7475. },
  7476. {
  7477. "tlaLocationCode": "11",
  7478. "tlaLocationDescription": "Thames-Coromandel"
  7479. },
  7480. {
  7481. "tlaLocationCode": "13",
  7482. "tlaLocationDescription": "Waikato"
  7483. },
  7484. {
  7485. "tlaLocationCode": "16",
  7486. "tlaLocationDescription": "Waipa"
  7487. },
  7488. {
  7489. "tlaLocationCode": "19",
  7490. "tlaLocationDescription": "Waitomo"
  7491. }
  7492. ]
  7493. },
  7494. {
  7495. "tlaAreaCode": "9",
  7496. "tlaAreaDescription": "Wellington",
  7497. "tlaLocationList": [
  7498. {
  7499. "tlaLocationCode": "48",
  7500. "tlaLocationDescription": "Carterton"
  7501. },
  7502. {
  7503. "tlaLocationCode": "42",
  7504. "tlaLocationDescription": "Kapiti Coast"
  7505. },
  7506. {
  7507. "tlaLocationCode": "45",
  7508. "tlaLocationDescription": "Lower Hutt"
  7509. },
  7510. {
  7511. "tlaLocationCode": "47",
  7512. "tlaLocationDescription": "Masterton"
  7513. },
  7514. {
  7515. "tlaLocationCode": "26",
  7516. "tlaLocationDescription": "Opotiki"
  7517. },
  7518. {
  7519. "tlaLocationCode": "43",
  7520. "tlaLocationDescription": "Porirua"
  7521. },
  7522. {
  7523. "tlaLocationCode": "49",
  7524. "tlaLocationDescription": "South Wairarapa"
  7525. },
  7526. {
  7527. "tlaLocationCode": "40",
  7528. "tlaLocationDescription": "Tararua"
  7529. },
  7530. {
  7531. "tlaLocationCode": "44",
  7532. "tlaLocationDescription": "Upper Hutt"
  7533. },
  7534. {
  7535. "tlaLocationCode": "46",
  7536. "tlaLocationDescription": "Wellington"
  7537. }
  7538. ]
  7539. },
  7540. {
  7541. "tlaAreaCode": "12",
  7542. "tlaAreaDescription": "West Coast",
  7543. "tlaLocationList": [
  7544. {
  7545. "tlaLocationCode": "52",
  7546. "tlaLocationDescription": "Buller"
  7547. },
  7548. {
  7549. "tlaLocationCode": "53",
  7550. "tlaLocationDescription": "Grey"
  7551. },
  7552. {
  7553. "tlaLocationCode": "54",
  7554. "tlaLocationDescription": "Westland"
  7555. }
  7556. ]
  7557. }
  7558. ]
  7559. }
  7560. "400":
  7561. body:
  7562. application/json:
  7563. schema: simpleResponse
  7564. example: |
  7565. {
  7566. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7567. }
  7568. "500":
  7569. body:
  7570. application/json:
  7571. schema: simpleResponse
  7572. example: |
  7573. {
  7574. "message": "Runtime Exception - Contact Administrator"
  7575. }
  7576. is: [error-responses]
  7577. /globals:
  7578. get:
  7579. description: Retrieves configuration parameters loaded and stored in ESIProperties.
  7580. responses:
  7581. "200":
  7582. body:
  7583. application/json:
  7584. schema: loadGlobalOutput
  7585. example: |
  7586. {
  7587. "kenoPricePerBoard": 1.0,
  7588. "lottoPowerballPricePerBoard": 0.6,
  7589. "lottoPricePerBoard": 0.6,
  7590. "strikePricePerBoard": 1.0,
  7591. "systemMonthlyLimit": "300",
  7592. "systemWeeklyLimit": "150",
  7593. "TCCurrentVersion": 8,
  7594. "viewGamingHistoryDefaultNumberDays": 365,
  7595. "viewTransHistoryDefaultNumberDays": 367,
  7596. "walletMaxTransfer": 150.0,
  7597. "walletMinTransfer": 10.0,
  7598. "maxWalletWeeklyTransferAmountTo": 400.0,
  7599. "maxWalletWeeklyTransfersTo": 30,
  7600. "maxWalletWeeklyTransfersFrom": 1000,
  7601. "maxWalletWeeklyTransferAmountFrom": 9999999.0,
  7602. "lottoGameActive": true,
  7603. "kenoGameActive": true,
  7604. "bullseyePricePerBoardFor1Draw": 2.0,
  7605. "bullseyePricePerBoardFor7Draws": 10.0,
  7606. "bullseyePricePerBoardFor14Draws": 20.0,
  7607. "bullseyeGameActive": true,
  7608. "play3PricePerBoard": [
  7609. {
  7610. "key": "Exact",
  7611. "value": 100
  7612. },
  7613. {
  7614. "key": "Any",
  7615. "value": 100
  7616. },
  7617. {
  7618. "key": "Pairs",
  7619. "value": 100
  7620. },
  7621. {
  7622. "key": "ExactAny",
  7623. "value": 200
  7624. },
  7625. {
  7626. "key": "ExactPairs",
  7627. "value": 200
  7628. },
  7629. {
  7630. "key": "ExactAnyPairs",
  7631. "value": 300
  7632. },
  7633. {
  7634. "key": "Combo3",
  7635. "value": 300
  7636. },
  7637. {
  7638. "key": "Combo6",
  7639. "value": 600
  7640. }
  7641. ],
  7642. "play3GameActive": true
  7643. }
  7644. "400":
  7645. body:
  7646. application/json:
  7647. schema: simpleResponse
  7648. example: |
  7649. {
  7650. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7651. }
  7652. "500":
  7653. body:
  7654. application/json:
  7655. schema: simpleResponse
  7656. example: |
  7657. {
  7658. "message": "Runtime Exception - Contact Administrator"
  7659. }
  7660. is: [error-responses]
  7661. /termsandconditions:
  7662. post:
  7663. description: API to indicate to ESi that the player has read, accepted and agreed to the latest terms and conditions. This API will be used for both Login -Terms And conditions as well as Registration – Terms and conditions. If Application number and page id parameters are populated Registration Terms and conditions will be invoked, other wise Login terms and conditions will be invoked.
  7664. body:
  7665. application/json:
  7666. schema: termsAndConditionsInput
  7667. example: |
  7668. {
  7669. "userName": "mule10@test.com",
  7670. "pageId": "1",
  7671. "applicationNumber": "568277630605",
  7672. "userAgreed": true
  7673. }
  7674. responses:
  7675. "200":
  7676. body:
  7677. application/json:
  7678. schema: termsAndConditionsOutput
  7679. example: |
  7680. {
  7681. "userId": "100985018",
  7682. "playerStatus": 2
  7683. }
  7684. "400":
  7685. body:
  7686. application/json:
  7687. schema: simpleResponse
  7688. example: |
  7689. {
  7690. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7691. }
  7692. "500":
  7693. body:
  7694. application/json:
  7695. schema: simpleResponse
  7696. example: |
  7697. {
  7698. "message": "Runtime Exception - Contact Administrator"
  7699. }
  7700. is: [error-responses]
  7701. /versions:
  7702. get:
  7703. description: Get the version of the ESi webService.
  7704. responses:
  7705. "200":
  7706. body:
  7707. application/json:
  7708. schema: versionOutput
  7709. example: |
  7710. {
  7711. "version": "27.0.0",
  7712. }
  7713. "400":
  7714. body:
  7715. application/json:
  7716. schema: simpleResponse
  7717. example: |
  7718. {
  7719. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7720. }
  7721. "500":
  7722. body:
  7723. application/json:
  7724. schema: simpleResponse
  7725. example: |
  7726. {
  7727. "message": "Runtime Exception - Contact Administrator"
  7728. }
  7729. is: [error-responses]
  7730. /transactions:
  7731. displayName: transactions
  7732. description: A transaction is a financial operation associated to a user
  7733. /{userid}:
  7734. uriParameters:
  7735. userid:
  7736. displayName: userid
  7737. type: string
  7738. required: true
  7739. repeat: false
  7740. get:
  7741. description: Retrieve and return the financial transaction history for the logged in player.
  7742. headers:
  7743. ESI_SID:
  7744. description: The ESi Session Id
  7745. type: string
  7746. required: true
  7747. repeat: false
  7748. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  7749. USER_ID:
  7750. description: Esi User Id
  7751. type: string
  7752. required: true
  7753. repeat: false
  7754. example: "100980037"
  7755. queryParameters:
  7756. startdate:
  7757. description: Date to start search from
  7758. type: string
  7759. required: false
  7760. repeat: false
  7761. default: "10/11/2015"
  7762. example: "10/11/2015"
  7763. enddate:
  7764. description: Date to end search on
  7765. type: string
  7766. required: false
  7767. repeat: false
  7768. default: "10/12/2015"
  7769. example: "10/12/2015"
  7770. transactiontype:
  7771. description: Type of financial transaction to search
  7772. type: string
  7773. required: false
  7774. repeat: false
  7775. default: All
  7776. example: All
  7777. responses:
  7778. "200":
  7779. body:
  7780. application/json:
  7781. schema: transHistOutput
  7782. example: |
  7783. {
  7784. "transHistory": [
  7785. {
  7786. "transactionType": "Deposits",
  7787. "amount": 10.0,
  7788. "externalTransactionReference": 8355265007315,
  7789. "transactionDate": "2015-12-03T17:03:24.320+13:00",
  7790. "transactionReference": 22901114,
  7791. "transferAccountNumber": "11",
  7792. "walletBalance": 60.0,
  7793. "description": "Deposit from credit card"
  7794. },
  7795. {
  7796. "transactionType": "WITHDRAWAL",
  7797. "amount": -10.0,
  7798. "externalTransactionReference": 0,
  7799. "transactionDate": "2015-12-03T14:51:12.288+13:00",
  7800. "transactionReference": 22901113,
  7801. "transferAccountNumber": "1200000000000000",
  7802. "walletBalance": 50.0,
  7803. "description": "Withdrawal to bank a/c"
  7804. },
  7805. {
  7806. "transactionType": "Deposits",
  7807. "amount": 10.0,
  7808. "externalTransactionReference": 0,
  7809. "transactionDate": "2015-12-03T14:47:12.009+13:00",
  7810. "transactionReference": 22901112,
  7811. "transferAccountNumber": "11",
  7812. "walletBalance": 60.0,
  7813. "description": "Deposit from credit card"
  7814. },
  7815. {
  7816. "gameName": "Lotto Powerball",
  7817. "ticketNumber": "19351549",
  7818. "ticketType": "Coupon",
  7819. "transactionType": "PURCHASE",
  7820. "amount": -5.8,
  7821. "externalTransactionReference": 0,
  7822. "transactionDate": "2015-12-02T16:17:59.958+13:00",
  7823. "transactionReference": 22901101,
  7824. "walletBalance": 50.0,
  7825. "description": "Purchase Lotto"
  7826. },
  7827. {
  7828. "gameName": "Lotto Powerball",
  7829. "ticketNumber": "19351547",
  7830. "ticketType": "Coupon",
  7831. "transactionType": "PURCHASE",
  7832. "amount": -5.8,
  7833. "externalTransactionReference": 0,
  7834. "transactionDate": "2015-12-02T16:01:19.163+13:00",
  7835. "transactionReference": 22901100,
  7836. "walletBalance": 55.8,
  7837. "description": "Purchase Lotto"
  7838. },
  7839. {
  7840. "gameName": "Lotto Powerball",
  7841. "ticketNumber": "19351440",
  7842. "ticketType": "Mega Triple Dip",
  7843. "transactionType": "PURCHASE",
  7844. "amount": -26.0,
  7845. "externalTransactionReference": 0,
  7846. "transactionDate": "2015-11-27T12:05:35.011+13:00",
  7847. "transactionReference": 22901041,
  7848. "walletBalance": 61.6,
  7849. "description": "Purchase Lotto"
  7850. },
  7851. {
  7852. "gameName": "Lotto Powerball",
  7853. "ticketNumber": "19351438",
  7854. "ticketType": "Super Plus Triple Dip",
  7855. "transactionType": "PURCHASE",
  7856. "amount": -20.0,
  7857. "externalTransactionReference": 0,
  7858. "transactionDate": "2015-11-27T12:05:28.318+13:00",
  7859. "transactionReference": 22901040,
  7860. "walletBalance": 87.6,
  7861. "description": "Purchase Lotto"
  7862. },
  7863. {
  7864. "gameName": "Lotto Powerball",
  7865. "ticketNumber": "19351401",
  7866. "ticketType": "Mega Triple Dip",
  7867. "transactionType": "PURCHASE",
  7868. "amount": -26.0,
  7869. "externalTransactionReference": 0,
  7870. "transactionDate": "2015-11-27T12:00:41.701+13:00",
  7871. "transactionReference": 22901022,
  7872. "walletBalance": 107.6,
  7873. "description": "Purchase Lotto"
  7874. },
  7875. {
  7876. "gameName": "Lotto Powerball",
  7877. "ticketNumber": "19351399",
  7878. "ticketType": "Super Plus Triple Dip",
  7879. "transactionType": "PURCHASE",
  7880. "amount": -20.0,
  7881. "externalTransactionReference": 0,
  7882. "transactionDate": "2015-11-27T12:00:29.980+13:00",
  7883. "transactionReference": 22901021,
  7884. "walletBalance": 133.6,
  7885. "description": "Purchase Lotto"
  7886. }
  7887. ]
  7888. }
  7889. "400":
  7890. body:
  7891. application/json:
  7892. schema: simpleResponse
  7893. example: |
  7894. {
  7895. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7896. }
  7897. "500":
  7898. body:
  7899. application/json:
  7900. schema: simpleResponse
  7901. example: |
  7902. {
  7903. "message": "Runtime Exception - Contact Administrator"
  7904. }
  7905. is: [error-responses, header-userid-sessionid-params]
  7906. /notifications:
  7907. displayName: Notifications
  7908. description: Notifications are messages associated to users
  7909. /{userid}:
  7910. uriParameters:
  7911. userid:
  7912. displayName: userid
  7913. type: string
  7914. required: true
  7915. repeat: false
  7916. get:
  7917. description: Retrieve random outstanding player notifications from ESi
  7918. headers:
  7919. ESI_SID:
  7920. description: The ESi Session Id
  7921. type: string
  7922. required: true
  7923. repeat: false
  7924. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  7925. USER_ID:
  7926. description: Esi User Id
  7927. type: string
  7928. required: true
  7929. repeat: false
  7930. example: "100980037"
  7931. responses:
  7932. "200":
  7933. body:
  7934. application/json:
  7935. schema: notificationsOutput
  7936. example: |
  7937. {
  7938. "notifications": [
  7939. {
  7940. "messageId": 15341659,
  7941. "messageType": 3,
  7942. "messageDate": "2009-05-10+12:00",
  7943. "subject": "You have won a prize",
  7944. "greeting": "Dear Vincent,",
  7945. "body": "Congratulations, you have won a prize!\n\nWinning ticket details:\n\n- Ticket Number: 14700120\n\n- Winning Outcome: $0 and 1 Bonus Tickets\n\nIf you have won a cash prize it has been paid directly into your MyLotto account.\n\nIf you have won a bonus ticket you will be able to view the details in the My Tickets area of your account.",
  7946. "signature": "<br\>\n<br\>\n\nKind Regards,\n\nMyLotto Customer Support\n\nPhone: 0800 MYLOTTO (0800 6956886)\n\nE-mail: customersupport@mylotto.co.nz\n\n<br\>\n\n<br\>",
  7947. "notificationClass": "Win",
  7948. "linkId": 4
  7949. },
  7950. {
  7951. "messageId": 15040005,
  7952. "messageType": 3,
  7953. "messageDate": "2009-05-04+12:00",
  7954. "subject": "Financial adjustment to your MyLotto account",
  7955. "greeting": "Dear Vincent,",
  7956. "body": "An adjustment to your MyLotto account has been processed by the MyLotto customer support team.\n\nIf you require assistance please contact MyLotto customer support.",
  7957. "signature": "<br\><br\>Kind Regards,\n\nMyLotto Customer Support\n\nPhone: 0800 MYLOTTO (0800 6956886)\n\nE-mail: customersupport@mylotto.co.nz\n\n<br\>\n\n<br\>",
  7958. "notificationClass": "Standard",
  7959. "linkId": 1
  7960. }
  7961. ]
  7962. }
  7963. "400":
  7964. body:
  7965. application/json:
  7966. schema: simpleResponse
  7967. example: |
  7968. {
  7969. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  7970. }
  7971. "500":
  7972. body:
  7973. application/json:
  7974. schema: simpleResponse
  7975. example: |
  7976. {
  7977. "message": "Runtime Exception - Contact Administrator"
  7978. }
  7979. is: [error-responses, header-userid-sessionid-params]
  7980. delete:
  7981. description: Delete a Notification by message id
  7982. headers:
  7983. ESI_SID:
  7984. description: The ESi Session Id
  7985. type: string
  7986. required: true
  7987. repeat: false
  7988. example: AEPXW2IQ8HI733C4APNTE6D2QXSTJIKW
  7989. USER_ID:
  7990. description: Esi User Id
  7991. type: string
  7992. required: true
  7993. repeat: false
  7994. example: "100980037"
  7995. queryParameters:
  7996. messageid:
  7997. description: Notification identifier
  7998. type: number
  7999. required: true
  8000. repeat: false
  8001. default: "16660016"
  8002. example: "16660016"
  8003. responses:
  8004. "200":
  8005. body:
  8006. application/json:
  8007. schema: simpleResponse
  8008. example: |
  8009. {
  8010. "message": "success"
  8011. }
  8012. "400":
  8013. body:
  8014. application/json:
  8015. schema: simpleResponse
  8016. example: |
  8017. {
  8018. "message": "nz.co.nzlotteries.exception.InvalidUserCredentialsException"
  8019. }
  8020. "500":
  8021. body:
  8022. application/json:
  8023. schema: simpleResponse
  8024. example: |
  8025. {
  8026. "message": "Runtime Exception - Contact Administrator"
  8027. }
  8028. is: [error-responses, header-userid-sessionid-params]
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
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!