C# Box: Get Root Folder Info

Back to Index

Gets the folder info for the root folder of a Box.com account. The root folder of a box.com account always has an id = "0".

Documentation: https://developer.box.com/reference#get-folder-info

CURL Command

curl https://api.box.com/2.0/folders/0 \
-H "Authorization: Bearer BOX_ACCESS_TOKEN" \

C# Example

Chilkat.Rest rest = new Chilkat.Rest();
bool success;

//  URL: https://api.box.com/2.0/folders/0
bool bTls = true;
int port = 443;
bool bAutoReconnect = true;
success = rest.Connect("api.box.com",port,bTls,bAutoReconnect);
if (success != true) {
    Debug.WriteLine("ConnectFailReason: " + Convert.ToString(rest.ConnectFailReason));
    Debug.WriteLine(rest.LastErrorText);
    return;
}

rest.AddHeader("Authorization","Bearer BOX_ACCESS_TOKEN");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = rest.FullRequestNoBodySb("GET","/2.0/folders/0",sbResponseBody);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

Chilkat.JsonObject jsonResponse = new Chilkat.JsonObject();
jsonResponse.LoadSb(sbResponseBody);

string type;
string id;
bool sequence_id;
bool etag;
string name;
bool created_at;
bool modified_at;
string description;
int size;
int path_collectionTotal_count;
string created_byType;
string created_byId;
string created_byName;
string created_byLogin;
string modified_byType;
string modified_byId;
string modified_byName;
string modified_byLogin;
bool trashed_at;
bool purged_at;
bool content_created_at;
bool content_modified_at;
string owned_byType;
string owned_byId;
string owned_byName;
string owned_byLogin;
bool shared_link;
bool folder_upload_email;
bool parent;
string item_status;
int item_collectionTotal_count;
int item_collectionOffset;
int item_collectionLimit;
int i;
int count_i;
string file_versionType;
string file_versionId;
string file_versionSha1;
string sequence_id_str;
string etag_str;
string sha1;
string by;
string direction;

type = jsonResponse.StringOf("type");
id = jsonResponse.StringOf("id");
sequence_id = jsonResponse.IsNullOf("sequence_id");
etag = jsonResponse.IsNullOf("etag");
name = jsonResponse.StringOf("name");
created_at = jsonResponse.IsNullOf("created_at");
modified_at = jsonResponse.IsNullOf("modified_at");
description = jsonResponse.StringOf("description");
size = jsonResponse.IntOf("size");
path_collectionTotal_count = jsonResponse.IntOf("path_collection.total_count");
created_byType = jsonResponse.StringOf("created_by.type");
created_byId = jsonResponse.StringOf("created_by.id");
created_byName = jsonResponse.StringOf("created_by.name");
created_byLogin = jsonResponse.StringOf("created_by.login");
modified_byType = jsonResponse.StringOf("modified_by.type");
modified_byId = jsonResponse.StringOf("modified_by.id");
modified_byName = jsonResponse.StringOf("modified_by.name");
modified_byLogin = jsonResponse.StringOf("modified_by.login");
trashed_at = jsonResponse.IsNullOf("trashed_at");
purged_at = jsonResponse.IsNullOf("purged_at");
content_created_at = jsonResponse.IsNullOf("content_created_at");
content_modified_at = jsonResponse.IsNullOf("content_modified_at");
owned_byType = jsonResponse.StringOf("owned_by.type");
owned_byId = jsonResponse.StringOf("owned_by.id");
owned_byName = jsonResponse.StringOf("owned_by.name");
owned_byLogin = jsonResponse.StringOf("owned_by.login");
shared_link = jsonResponse.IsNullOf("shared_link");
folder_upload_email = jsonResponse.IsNullOf("folder_upload_email");
parent = jsonResponse.IsNullOf("parent");
item_status = jsonResponse.StringOf("item_status");
item_collectionTotal_count = jsonResponse.IntOf("item_collection.total_count");
item_collectionOffset = jsonResponse.IntOf("item_collection.offset");
item_collectionLimit = jsonResponse.IntOf("item_collection.limit");
i = 0;
count_i = jsonResponse.SizeOfArray("path_collection.entries");
while (i < count_i) {
    jsonResponse.I = i;
    i = i + 1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("item_collection.entries");
while (i < count_i) {
    jsonResponse.I = i;
    type = jsonResponse.StringOf("item_collection.entries[i].type");
    id = jsonResponse.StringOf("item_collection.entries[i].id");
    file_versionType = jsonResponse.StringOf("item_collection.entries[i].file_version.type");
    file_versionId = jsonResponse.StringOf("item_collection.entries[i].file_version.id");
    file_versionSha1 = jsonResponse.StringOf("item_collection.entries[i].file_version.sha1");
    sequence_id_str = jsonResponse.StringOf("item_collection.entries[i].sequence_id");
    etag_str = jsonResponse.StringOf("item_collection.entries[i].etag");
    sha1 = jsonResponse.StringOf("item_collection.entries[i].sha1");
    name = jsonResponse.StringOf("item_collection.entries[i].name");
    i = i + 1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("item_collection.order");
while (i < count_i) {
    jsonResponse.I = i;
    by = jsonResponse.StringOf("item_collection.order[i].by");
    direction = jsonResponse.StringOf("item_collection.order[i].direction");
    i = i + 1;
}

Sample JSON Response Body

{
  "type": "folder",
  "id": "0",
  "sequence_id": null,
  "etag": null,
  "name": "All Files",
  "created_at": null,
  "modified_at": null,
  "description": "",
  "size": 826408,
  "path_collection": {
    "total_count": 0,
    "entries": [
    ]
  },
  "created_by": {
    "type": "user",
    "id": "",
    "name": "",
    "login": ""
  },
  "modified_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "trashed_at": null,
  "purged_at": null,
  "content_created_at": null,
  "content_modified_at": null,
  "owned_by": {
    "type": "user",
    "id": "2787704945",
    "name": "chilkat",
    "login": "AutomationUser_434741_3nmGYSS7o5@@boxdevedition.com"
  },
  "shared_link": null,
  "folder_upload_email": null,
  "parent": null,
  "item_status": "active",
  "item_collection": {
    "total_count": 2,
    "entries": [
      {
        "type": "file",
        "id": "246181882790",
        "file_version": {
          "type": "file_version",
          "id": "259636211878",
          "sha1": "c9d2492fb97f88a9b4d1e35f32a3410e95853f18"
        },
        "sequence_id": "0",
        "etag": "0",
        "sha1": "c9d2492fb97f88a9b4d1e35f32a3410e95853f18",
        "name": "hedgehogs.jpg"
      },
      {
        "type": "file",
        "id": "246167973161",
        "file_version": {
          "type": "file_version",
          "id": "259621592361",
          "sha1": "df7be9dc4f467187783aca68c7ce98e4df2172d0"
        },
        "sequence_id": "0",
        "etag": "0",
        "sha1": "df7be9dc4f467187783aca68c7ce98e4df2172d0",
        "name": "penguins.jpg"
      }
    ],
    "offset": 0,
    "limit": 100,
    "order": [
      {
        "by": "type",
        "direction": "ASC"
      },
      {
        "by": "name",
        "direction": "ASC"
      }
    ]
  }
}