version 8.3.8

Back |

WsFolder

URL

de.piksel.tech/services/index.php?&mode=json

Use "request" param as post variable for submitting json/xml request payload for all POST requests.

Request Headers

Name

Parameters

name => Name of the folder

description => description of the folder.

shared_clients => Array of clients ids with which the folder needs to be shared. Folder can only be shared with child clients of a given account/client

Request

Add a new folder to an account

Request format

{
  "request": {
    "authentication": {
      "app_token": "7cd207c2-6808-11e3-b865-22000a8a28ea",
      "client_token": "d4c1b92c0acb102ba3e10015c5f061d1",
      "user_token": "f277cb9d46e45f67f44de949cdde110f"
    },
    "header": {
      "header_version": 1,
      "api_version": "5",
      "no_cache": true
    },
    "ws_folder": {
      "name": "cdscds",
      "description": "description",
      "shared_clients": [
        3848
      ]
    }
  }
}

Test Example

{ "request": { "authentication": { "app_token": "#app_token#", "client_token": "#client_token#", "user_token": "#user_token#" }, "header": { "header_version": 1, "api_version": "5", "no_cache": true }, "ws_folder": { "name": "cdscds", "description": "description", "shared_clients": [ 3848 ] } } }

Response

Response format

{
  "response": {
    "success": {
      "code": 530,
      "message": "Folder Created\/Updated",
      "details": ""
    },
    "WsFolderResponse": {
      "folder": {
        "id": 14579,
        "name": "cdscds",
        "description": "description",
        "clientid": 73,
        "lastModified": "2014-04-29T17:13:09Z",
        "shared_clients": [
          "3848"
        ]
      }
    }
  }
}