Swift Box: Get Folder Items

Back to Index

Gets all of the files, folders, or web links contained within a folder.

Documentation: https://developer.box.com/reference#get-a-folders-items

CURL Command

curl https://api.box.com/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0 \
-H "Authorization: Bearer BOX_ACCESS_TOKEN"

Swift Example

func chilkatTest() {
    let rest = CkoRest()
    var success: Bool

    //  URL: https://api.box.com/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.Connect("api.box.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("ConnectFailReason: \(rest.ConnectFailReason.intValue)")
        print("\(rest.LastErrorText)")
        return
    }

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

    let sbResponseBody = CkoStringBuilder()
    success = rest.FullRequestNoBodySb("GET", uriPath: "/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0", sb: sbResponseBody)
    if success != true {
        print("\(rest.LastErrorText)")
        return
    }

    let jsonResponse = CkoJsonObject()
    jsonResponse.LoadSb(sbResponseBody)

    var total_count: Int
    var offset: Int
    var limit: Int
    var i: Int
    var count_i: Int
    var type: String?
    var id: String?
    var file_versionType: String?
    var file_versionId: String?
    var file_versionSha1: String?
    var sequence_id: String?
    var etag: String?
    var sha1: String?
    var name: String?
    var by: String?
    var direction: String?

    total_count = jsonResponse.IntOf("total_count").intValue
    offset = jsonResponse.IntOf("offset").intValue
    limit = jsonResponse.IntOf("limit").intValue
    i = 0
    count_i = jsonResponse.SizeOfArray("entries").intValue
    while i < count_i {
        jsonResponse.I = i
        type = jsonResponse.StringOf("entries[i].type")
        id = jsonResponse.StringOf("entries[i].id")
        file_versionType = jsonResponse.StringOf("entries[i].file_version.type")
        file_versionId = jsonResponse.StringOf("entries[i].file_version.id")
        file_versionSha1 = jsonResponse.StringOf("entries[i].file_version.sha1")
        sequence_id = jsonResponse.StringOf("entries[i].sequence_id")
        etag = jsonResponse.StringOf("entries[i].etag")
        sha1 = jsonResponse.StringOf("entries[i].sha1")
        name = jsonResponse.StringOf("entries[i].name")
        i = i + 1
    }

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


}

Sample JSON Response Body

{
  "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": 2,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    },
    {
      "by": "name",
      "direction": "ASC"
    }
  ]
}