Api doc


SDK's


Api Modules

api.methods

Returns a list of all methods supported by the Humanitu API and their support variables and variable types.



Supported Methods:

GET
Params


    Documentation

    GET
    Retrieves a list of all methods supported by the ShiftPlanning API and their support variables and variable types.
    Level 5 is required (all users can fetch this module)

    --

    Parameters:

    1. //Parameters aren't required to fetch this method.

    Example Request:

    1. {
    2. "module":"api.methods",
    3. "method":"GET",
    4. "request":{
    5.  
    6. }
    7. }

    Example Response:

    1. {
    2. "status":1,
    3. "data":{
    4. "api":{
    5. "methods":{
    6. "description":"Returns a list of all methods supported by the
    7. ShiftPlanning API and their support variables and variable types.",
    8. "GET":{
    9. "perms":{
    10. "module":"",
    11. "level":""
    12. },
    13. "variables":{
    14. "accepted":[
    15.  
    16. ]
    17. }
    18. }
    19. },
    20. "config":{
    21. "description":"Returns all all config properties used in
    22. ShiftPlanning for date, time, display, and error codes.",
    23. "GET":{
    24. "perms":{
    25. "module":"",
    26. "level":""
    27. },
    28. "variables":{
    29. "accepted":{
    30. "all":"int"
    31. }
    32. }
    33. }
    34. },
    35. "vtoken":{
    36. "description":"Verifies a ShiftPlanning Token",
    37. "GET":{
    38. "perms":{
    39. "module":"",
    40. "level":""
    41. },
    42. "variables":{
    43. "required":[
    44. "token"
    45. ],
    46. "accepted":[
    47.  
    48. ]
    49. }
    50. }
    51. }
    52. },
    53.  
    54. // ...
    55.  
    56. "messaging":{
    57. "messages":{
    58. "description":"Retrieve\/Delete\/Add to the business message wall.",
    59. "GET":{
    60. "perms":{
    61. "module":"",
    62. "level":5
    63. },
    64. "variables":{
    65. "required":[
    66.  
    67. ],
    68. "accepted":{
    69. "mode":[
    70. "to",
    71. "from"
    72. ]
    73. }
    74. }
    75. }
    76. },
    77. "message":{
    78. "description":"Retrieve\/Delete\/Send individual messages.",
    79. "GET":{
    80. "perms":{
    81. "module":"",
    82. "level":5
    83. },
    84. "variables":{
    85. "required":{
    86. "id":"int"
    87. },
    88. "accepted":[
    89.  
    90. ]
    91. }
    92. },
    93. "CREATE":{
    94. "perms":{
    95. "module":"",
    96. "level":5
    97. },
    98. "variables":{
    99. "required":{
    100. "0":"subject",
    101. "1":"message",
    102. "to":"int"
    103. },
    104. "accepted":[
    105.  
    106. ]
    107. }
    108. },
    109. "DELETE":{
    110. "perms":{
    111. "module":"",
    112. "level":5
    113. },
    114. "variables":{
    115. "required":{
    116. "id":"int"
    117. },
    118. "accepted":[
    119.  
    120. ]
    121. }
    122. },
    123. "UPDATE":{
    124. "perms":{
    125. "module":"",
    126. "level":5
    127. },
    128. "variables":{
    129. "required":{
    130. "id":"int"
    131. },
    132. "accepted":{
    133. "read":[
    134. "1",
    135. "0"
    136. ]
    137. }
    138. }
    139. }
    140. },
    141. "shift":{
    142. "description":"Send a message to all staff on a shift.",
    143. "CREATE":{
    144. "perms":{
    145. "module":"",
    146. "level":5
    147. },
    148. "variables":{
    149. "required":{
    150. "0":"subject",
    151. "1":"message",
    152. "id":"int"
    153. },
    154. "accepted":[
    155.  
    156. ]
    157. }
    158. }
    159. },
    160. "wall":{
    161. "GET":{
    162. "perms":{
    163. "module":"",
    164. "level":5
    165. },
    166. "variables":{
    167. "required":[
    168.  
    169. ],
    170. "accepted":[
    171.  
    172. ]
    173. }
    174. },
    175. "CREATE":{
    176. "perms":{
    177. "module":"",
    178. "level":5
    179. },
    180. "variables":{
    181. "required":[
    182. "post"
    183. ],
    184. "accepted":{
    185. "id":"int",
    186. "0":"title",
    187. "sticky":[
    188. "0"
    189. ]
    190. }
    191. }
    192. },
    193. "DELETE":{
    194. "perms":{
    195. "module":"",
    196. "level":5
    197. },
    198. "variables":{
    199. "required":{
    200. "id":"int",
    201. "delete":[
    202. "message",
    203. "comment"
    204. ]
    205. },
    206. "accepted":[
    207.  
    208. ]
    209. }
    210. }
    211. }
    212. },
    213. "reports":{
    214. "schedule":{
    215. "GET":{
    216. "perms":{
    217. "module":"",
    218. "level":5
    219. },
    220. "variables":{
    221. "required":{
    222. "start_date":"date",
    223. "end_date":"date",
    224. "type":[
    225. "schedule_summary",
    226. "shift_confirmed",
    227. "crib_sheet",
    228. "shift_exchanges",
    229. "open_shifts",
    230. "position_summary"
    231. ]
    232. },
    233. "accepted":{
    234. "location":"int",
    235. "schedule":"int",
    236. "0":"employee",
    237. "skill":"int",
    238. "with_statuses":"int",
    239. "options":"int"
    240. }
    241. }
    242. }
    243. },
    244. "budget":{
    245. "GET":{
    246. "perms":{
    247. "module":"",
    248. "level":3
    249. },
    250. "variables":{
    251. "required":{
    252. "start_date":"date",
    253. "end_date":"date"
    254. },
    255. "accepted":[
    256.  
    257. ]
    258. }
    259. }
    260. },
    261. "timesheets":{
    262. "GET":{
    263. "perms":{
    264. "module":"",
    265. "level":5
    266. },
    267. "variables":{
    268. "required":{
    269. "start_date":"date",
    270. "end_date":"date",
    271. "location":"int",
    272. "schedule":"int",
    273. "0":"employee",
    274. "skill":"int",
    275. "type":[
    276. "timesheets_summary",
    277. "timesheets_attendance"
    278. ]
    279. },
    280. "accepted":{
    281. "deductbreaks":"int"
    282. }
    283. }
    284. }
    285. },
    286. "employee":{
    287. "GET":{
    288. "perms":{
    289. "module":"",
    290. "level":5
    291. },
    292. "variables":{
    293. "required":{
    294. "start_date":"date",
    295. "end_date":"date",
    296. "location":"int",
    297. "schedule":"int",
    298. "0":"employee",
    299. "skill":"int",
    300. "type":[
    301. "attendance",
    302. "vacations",
    303. "availability",
    304. "unavailability"
    305. ]
    306. },
    307. "accepted":[
    308.  
    309. ]
    310. }
    311. }
    312. },
    313. "custom":{
    314. "GET":{
    315. "perms":{
    316. "module":"",
    317. "level":3
    318. },
    319. "variables":{
    320. "required":{
    321. "0":"fields",
    322. "start_date":"date",
    323. "end_date":"date",
    324. "type":[
    325. "timesheets",
    326. "confirmedtimesheets",
    327. "shifts",
    328. "confirmedshifts"
    329. ]
    330. },
    331. "accepted":{
    332. "schedule":"int",
    333. "0":"employee",
    334. "skill":"int",
    335. "deduct_breaks":[
    336. 0,
    337. 1
    338. ]
    339. }
    340. }
    341. }
    342. }
    343. },
    344. "payroll":{
    345. "report":{
    346. "description":"Run Payroll Specific Reports on schedule \/ time sheet data.",
    347. "GET":{
    348. "perms":{
    349. "module":"",
    350. "level":3
    351. },
    352. "variables":{
    353. "required":{
    354. "type":[
    355. "scheduledhours",
    356. "confirmedhours",
    357. "timesheets"
    358. ]
    359. },
    360. "accepted":{
    361. "start_date":"date",
    362. "end_date":"date",
    363. "location":"int",
    364. "schedule":"int",
    365. "0":"employee",
    366. "skill":"int",
    367. "deduct_breaks":[
    368. "0",
    369. "1"
    370. ],
    371. "group_results":[
    372. "0",
    373. "1",
    374. "2"
    375. ],
    376. "show_empty":[
    377. "0",
    378. "1"
    379. ]
    380. }
    381. }
    382. }
    383. },
    384. "ratecards":{
    385. "description":"Returns a list of payroll rate cards.",
    386. "GET":{
    387. "perms":{
    388. "module":"",
    389. "level":5
    390. },
    391. "variables":{
    392. "required":[
    393.  
    394. ],
    395. "accepted":[
    396.  
    397. ]
    398. }
    399. }
    400. },
    401. "ratecard":{
    402. "description":"Returns a payroll rate card.",
    403. "GET":{
    404. "perms":{
    405. "module":"",
    406. "level":5
    407. },
    408. "variables":{
    409. "required":{
    410. "id":"int"
    411. },
    412. "accepted":[
    413.  
    414. ]
    415. }
    416. },
    417. "CREATE":{
    418. "perms":{
    419. "module":"",
    420. "level":3
    421. },
    422. "variables":{
    423. "required":[
    424. "name"
    425. ],
    426. "accepted":{
    427. "stack_overtime":[
    428. "0",
    429. "1"
    430. ]
    431. }
    432. }
    433. },
    434. "DELETE":{
    435. "perms":{
    436. "module":"",
    437. "level":3
    438. },
    439. "variables":{
    440. "required":{
    441. "id":"int"
    442. },
    443. "accepted":{
    444. "def":[
    445. "0",
    446. "1"
    447. ]
    448. }
    449. }
    450. },
    451. "UPDATE":{
    452. "perms":{
    453. "module":"",
    454. "level":3
    455. },
    456. "variables":{
    457. "required":{
    458. "id":"int"
    459. },
    460. "accepted":{
    461. "0":"name",
    462. "def":[
    463. "0",
    464. "1"
    465. ],
    466. "1":"rates",
    467. "2":"overtime",
    468. "day_limit":[
    469. "CREATE",
    470. "UPDATE",
    471. "DELETE"
    472. ],
    473. "day_limit_id":"int",
    474. "day_limit_minimum":"int",
    475. "day_limit_rate":"int",
    476. "stack_overtime":[
    477. "0",
    478. "1"
    479. ]
    480. }
    481. }
    482. }
    483. }
    484. },
    485. "schedule":{
    486. "schedules":{
    487. "description":"Returns a list of all schedules.",
    488. "GET":{
    489. "perms":{
    490. "module":"",
    491. "level":5
    492. },
    493. "variables":{
    494. "required":[
    495.  
    496. ],
    497. "accepted":{
    498. "perms":[
    499. "1"
    500. ]
    501. }
    502. }
    503. }
    504. },
    505. "schedule":{
    506. "description":"Management of individual schedules.",
    507. "GET":{
    508. "perms":{
    509. "module":"",
    510. "level":5
    511. },
    512. "variables":{
    513. "required":{
    514. "id":"int"
    515. },
    516. "accepted":[
    517.  
    518. ]
    519. }
    520. },
    521. "CREATE":{
    522. "perms":{
    523. "module":"",
    524. "level":3
    525. },
    526. "variables":{
    527. "required":[
    528. "name"
    529. ],
    530. "accepted":{
    531. "active":[
    532. "1",
    533. "-1"
    534. ],
    535. "start_time":"time",
    536. "end_time":"time",
    537. "color":"int",
    538. "location":"int"
    539. }
    540. }
    541. },
    542. "UPDATE":{
    543. "perms":{
    544. "module":"",
    545. "level":3
    546. },
    547. "variables":{
    548. "required":{
    549. "id":"int"
    550. },
    551. "accepted":{
    552. "active":[
    553. "1",
    554. "-1"
    555. ],
    556. "0":"name",
    557. "start_time":"time",
    558. "end_time":"time",
    559. "color":"int",
    560. "location":"int"
    561. }
    562. }
    563. },
    564. "DELETE":{
    565. "perms":{
    566. "module":"",
    567. "level":3
    568. },
    569. "variables":{
    570. "required":{
    571. "id":"int"
    572. },
    573. "accepted":[
    574.  
    575. ]
    576. }
    577. }
    578. },
    579. "shifts":{
    580. "description":"Returns a list of shifts.",
    581. "GET":{
    582. "perms":{
    583. "module":"",
    584. "level":5
    585. },
    586. "variables":{
    587. "required":[
    588.  
    589. ],
    590. "accepted":{
    591. "start_date":"date",
    592. "end_date":"date",
    593. "mode":[
    594. "overview",
    595. "location",
    596. "schedule",
    597. "incomplete",
    598. "employees",
    599. "employee",
    600. "open",
    601. "openapproval",
    602. "confirm",
    603. "onnow"
    604. ],
    605. "0":"schedule",
    606. "location":"int",
    607. "1":"employees",
    608. "detailed":"int",
    609. "budget":[
    610. "0",
    611. "1"
    612. ]
    613. }
    614. }
    615. }
    616. },
    617. "shift":{
    618. "description":"Management of individual shifts.",
    619. "GET":{
    620. "perms":{
    621. "module":"",
    622. "level":5
    623. },
    624. "variables":{
    625. "required":{
    626. "id":"int"
    627. },
    628. "accepted":{
    629. "detailed":"int"
    630. }
    631. }
    632. },
    633. "CREATE":{
    634. "perms":{
    635. "module":"",
    636. "level":3
    637. },
    638. "variables":{
    639. "required":{
    640. "start_time":"time",
    641. "end_time":"time",
    642. "start_date":"date",
    643. "end_date":"date"
    644. },
    645. "accepted":{
    646. "schedule":"int",
    647. "type":"int",
    648. "needed":"int",
    649. "0":"notes",
    650. "1":"title",
    651. "2":"confirmed",
    652. "location":"int"
    653. }
    654. }
    655. },
    656. "UPDATE":{
    657. "perms":{
    658. "module":"",
    659. "level":3
    660. },
    661. "variables":{
    662. "required":{
    663. "id":"int"
    664. },
    665. "accepted":{
    666. "0":"schedule",
    667. "type":"int",
    668. "needed":"int",
    669. "start_time":"time",
    670. "end_time":"time",
    671. "start_date":"date",
    672. "end_date":"date",
    673. "1":"notes",
    674. "2":"title",
    675. "confirmed":"int",
    676. "3":"add",
    677. "remove":"int",
    678. "4":"detailed",
    679. "5":"location",
    680. "force":[
    681. "0",
    682. "1"
    683. ],
    684. "repeat":"int",
    685. "repeat_until":"date",
    686. "repeat_staff":[
    687. "",
    688. "0",
    689. "1",
    690. "2"
    691. ],
    692. "update_series":[
    693. "1",
    694. "2",
    695. "3"
    696. ],
    697. "update_staff":[
    698. "0",
    699. "1"
    700. ],
    701. "update_time":[
    702. "0",
    703. "1"
    704. ],
    705. "update_type":[
    706. "0",
    707. "1"
    708. ],
    709. "update_notes":[
    710. "0",
    711. "1"
    712. ],
    713. "update_schedule":[
    714. "0",
    715. "1"
    716. ],
    717. "copy_to":"date",
    718. "restore":[
    719. "0",
    720. "1"
    721. ]
    722. }
    723. }
    724. },
    725. "DELETE":{
    726. "perms":{
    727. "module":"",
    728. "level":3
    729. },
    730. "variables":{
    731. "required":{
    732. "id":"int"
    733. },
    734. "accepted":{
    735. "rule":[
    736. "all",
    737. "following"
    738. ]
    739. }
    740. }
    741. }
    742. },
    743. "shiftapprove":{
    744. "description":"Management of individual shifts.",
    745. "GET":{
    746. "perms":{
    747. "module":"shift",
    748. "level":3
    749. },
    750. "variables":{
    751. "required":{
    752. "id":"int"
    753. },
    754. "accepted":[
    755.  
    756. ]
    757. }
    758. },
    759. "CREATE":{
    760. "perms":{
    761. "module":"shift",
    762. "level":3
    763. },
    764. "variables":{
    765. "required":{
    766. "id":"int"
    767. }
    768. }
    769. },
    770. "UPDATE":{
    771. "variables":{
    772. "accepted":{
    773. "employee":"int",
    774. "absent":[
    775. "0",
    776. "1"
    777. ],
    778. "start_time":"time",
    779. "end_time":"time"
    780. },
    781. "required":{
    782. "id":"int"
    783. }
    784. },
    785. "perms":{
    786. "module":"shift",
    787. "level":3
    788. }
    789. },
    790. "DELETE":{
    791. "perms":{
    792. "module":"shift",
    793. "level":3
    794. },
    795. "variables":{
    796. "required":{
    797. "id":"int"
    798. },
    799. "accepted":[
    800.  
    801. ]
    802. }
    803. }
    804. },
    805. "trades":{
    806. "description":"Returns a list of trades.",
    807. "GET":{
    808. "perms":{
    809. "module":"",
    810. "level":5
    811. },
    812. "variables":{
    813. "required":[
    814.  
    815. ],
    816. "accepted":{
    817. "mode":[
    818. "manage",
    819. "requested"
    820. ]
    821. }
    822. }
    823. }
    824. },
    825. "trade":{
    826. "description":"Management of individual trades.",
    827. "GET":{
    828. "perms":{
    829. "module":"",
    830. "level":5
    831. },
    832. "variables":{
    833. "required":{
    834. "id":"int"
    835. },
    836. "accepted":[
    837.  
    838. ]
    839. }
    840. },
    841. "CREATE":{
    842. "perms":{
    843. "module":"",
    844. "level":5
    845. },
    846. "variables":{
    847. "required":{
    848. "shift":"int",
    849. "0":"tradewith",
    850. "1":"reason"
    851. },
    852. "accepted":[
    853.  
    854. ]
    855. }
    856. },
    857. "UPDATE":{
    858. "perms":{
    859. "module":"",
    860. "level":5
    861. },
    862. "variables":{
    863. "required":{
    864. "trade":"int",
    865. "action":[
    866. "activate",
    867. "deactivate",
    868. "cancel",
    869. "accept",
    870. "reject"
    871. ]
    872. },
    873. "accepted":{
    874. "user":"int"
    875. }
    876. }
    877. }
    878. },
    879. "vacations":{
    880. "description":"Returns a list of vacations.",
    881. "GET":{
    882. "perms":{
    883. "module":"",
    884. "level":5
    885. },
    886. "variables":{
    887. "required":[
    888.  
    889. ],
    890. "accepted":{
    891. "start_date":"date",
    892. "end_date":"date",
    893. "mode":[
    894. "manage",
    895. "requested",
    896. "upcoming"
    897. ]
    898. }
    899. }
    900. }
    901. },
    902. "vacation":{
    903. "description":"Individual vacation management.",
    904. "GET":{
    905. "perms":{
    906. "module":"",
    907. "level":5
    908. },
    909. "variables":{
    910. "required":{
    911. "id":"int"
    912. },
    913. "accepted":[
    914.  
    915. ]
    916. }
    917. },
    918. "CREATE":{
    919. "perms":{
    920. "module":"",
    921. "level":5
    922. },
    923. "variables":{
    924. "required":{
    925. "start_date":"date",
    926. "end_date":"date"
    927. },
    928. "accepted":{
    929. "employee":"int",
    930. "0":"comments",
    931. "start_time":"time",
    932. "end_time":"time",
    933. "1":"notes",
    934. "2":"status"
    935. }
    936. }
    937. },
    938. "UPDATE":{
    939. "perms":{
    940. "module":"",
    941. "level":5
    942. },
    943. "variables":{
    944. "required":{
    945. "id":"int"
    946. },
    947. "accepted":{
    948. "start_date":"date",
    949. "end_date":"date",
    950. "start_time":"time",
    951. "end_time":"time",
    952. "0":"comments",
    953. "1":"notes",
    954. "status":[
    955. "0",
    956. "1",
    957. "-1",
    958. "-2"
    959. ]
    960. }
    961. }
    962. },
    963. "DELETE":{
    964. "perms":{
    965. "module":"",
    966. "level":5
    967. },
    968. "variables":{
    969. "required":{
    970. "id":"int"
    971. },
    972. "accepted":[
    973.  
    974. ]
    975. }
    976. }
    977. },
    978. "conflicts":{
    979. "description":"Returns a list of schedule conficts.",
    980. "GET":{
    981. "perms":{
    982. "module":"",
    983. "level":5
    984. },
    985. "variables":{
    986. "required":[
    987.  
    988. ],
    989. "accepted":{
    990. "start_date":"date",
    991. "end_date":"date",
    992. "0":"mode",
    993. "1":"schedule"
    994. }
    995. }
    996. }
    997. },
    998. "copy":{
    999. "description":"Copy a schedule between two timelines",
    1000. "GET":{
    1001. "perms":{
    1002. "module":"",
    1003. "level":5
    1004. },
    1005. "variables":{
    1006. "required":{
    1007. "from_start":"date",
    1008. "from_end":"date",
    1009. "to_start":"date",
    1010. "to_end":"date"
    1011. },
    1012. "accepted":{
    1013. "0":"schedule",
    1014. "1":"mode",
    1015. "with_staff":[
    1016. "0",
    1017. "1",
    1018. "2"
    1019. ]
    1020. }
    1021. }
    1022. }
    1023. },
    1024. "clear":{
    1025. "description":"Clear the Schedule",
    1026. "GET":{
    1027. "perms":{
    1028. "module":"",
    1029. "level":5
    1030. },
    1031. "variables":{
    1032. "required":[
    1033.  
    1034. ],
    1035. "accepted":{
    1036. "start_date":"date",
    1037. "end_date":"date",
    1038. "schedule":"int",
    1039. "0":"shifts",
    1040. "restore":[
    1041. "0",
    1042. "1"
    1043. ],
    1044. "restoredate":"timestamp"
    1045. }
    1046. }
    1047. }
    1048. },
    1049. "restore":{
    1050. "description":"View History of schedule clears",
    1051. "GET":{
    1052. "perms":{
    1053. "module":"",
    1054. "level":5
    1055. },
    1056. "variables":{
    1057. "required":[
    1058.  
    1059. ],
    1060. "accepted":{
    1061. "start_date":"date",
    1062. "end_date":"date",
    1063. "0":"schedule",
    1064. "detailed":[
    1065. "0",
    1066. "1"
    1067. ],
    1068. "timestamp":"timestamp"
    1069. }
    1070. }
    1071. }
    1072. },
    1073. "wizard":{
    1074. "description":"Auto-Generated a schedule using the wizard schedule wizard.",
    1075. "GET":{
    1076. "perms":{
    1077. "module":"",
    1078. "level":4
    1079. },
    1080. "variables":{
    1081. "required":{
    1082. "from_start":"date",
    1083. "from_end":"date",
    1084. "to_start":"date",
    1085. "to_end":"date"
    1086. },
    1087. "accepted":{
    1088. "0":"schedule",
    1089. "1":"mode",
    1090. "rule":[
    1091. "1",
    1092. "2",
    1093. "3"
    1094. ],
    1095. "clear":[
    1096. 0,
    1097. 1
    1098. ],
    1099. "force":[
    1100. 0,
    1101. 1
    1102. ],
    1103. "2":"shifts"
    1104. }
    1105. }
    1106. }
    1107. },
    1108. "fill":{
    1109. "description":"Fill Shifts using the Schedule wizard.",
    1110. "GET":{
    1111. "perms":{
    1112. "module":"",
    1113. "level":4
    1114. },
    1115. "variables":{
    1116. "required":[
    1117. "shifts"
    1118. ],
    1119. "accepted":{
    1120. "fill_count":"int",
    1121. "fill_slots":[
    1122. 0,
    1123. 1
    1124. ]
    1125. }
    1126. }
    1127. }
    1128. },
    1129. "publish":{
    1130. "description":"Publish Shifts",
    1131. "GET":{
    1132. "perms":{
    1133. "module":"",
    1134. "level":5
    1135. },
    1136. "variables":{
    1137. "required":[
    1138. "shifts"
    1139. ],
    1140. "accepted":{
    1141. "schedule":"int",
    1142. "notify":[
    1143. "",
    1144. "0",
    1145. "1",
    1146. "2"
    1147. ],
    1148. "0":"message",
    1149. "start_date":"date",
    1150. "end_date":"date"
    1151. }
    1152. }
    1153. }
    1154. },
    1155. "requests":{
    1156. "description":"Returns a list of requests.",
    1157. "UPDATE":{
    1158. "perms":{
    1159. "module":"",
    1160. "level":5
    1161. },
    1162. "variables":{
    1163. "required":{
    1164. "id":"int",
    1165. "type":[
    1166. "openshifts"
    1167. ],
    1168. "mode":[
    1169. "approve",
    1170. "reject"
    1171. ]
    1172. },
    1173. "accepted":[
    1174.  
    1175. ]
    1176. }
    1177. }
    1178. }
    1179. },
    1180. "timeclock":{
    1181. "timeclocks":{
    1182. "description":"Returns a list of all Time Clocks.",
    1183. "GET":{
    1184. "perms":{
    1185. "module":"",
    1186. "level":5
    1187. },
    1188. "variables":{
    1189. "required":[
    1190.  
    1191. ],
    1192. "accepted":{
    1193. "start_date":"date",
    1194. "end_date":"date",
    1195. "schedule":"int",
    1196. "employee":"int",
    1197. "status":[
    1198. "approved",
    1199. "unapproved"
    1200. ]
    1201. }
    1202. }
    1203. }
    1204. },
    1205. "timeclock":{
    1206. "description":"Management of individual Clock Times.",
    1207. "GET":{
    1208. "perms":{
    1209. "module":"",
    1210. "level":5
    1211. },
    1212. "variables":{
    1213. "required":{
    1214. "id":"int"
    1215. },
    1216. "accepted":[
    1217.  
    1218. ]
    1219. }
    1220. },
    1221. "CREATE":{
    1222. "perms":{
    1223. "module":"",
    1224. "level":5
    1225. },
    1226. "variables":{
    1227. "required":{
    1228. "start_date":"date",
    1229. "schedule":"int",
    1230. "employee":"int",
    1231. "start_time":"time"
    1232. },
    1233. "accepted":{
    1234. "end_date":"date",
    1235. "end_time":"time",
    1236. "0":"notes"
    1237. }
    1238. }
    1239. },
    1240. "UPDATE":{
    1241. "perms":{
    1242. "module":"",
    1243. "level":5
    1244. },
    1245. "variables":{
    1246. "required":{
    1247. "id":"int"
    1248. },
    1249. "accepted":{
    1250. "start_date":"date",
    1251. "end_date":"date",
    1252. "schedule":"int",
    1253. "employee":"int",
    1254. "start_time":"time",
    1255. "end_time":"time",
    1256. "0":"notes",
    1257. "approved":[
    1258. "0",
    1259. "1"
    1260. ]
    1261. }
    1262. }
    1263. },
    1264. "DELETE":{
    1265. "perms":{
    1266. "module":"",
    1267. "level":4
    1268. },
    1269. "variables":{
    1270. "required":{
    1271. "id":"int"
    1272. },
    1273. "accepted":[
    1274.  
    1275. ]
    1276. }
    1277. }
    1278. },
    1279. "clockin":{
    1280. "description":"Clock In Employee (Default: Authenticated User)",
    1281. "GET":{
    1282. "perms":{
    1283. "module":"",
    1284. "level":5
    1285. },
    1286. "variables":{
    1287. "required":[
    1288.  
    1289. ],
    1290. "accepted":{
    1291. "employee":"int"
    1292. }
    1293. }
    1294. }
    1295. },
    1296. "clockout":{
    1297. "description":"Clock Out Employee (Default: Authenticated User)",
    1298. "GET":{
    1299. "perms":{
    1300. "module":"",
    1301. "level":5
    1302. },
    1303. "variables":{
    1304. "required":[
    1305.  
    1306. ],
    1307. "accepted":{
    1308. "schedule":"int",
    1309. "0":"notes",
    1310. "employee":"int"
    1311. }
    1312. }
    1313. }
    1314. },
    1315. "status":{
    1316. "description":"Get Clock Status of Employee (Default: Authenticated User).
    1317. Returns 'in' or 'out'",
    1318. "GET":{
    1319. "perms":{
    1320. "module":"",
    1321. "level":5
    1322. },
    1323. "variables":{
    1324. "required":[
    1325.  
    1326. ],
    1327. "accepted":{
    1328. "employee":"int",
    1329. "details":[
    1330. "1"
    1331. ]
    1332. }
    1333. }
    1334. }
    1335. },
    1336. "manage":{
    1337. "description":"Manage individual clock time or csv id's of clock times",
    1338. "GET":{
    1339. "perms":{
    1340. "module":"",
    1341. "level":5
    1342. },
    1343. "variables":{
    1344. "required":{
    1345. "0":"id",
    1346. "action":[
    1347. "approve",
    1348. "unapprove",
    1349. "reject",
    1350. "delete"
    1351. ]
    1352. },
    1353. "accepted":[
    1354. "comment"
    1355. ]
    1356. }
    1357. }
    1358. },
    1359. "screenshot":{
    1360. "description":"Upload a screenshot for authenticated user",
    1361. "CREATE":{
    1362. "perms":{
    1363. "module":"",
    1364. "level":5
    1365. },
    1366. "variables":{
    1367. "required":[
    1368. "filedata"
    1369. ],
    1370. "accepted":{
    1371. "width":"int",
    1372. "height":"int",
    1373. "filesize":"int",
    1374. "timeclock":"int",
    1375. "0":"ip"
    1376. }
    1377. }
    1378. }
    1379. }
    1380. },
    1381. "staff":{
    1382. "login":{
    1383. "GET":{
    1384. "perms":{
    1385. "module":"",
    1386. "level":""
    1387. },
    1388. "variables":{
    1389. "required":[
    1390. "username",
    1391. "password"
    1392. ],
    1393. "accepted":{
    1394. "remember":[
    1395. "1"
    1396. ]
    1397. }
    1398. }
    1399. }
    1400. },
    1401. "logout":{
    1402. "GET":{
    1403. "perms":{
    1404. "module":"",
    1405. "level":5
    1406. },
    1407. "variables":{
    1408. "required":[
    1409.  
    1410. ]
    1411. }
    1412. }
    1413. },
    1414. "employees":{
    1415. "GET":{
    1416. "perms":{
    1417. "module":"",
    1418. "level":5
    1419. },
    1420. "variables":{
    1421. "required":[
    1422.  
    1423. ],
    1424. "accepted":[
    1425. "schedule"
    1426. ]
    1427. }
    1428. },
    1429. "CREATE":{
    1430. "perms":{
    1431. "module":"",
    1432. "level":5
    1433. },
    1434. "variables":{
    1435. "required":[
    1436.  
    1437. ],
    1438. "accepted":[
    1439.  
    1440. ]
    1441. }
    1442. }
    1443. },
    1444. "employee":{
    1445. "GET":{
    1446. "perms":{
    1447. "module":"",
    1448. "level":5
    1449. },
    1450. "variables":{
    1451. "required":[
    1452.  
    1453. ],
    1454. "accepted":{
    1455. "id":"int",
    1456. "0":"eid"
    1457. }
    1458. }
    1459. },
    1460. "CREATE":{
    1461. "perms":{
    1462. "module":"",
    1463. "level":3
    1464. },
    1465. "variables":{
    1466. "required":[
    1467. "name"
    1468. ],
    1469. "accepted":{
    1470. "0":"eid",
    1471. "status":[
    1472. "0",
    1473. "1",
    1474. "-1",
    1475. "-2"
    1476. ],
    1477. "group":[
    1478. "2",
    1479. "3",
    1480. "4",
    1481. "5"
    1482. ],
    1483. "email":"email",
    1484. "1":"nick_name",
    1485. "birth_day":"int",
    1486. "birth_month":"int",
    1487. "cell_phone":"phone",
    1488. "wage":"int",
    1489. "home_phone":"phone",
    1490. "2":"address",
    1491. "3":"city",
    1492. "4":"state",
    1493. "5":"zip",
    1494. "6":"notes",
    1495. "smsgateway":"int",
    1496. "password":[
    1497. "min",
    1498. 6
    1499. ],
    1500. "username":[
    1501. "min",
    1502. 3
    1503. ],
    1504. "send_activation":[
    1505. "1"
    1506. ],
    1507. "7":"facebook",
    1508. "8":"google"
    1509. }
    1510. }
    1511. },
    1512. "UPDATE":{
    1513. "perms":{
    1514. "module":"",
    1515. "level":3
    1516. },
    1517. "variables":{
    1518. "required":{
    1519. "id":"int"
    1520. },
    1521. "accepted":{
    1522. "0":"eid",
    1523. "status":[
    1524. "0",
    1525. "1",
    1526. "-1",
    1527. "-2"
    1528. ],
    1529. "group":[
    1530. "2",
    1531. "3",
    1532. "4",
    1533. "5"
    1534. ],
    1535. "1":"name",
    1536. "email":"email",
    1537. "2":"nick_name",
    1538. "birth_day":"int",
    1539. "birth_month":"int",
    1540. "cell_phone":"phone",
    1541. "wage":"int",
    1542. "home_phone":"phone",
    1543. "3":"address",
    1544. "4":"city",
    1545. "5":"state",
    1546. "6":"zip",
    1547. "7":"notes",
    1548. "smsgateway":"int",
    1549. "password":[
    1550. "min",
    1551. 6
    1552. ],
    1553. "username":[
    1554. "min",
    1555. 3
    1556. ],
    1557. "addschedule":"int",
    1558. "removeschedule":"int",
    1559. "addskill":"int",
    1560. "removeskill":"int",
    1561. "send_activation":[
    1562. "1"
    1563. ],
    1564. "8":"language"
    1565. }
    1566. }
    1567. },
    1568. "DELETE":{
    1569. "perms":{
    1570. "module":"",
    1571. "level":3
    1572. },
    1573. "variables":{
    1574. "required":{
    1575. "id":"int"
    1576. },
    1577. "accepted":[
    1578.  
    1579. ]
    1580. }
    1581. }
    1582. },
    1583. "skills":{
    1584. "GET":{
    1585. "perms":{
    1586. "module":"",
    1587. "level":5
    1588. },
    1589. "variables":{
    1590. "required":[
    1591.  
    1592. ],
    1593. "accepted":[
    1594.  
    1595. ]
    1596. }
    1597. }
    1598. },
    1599. "skill":{
    1600. "GET":{
    1601. "perms":{
    1602. "module":"",
    1603. "level":5
    1604. },
    1605. "variables":{
    1606. "required":{
    1607. "id":"int"
    1608. },
    1609. "accepted":[
    1610.  
    1611. ]
    1612. }
    1613. },
    1614. "CREATE":{
    1615. "perms":{
    1616. "module":"",
    1617. "level":5
    1618. },
    1619. "variables":{
    1620. "required":[
    1621. "name"
    1622. ],
    1623. "accepted":[
    1624.  
    1625. ]
    1626. }
    1627. },
    1628. "UPDATE":{
    1629. "perms":{
    1630. "module":"",
    1631. "level":5
    1632. },
    1633. "variables":{
    1634. "required":{
    1635. "id":"int",
    1636. "0":"name"
    1637. },
    1638. "accepted":[
    1639.  
    1640. ]
    1641. }
    1642. },
    1643. "DELETE":{
    1644. "perms":{
    1645. "module":"",
    1646. "level":5
    1647. },
    1648. "variables":{
    1649. "required":{
    1650. "id":"int"
    1651. },
    1652. "accepted":[
    1653.  
    1654. ]
    1655. }
    1656. }
    1657. },
    1658. "ping":{
    1659. "CREATE":{
    1660. "perms":{
    1661. "module":"",
    1662. "level":5
    1663. },
    1664. "variables":{
    1665. "required":{
    1666. "to":"int",
    1667. "0":"message"
    1668. },
    1669. "accepted":[
    1670.  
    1671. ]
    1672. }
    1673. }
    1674. }
    1675. },
    1676. "location":{
    1677. "locations":{
    1678. "description":"Returns a list of Locations.",
    1679. "GET":{
    1680. "perms":{
    1681. "module":"",
    1682. "level":5
    1683. },
    1684. "variables":{
    1685. "required":[
    1686.  
    1687. ],
    1688. "accepted":[
    1689.  
    1690. ]
    1691. }
    1692. }
    1693. },
    1694. "location":{
    1695. "description":"Management of individual Location.",
    1696. "GET":{
    1697. "perms":{
    1698. "module":"",
    1699. "level":5
    1700. },
    1701. "variables":{
    1702. "required":{
    1703. "id":"int"
    1704. },
    1705. "accepted":[
    1706.  
    1707. ]
    1708. }
    1709. },
    1710. "CREATE":{
    1711. "perms":{
    1712. "module":"",
    1713. "level":5
    1714. },
    1715. "variables":{
    1716. "required":{
    1717. "0":"name",
    1718. "type":[
    1719. "1",
    1720. "2"
    1721. ]
    1722. },
    1723. "accepted":[
    1724. "country",
    1725. "address",
    1726. "lat",
    1727. "lon"
    1728. ]
    1729. }
    1730. },
    1731. "UPDATE":{
    1732. "perms":{
    1733. "module":"",
    1734. "level":5
    1735. },
    1736. "variables":{
    1737. "required":{
    1738. "id":"int"
    1739. },
    1740. "accepted":[
    1741.  
    1742. ]
    1743. }
    1744. },
    1745. "DELETE":{
    1746. "perms":{
    1747. "module":"",
    1748. "level":5
    1749. },
    1750. "variables":{
    1751. "required":{
    1752. "id":"int"
    1753. },
    1754. "accepted":[
    1755.  
    1756. ]
    1757. }
    1758. }
    1759. }
    1760. },
    1761. "training":{
    1762. "progress":{
    1763. "description":"Returns a list of users and their completion
    1764. status of training modules",
    1765. "GET":{
    1766. "perms":{
    1767. "module":"",
    1768. "level":"5"
    1769. },
    1770. "variables":{
    1771. "required":[
    1772.  
    1773. ],
    1774. "accepted":{
    1775. "user_id":"int"
    1776. }
    1777. }
    1778. }
    1779. },
    1780. "sections":{
    1781. "description":"Returns a list of all training sections
    1782. (parent group categories)",
    1783. "GET":{
    1784. "perms":{
    1785. "module":"",
    1786. "level":"5"
    1787. },
    1788. "variables":{
    1789. "required":[
    1790.  
    1791. ],
    1792. "accepted":[
    1793.  
    1794. ]
    1795. }
    1796. }
    1797. },
    1798. "section":{
    1799. "description":"Manage an individual training section (parent group category)",
    1800. "GET":{
    1801. "perms":{
    1802. "module":"",
    1803. "level":"5"
    1804. },
    1805. "variables":{
    1806. "required":{
    1807. "id":"int"
    1808. },
    1809. "accepted":[
    1810.  
    1811. ]
    1812. }
    1813. },
    1814. "UPDATE":{
    1815. "perms":{
    1816. "module":"",
    1817. "level":"3"
    1818. },
    1819. "variables":{
    1820. "required":{
    1821. "id":"int",
    1822. "0":"title"
    1823. },
    1824. "accepted":[
    1825.  
    1826. ]
    1827. }
    1828. },
    1829. "DELETE":{
    1830. "perms":{
    1831. "module":"",
    1832. "level":"3"
    1833. },
    1834. "variables":{
    1835. "required":{
    1836. "id":"int"
    1837. },
    1838. "accepted":[
    1839.  
    1840. ]
    1841. }
    1842. },
    1843. "CREATE":{
    1844. "perms":{
    1845. "module":"",
    1846. "level":"3"
    1847. },
    1848. "variables":{
    1849. "required":[
    1850. "title"
    1851. ],
    1852. "accepted":[
    1853.  
    1854. ]
    1855. }
    1856. }
    1857. },
    1858. "modules":{
    1859. "description":"Returns a list of all training modules",
    1860. "GET":{
    1861. "perms":{
    1862. "module":"",
    1863. "level":"5"
    1864. },
    1865. "variables":{
    1866. "required":[
    1867.  
    1868. ],
    1869. "accepted":{
    1870. "section":"int",
    1871. "detailed":[
    1872. "0",
    1873. "1"
    1874. ]
    1875. }
    1876. }
    1877. }
    1878. },
    1879. "module":{
    1880. "description":"Manage an individual training module",
    1881. "GET":{
    1882. "perms":{
    1883. "module":"",
    1884. "level":"5"
    1885. },
    1886. "variables":{
    1887. "required":{
    1888. "id":"int"
    1889. },
    1890. "accepted":{
    1891. "store":"int"
    1892. }
    1893. }
    1894. },
    1895. "UPDATE":{
    1896. "perms":{
    1897. "module":"",
    1898. "level":"3"
    1899. },
    1900. "variables":{
    1901. "required":{
    1902. "id":"int"
    1903. },
    1904. "accepted":{
    1905. "0":"title",
    1906. "section":"int",
    1907. "child_edit":"int",
    1908. "tutorial":"int",
    1909. "mintime":"int",
    1910. "1":"contents",
    1911. "2":"video",
    1912. "addgroup":"int",
    1913. "removegroup":"int",
    1914. "add_group":"int",
    1915. "remove_group":"int",
    1916. "add_skill":"int",
    1917. "remove_skill":"int",
    1918. "add_user_training":"int",
    1919. "remove_user_training":"int",
    1920. "addlocation":"int",
    1921. "removelocation":"int",
    1922. "reset":"int"
    1923. }
    1924. }
    1925. },
    1926. "DELETE":{
    1927. "perms":{
    1928. "module":"",
    1929. "level":"3"
    1930. },
    1931. "variables":{
    1932. "required":{
    1933. "id":"int"
    1934. },
    1935. "accepted":[
    1936.  
    1937. ]
    1938. }
    1939. },
    1940. "CREATE":{
    1941. "perms":{
    1942. "module":"",
    1943. "level":"3"
    1944. },
    1945. "variables":{
    1946. "required":[
    1947. "title"
    1948. ],
    1949. "accepted":{
    1950. "section":"int",
    1951. "tutorial":"int",
    1952. "mintime":"int",
    1953. "0":"contents",
    1954. "1":"video"
    1955. }
    1956. }
    1957. }
    1958. },
    1959. "complete":{
    1960. "description":"Mark this training module as complete by authenticated user",
    1961. "UPDATE":{
    1962. "perms":{
    1963. "module":"",
    1964. "level":"5"
    1965. },
    1966. "variables":{
    1967. "required":{
    1968. "id":"int"
    1969. },
    1970. "accepted":[
    1971.  
    1972. ]
    1973. }
    1974. }
    1975. }
    1976. },
    1977. "group":{
    1978. "accounts":{
    1979. "description":"Group Account Management - Returns a list of all
    1980. accounts in the Group",
    1981. "GET":{
    1982. "perms":{
    1983. "module":"",
    1984. "level":"3"
    1985. },
    1986. "variables":{
    1987. "required":[
    1988.  
    1989. ],
    1990. "accepted":{
    1991. "detailed":[
    1992. "0",
    1993. "1"
    1994. ]
    1995. }
    1996. }
    1997. },
    1998. "CREATE":{
    1999. "perms":{
    2000. "module":"",
    2001. "level":"3"
    2002. },
    2003. "variables":{
    2004. "required":[
    2005. "accounts"
    2006. ],
    2007. "accepted":{
    2008. "clone_positions":[
    2009. "0",
    2010. "1"
    2011. ],
    2012. "clone_settings":[
    2013. "0",
    2014. "1"
    2015. ],
    2016. "clone_training":[
    2017. "0",
    2018. "1"
    2019. ]
    2020. }
    2021. }
    2022. }
    2023. },
    2024. "account":{
    2025. "description":"Group Account Management - Manage individual group account",
    2026. "GET":{
    2027. "perms":{
    2028. "module":"",
    2029. "level":"3"
    2030. },
    2031. "variables":{
    2032. "required":{
    2033. "id":"int"
    2034. },
    2035. "accepted":[
    2036.  
    2037. ]
    2038. }
    2039. },
    2040. "UPDATE":{
    2041. "perms":{
    2042. "module":"",
    2043. "level":"3"
    2044. },
    2045. "variables":{
    2046. "required":{
    2047. "id":"int"
    2048. },
    2049. "accepted":[
    2050. "name"
    2051. ]
    2052. }
    2053. },
    2054. "DELETE":{
    2055. "perms":{
    2056. "module":"",
    2057. "level":"3"
    2058. },
    2059. "variables":{
    2060. "required":{
    2061. "id":"int"
    2062. },
    2063. "accepted":[
    2064.  
    2065. ]
    2066. }
    2067. },
    2068. "CREATE":{
    2069. "perms":{
    2070. "module":"",
    2071. "level":"3"
    2072. },
    2073. "variables":{
    2074. "required":[
    2075.  
    2076. ],
    2077. "accepted":{
    2078. "name":[
    2079. "min",
    2080. 3
    2081. ],
    2082. "administrator":[
    2083. "min",
    2084. 3
    2085. ],
    2086. "password":[
    2087. "min",
    2088. 6
    2089. ],
    2090. "email":"email",
    2091. "domain":[
    2092. "min",
    2093. 3
    2094. ],
    2095. "clone":"int",
    2096. "clone_positions":[
    2097. "0",
    2098. "1"
    2099. ],
    2100. "clone_settings":[
    2101. "0",
    2102. "1"
    2103. ],
    2104. "clone_training":[
    2105. "0",
    2106. "1"
    2107. ]
    2108. }
    2109. }
    2110. }
    2111. }
    2112. },
    2113. "sales":{
    2114. "budgets":{
    2115. "description":"Returns all budget settings for a given time period",
    2116. "GET":{
    2117. "perms":{
    2118. "module":"",
    2119. "level":"3"
    2120. },
    2121. "variables":{
    2122. "required":{
    2123. "start_date":"date",
    2124. "end_date":"date"
    2125. },
    2126. "accepted":[
    2127.  
    2128. ]
    2129. }
    2130. }
    2131. },
    2132. "budget":{
    2133. "description":"Manage individual budget setting",
    2134. "GET":{
    2135. "perms":{
    2136. "module":"",
    2137. "level":"3"
    2138. },
    2139. "variables":{
    2140. "required":{
    2141. "start_date":"date",
    2142. "end_date":"date",
    2143. "location":"int"
    2144. },
    2145. "accepted":[
    2146.  
    2147. ]
    2148. }
    2149. },
    2150. "UPDATE":{
    2151. "perms":{
    2152. "module":"",
    2153. "level":"3"
    2154. },
    2155. "variables":{
    2156. "required":{
    2157. "start_date":"date",
    2158. "end_date":"date",
    2159. "location":"int"
    2160. },
    2161. "accepted":{
    2162. "hours":"int",
    2163. "dollars":"int"
    2164. }
    2165. }
    2166. },
    2167. "DELETE":{
    2168. "perms":{
    2169. "module":"",
    2170. "level":"3"
    2171. },
    2172. "variables":{
    2173. "required":{
    2174. "start_date":"date",
    2175. "end_date":"date",
    2176. "location":"int"
    2177. },
    2178. "accepted":[
    2179.  
    2180. ]
    2181. }
    2182. },
    2183. "CREATE":{
    2184. "perms":{
    2185. "module":"",
    2186. "level":"3"
    2187. },
    2188. "variables":{
    2189. "required":{
    2190. "start_date":"date",
    2191. "end_date":"date",
    2192. "location":"int"
    2193. },
    2194. "accepted":{
    2195. "hours":"int",
    2196. "dollars":"int"
    2197. }
    2198. }
    2199. }
    2200. }
    2201. },
    2202. "language":{
    2203. "suggestion":{
    2204. "description":"Gets or creates one new suggestion",
    2205. "GET":{
    2206. "perms":{
    2207. "module":"",
    2208. "level":"",
    2209. "private":1
    2210. },
    2211. "variables":{
    2212. "required":{
    2213. "suggestion_id":"int"
    2214. },
    2215. "accepted":[
    2216.  
    2217. ]
    2218. }
    2219. },
    2220. "CREATE":{
    2221. "perms":{
    2222. "module":"",
    2223. "level":5,
    2224. "private":1
    2225. },
    2226. "variables":{
    2227. "required":{
    2228. "original_id":"int",
    2229. "0":"language_id",
    2230. "1":"suggestion"
    2231. },
    2232. "accepted":[
    2233.  
    2234. ]
    2235. }
    2236. }
    2237. },
    2238. "suggestions":{
    2239. "description":"Gets one or more suggestions based on original id passed",
    2240. "GET":{
    2241. "perms":{
    2242. "module":"",
    2243. "level":"",
    2244. "private":1
    2245. },
    2246. "variables":{
    2247. "required":[
    2248. "original_id"
    2249. ],
    2250. "accepted":[
    2251. "code"
    2252. ]
    2253. }
    2254. }
    2255. },
    2256. "vote":{
    2257. "description":"Vote module gets,creates or deletes votes of specific user.
    2258. (mode can be: vote_up or vote_down)",
    2259. "GET":{
    2260. "perms":{
    2261. "module":"",
    2262. "level":"",
    2263. "private":1
    2264. },
    2265. "variables":{
    2266. "required":[
    2267. "lang_suggestion_id"
    2268. ],
    2269. "accepted":[
    2270.  
    2271. ]
    2272. }
    2273. },
    2274. "CREATE":{
    2275. "perms":{
    2276. "module":"",
    2277. "level":5,
    2278. "private":1
    2279. },
    2280. "variables":{
    2281. "required":{
    2282. "lang_suggestion_id":"int",
    2283. "0":"mode"
    2284. },
    2285. "accepted":[
    2286.  
    2287. ]
    2288. }
    2289. }
    2290. },
    2291. "user":{
    2292. "GET":{
    2293. "perms":{
    2294. "module":"",
    2295. "level":5,
    2296. "private":1
    2297. },
    2298. "variables":{
    2299. "required":[
    2300.  
    2301. ],
    2302. "accepted":[
    2303.  
    2304. ]
    2305. }
    2306. }
    2307. },
    2308. "originals":{
    2309. "GET":{
    2310. "perms":{
    2311. "module":"",
    2312. "level":"",
    2313. "private":1
    2314. },
    2315. "variables":{
    2316. "required":[
    2317. "code"
    2318. ],
    2319. "accepted":[
    2320. "filters",
    2321. "orig_id"
    2322. ]
    2323. }
    2324. }
    2325. },
    2326. "filters":{
    2327. "GET":{
    2328. "perms":{
    2329. "module":"",
    2330. "level":"",
    2331. "private":1
    2332. },
    2333. "variables":{
    2334. "required":[
    2335.  
    2336. ],
    2337. "accepted":[
    2338.  
    2339. ]
    2340. }
    2341. }
    2342. },
    2343. "search":{
    2344. "GET":{
    2345. "perms":{
    2346. "module":"",
    2347. "level":"",
    2348. "private":1
    2349. },
    2350. "variables":{
    2351. "required":[
    2352. "query",
    2353. "code"
    2354. ],
    2355. "accepted":[
    2356.  
    2357. ]
    2358. }
    2359. }
    2360. }
    2361. }
    2362. },
    2363. "token":null
    2364. }

    GET STARTED NOW

    Free Trial. No Credit Card Required.

    close
    (e.g.+14158675309 or +1415-8675-309)

    By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

    Have a promotional code?Click Here


    LIVE CHAT DEMO REQUEST!

    Please provide information below.

    close
    INSTANT DEMOSCHEDULED DEMO
    Connect with a ShiftPlanning Team Member for a live demo right now!
     

    RESELLER REQUEST!

    Please provide information below.

    close