Xojo Plugin Box: Get Folder Collaborations

Back to Index

Returns all of the folder's collaborations. This API does not support paging -- it always returns all of the collaborations. Each collaboration object has details on which user or group has access to the file and with what role.

Documentation: https://developer.box.com/reference#view-a-folders-collaborations

CURL Command

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

Xojo Plugin Example

Dim rest As New Chilkat.Rest
Dim success As Boolean

//  URL: https://api.box.com/2.0/folders/FOLDER_ID/collaborations
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("api.box.com",port,bTls,bAutoReconnect)
If (success <> True) Then
    System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/2.0/folders/FOLDER_ID/collaborations",sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim jsonResponse As New Chilkat.JsonObject
jsonResponse.LoadSb(sbResponseBody)

Dim total_count As Int32
Dim i As Int32
Dim count_i As Int32
Dim type As String
Dim id As String
Dim created_byType As String
Dim created_byId As String
Dim created_byName As String
Dim created_byLogin As String
Dim created_at As String
Dim modified_at As String
Dim expires_at As Boolean
Dim status As String
Dim accessible_byType As String
Dim accessible_byId As String
Dim accessible_byName As String
Dim accessible_byLogin As String
Dim role As String
Dim acknowledged_at As String
Dim item As Boolean

total_count = jsonResponse.IntOf("total_count")
i = 0
count_i = jsonResponse.SizeOfArray("entries")
While i < count_i
    jsonResponse.I = i
    type = jsonResponse.StringOf("entries[i].type")
    id = jsonResponse.StringOf("entries[i].id")
    created_byType = jsonResponse.StringOf("entries[i].created_by.type")
    created_byId = jsonResponse.StringOf("entries[i].created_by.id")
    created_byName = jsonResponse.StringOf("entries[i].created_by.name")
    created_byLogin = jsonResponse.StringOf("entries[i].created_by.login")
    created_at = jsonResponse.StringOf("entries[i].created_at")
    modified_at = jsonResponse.StringOf("entries[i].modified_at")
    expires_at = jsonResponse.IsNullOf("entries[i].expires_at")
    status = jsonResponse.StringOf("entries[i].status")
    accessible_byType = jsonResponse.StringOf("entries[i].accessible_by.type")
    accessible_byId = jsonResponse.StringOf("entries[i].accessible_by.id")
    accessible_byName = jsonResponse.StringOf("entries[i].accessible_by.name")
    accessible_byLogin = jsonResponse.StringOf("entries[i].accessible_by.login")
    role = jsonResponse.StringOf("entries[i].role")
    acknowledged_at = jsonResponse.StringOf("entries[i].acknowledged_at")
    item = jsonResponse.IsNullOf("entries[i].item")
    i = i + 1
Wend

Sample JSON Response Body

{
  "total_count": 1,
  "entries": [
    {
      "type": "collaboration",
      "id": "14176246",
      "created_by": {
        "type": "user",
        "id": "4276790",
        "name": "David Lee",
        "login": "david@box.com"
      },
      "created_at": "2011-11-29T12:56:35-08:00",
      "modified_at": "2012-09-11T15:12:32-07:00",
      "expires_at": null,
      "status": "accepted",
      "accessible_by": {
        "type": "user",
        "id": "755492",
        "name": "Simon Tan",
        "login": "simon@box.net"
      },
      "role": "editor",
      "acknowledged_at": "2011-11-29T12:59:40-08:00",
      "item": null
    }
  ]
}