Api doc


SDK's


Api Modules

admin.backup

Allows for retrieving and setting details on any given backup file.



Supported Methods:

GET
Params
  • token (Required): valid token
  • id (Required): integer


DELETE
Params
  • token (Required): valid token
  • id (Required): integer


CREATE
Params
  • token (Required): valid token
  • filename (Required): varchar
  • filedata (Required): varchar
  • filelength (Required): varchar
  • mimetype (Required): varchar
  • name: varchar
  • description: varchar


Documentation

GET
Retrieving details of any given backup file.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "id": required //Backup file id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"admin.backup",
  3. "method":"GET",
  4. "request":{
  5. "id":"445"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"445",
  5. "name":"",
  6. "description":"",
  7. "filename":"backup",
  8. "date":"1339674939",
  9. "file_size":"128",
  10. "num_downloads":"0",
  11. "filetype":"mime",
  12. "extension":"backup",
  13. "url":"http:\/\/www.humanity.com\/api\/file\/445.53718",
  14. "secureurl":"http:\/\/www.humanity.com\/app\/admin\/file.php?fid=NDQ1"
  15. },
  16. "token":"xxxxxxx"
  17. }

---

CREATE
Creates new backup file and backup file details.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "filename": required //File name (varchar)
  2. "filedata": required //File data (varchar)
  3. "filelength": required //File length (integer)
  4. "mimetype": required //Describes the type of data which is being sent (varchar)
  5. "name": accepted //Name (varchar)
  6. "description": accepted //Description (varchar)
  7. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"admin.backup",
  3. "method":"CREATE",
  4. "request":{
  5. "filename":"File",
  6. "filelength":"128",
  7. "mimetype":"type",
  8. "filedata":"data"
  9. }
  10. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"",
  4. "token":"xxxxxxx"
  5. }

---

DELETE
Deletes any given backup file and backup file details.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "id": required //File id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"admin.backup",
  3. "method":"DELETE",
  4. "request":{
  5. "id":"545"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"",
  4. "token":"xxxxxxx"
  5. }

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