Visual Basic 6.0 Box: Copy Folder

Back to Index

Used to create a copy of a folder in another folder. The original version of the folder will not be altered. The a response status code of 202 is expected for success.

Documentation: https://developer.box.com/reference#copy-a-folder

CURL Command

curl https://api.box.com/2.0/folders/FOLDER_ID/copy \
-H "Authorization: Bearer BOX_ACCESS_TOKEN" \
-d '{"parent": {"id" : DESTINATION_FOLDER_ID}}' \
-X POST

Visual Basic 6.0 Example

Dim rest As New ChilkatRest
Dim success As Long

'  URL: https://api.box.com/2.0/folders/FOLDER_ID/copy
Dim bTls As Long
bTls = 1
Dim port As Long
port = 443
Dim bAutoReconnect As Long
bAutoReconnect = 1
success = rest.Connect("api.box.com",port,bTls,bAutoReconnect)
If (success <> 1) Then
    Debug.Print "ConnectFailReason: " & rest.ConnectFailReason
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim json As New ChilkatJsonObject
success = json.UpdateNumber("parent.id","DESTINATION_FOLDER_ID")

success = rest.AddHeader("Authorization","Bearer BOX_ACCESS_TOKEN")

Dim sbRequestBody As New ChilkatStringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New ChilkatStringBuilder
success = rest.FullRequestSb("POST","/2.0/folders/FOLDER_ID/copy",sbRequestBody,sbResponseBody)
If (success <> 1) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim jsonResponse As New ChilkatJsonObject
success = jsonResponse.LoadSb(sbResponseBody)

Dim type As String
Dim id As String
Dim sequence_id As String
Dim etag As String
Dim name As String
Dim created_at As String
Dim modified_at As String
Dim description As String
Dim size As Long
Dim path_collectionTotal_count As Long
Dim created_byType As String
Dim created_byId As String
Dim created_byName As String
Dim created_byLogin As String
Dim modified_byType As String
Dim modified_byId As String
Dim modified_byName As String
Dim modified_byLogin As String
Dim owned_byType As String
Dim owned_byId As String
Dim owned_byName As String
Dim owned_byLogin As String
Dim shared_linkUrl As String
Dim shared_linkDownload_url As Long
Dim shared_linkVanity_url As Long
Dim shared_linkIs_password_enabled As Long
Dim shared_linkUnshared_at As Long
Dim shared_linkDownload_count As Long
Dim shared_linkPreview_count As Long
Dim shared_linkAccess As String
Dim shared_linkPermissionsCan_download As Long
Dim shared_linkPermissionsCan_preview As Long
Dim folder_upload_emailAccess As String
Dim folder_upload_emailEmail As String
Dim parentType As String
Dim parentId As String
Dim parentSequence_id As Long
Dim parentEtag As Long
Dim parentName As String
Dim item_status As String
Dim item_collectionTotal_count As Long
Dim item_collectionOffset As Long
Dim item_collectionLimit As Long
Dim i As Long
Dim count_i As Long
Dim sequence_id_bool As Long
Dim etag_bool As Long
Dim sha1 As String

type = jsonResponse.StringOf("type")
id = jsonResponse.StringOf("id")
sequence_id = jsonResponse.StringOf("sequence_id")
etag = jsonResponse.StringOf("etag")
name = jsonResponse.StringOf("name")
created_at = jsonResponse.StringOf("created_at")
modified_at = jsonResponse.StringOf("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")
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_linkUrl = jsonResponse.StringOf("shared_link.url")
shared_linkDownload_url = jsonResponse.IsNullOf("shared_link.download_url")
shared_linkVanity_url = jsonResponse.IsNullOf("shared_link.vanity_url")
shared_linkIs_password_enabled = jsonResponse.BoolOf("shared_link.is_password_enabled")
shared_linkUnshared_at = jsonResponse.IsNullOf("shared_link.unshared_at")
shared_linkDownload_count = jsonResponse.IntOf("shared_link.download_count")
shared_linkPreview_count = jsonResponse.IntOf("shared_link.preview_count")
shared_linkAccess = jsonResponse.StringOf("shared_link.access")
shared_linkPermissionsCan_download = jsonResponse.BoolOf("shared_link.permissions.can_download")
shared_linkPermissionsCan_preview = jsonResponse.BoolOf("shared_link.permissions.can_preview")
folder_upload_emailAccess = jsonResponse.StringOf("folder_upload_email.access")
folder_upload_emailEmail = jsonResponse.StringOf("folder_upload_email.email")
parentType = jsonResponse.StringOf("parent.type")
parentId = jsonResponse.StringOf("parent.id")
parentSequence_id = jsonResponse.IsNullOf("parent.sequence_id")
parentEtag = jsonResponse.IsNullOf("parent.etag")
parentName = jsonResponse.StringOf("parent.name")
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")
Do While i < count_i
    jsonResponse.I = i
    type = jsonResponse.StringOf("path_collection.entries[i].type")
    id = jsonResponse.StringOf("path_collection.entries[i].id")
    sequence_id_bool = jsonResponse.IsNullOf("path_collection.entries[i].sequence_id")
    etag_bool = jsonResponse.IsNullOf("path_collection.entries[i].etag")
    name = jsonResponse.StringOf("path_collection.entries[i].name")
    i = i + 1
Loop
i = 0
count_i = jsonResponse.SizeOfArray("item_collection.entries")
Do While i < count_i
    jsonResponse.I = i
    type = jsonResponse.StringOf("item_collection.entries[i].type")
    id = jsonResponse.StringOf("item_collection.entries[i].id")
    sequence_id = jsonResponse.StringOf("item_collection.entries[i].sequence_id")
    etag = 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
Loop

Sample JSON Response Body

{
  "type": "folder",
  "id": "11446498",
  "sequence_id": "1",
  "etag": "1",
  "name": "Pictures",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T11:15:04-08:00",
  "description": "Some pictures I took",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "0",
        "sequence_id": null,
        "etag": null,
        "name": "All Files"
      }
    ]
  },
  "created_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "modified_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "owned_by": {
    "type": "user",
    "id": "17738362",
    "name": "sean rose",
    "login": "sean@box.com"
  },
  "shared_link": {
    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
    "download_url": null,
    "vanity_url": null,
    "is_password_enabled": false,
    "unshared_at": null,
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_download": true,
      "can_preview": true
    }
  },
  "folder_upload_email": {
    "access": "open",
    "email": "upload.Picture.k13sdz1@u.box.com"
  },
  "parent": {
    "type": "folder",
    "id": "0",
    "sequence_id": null,
    "etag": null,
    "name": "All Files"
  },
  "item_status": "active",
  "item_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "file",
        "id": "5000948880",
        "sequence_id": "3",
        "etag": "3",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
        "name": "tigers.jpeg"
      }
    ],
    "offset": 0,
    "limit": 100
  }
}