PureBasic Dropbox: Dropbox Delete a File

Back to Index

Deletes a file on Dropbox

Documentation: https://www.dropbox.com/developers/documentation/http/documentation#files-delete

CURL Command

curl -X POST https://api.dropboxapi.com/2/files/delete_v2 \
    --header "Authorization: Bearer DROPBOX-ACCESS-TOKEN" \
    --header "Content-Type: application/json" \
    --data "{\"path\": \"/Homework/math/Prime_Numbers.txt\"}"

PureBasic Example

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ;  URL: https://api.dropboxapi.com/2/files/delete_v2
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"api.dropboxapi.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ;  See the Online Tool for Generating JSON Creation Code
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"path","/Homework/math/Prime_Numbers.txt")

    CkRest::ckAddHeader(rest,"Authorization","Bearer DROPBOX-ACCESS-TOKEN")
    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/2/files/delete_v2",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    If respStatusCode >= 400
        Debug "Response Status Code = " + Str(respStatusCode)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    ;  See the Online Tool for Generating JSON Parse Code
    i.i
    count_i.i
    j.i
    count_j.i

    metadataTag.s = CkJsonObject::ckStringOf(jsonResponse,"metadata." + Chr(34) + ".tag" + Chr(34))
    metadataName.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.name")
    metadataId.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.id")
    metadataClient_modified.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.client_modified")
    metadataServer_modified.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.server_modified")
    metadataRev.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.rev")
    metadataSize.i = CkJsonObject::ckIntOf(jsonResponse,"metadata.size")
    metadataPath_lower.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.path_lower")
    metadataPath_display.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.path_display")
    metadataSharing_infoRead_only.i = CkJsonObject::ckBoolOf(jsonResponse,"metadata.sharing_info.read_only")
    metadataSharing_infoParent_shared_folder_id.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.sharing_info.parent_shared_folder_id")
    metadataSharing_infoModified_by.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.sharing_info.modified_by")
    metadataHas_explicit_shared_members.i = CkJsonObject::ckBoolOf(jsonResponse,"metadata.has_explicit_shared_members")
    metadataContent_hash.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.content_hash")
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"metadata.property_groups")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        template_id.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.property_groups[i].template_id")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jsonResponse,"metadata.property_groups[i].fields")
        While j < count_j
            CkJsonObject::setCkJ(jsonResponse, j)
            name.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.property_groups[i].fields[j].name")
            value.s = CkJsonObject::ckStringOf(jsonResponse,"metadata.property_groups[i].fields[j].value")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure

Sample JSON Response Body

{
  "metadata": {
    ".tag": "file",
    "name": "Prime_Numbers.txt",
    "id": "id:a4ayc_80_OEAAAAAAAAAXw",
    "client_modified": "2015-05-12T15:50:38Z",
    "server_modified": "2015-05-12T15:50:38Z",
    "rev": "a1c10ce0dd78",
    "size": 7212,
    "path_lower": "/homework/math/prime_numbers.txt",
    "path_display": "/Homework/math/Prime_Numbers.txt",
    "sharing_info": {
      "read_only": true,
      "parent_shared_folder_id": "84528192421",
      "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc"
    },
    "property_groups": [
      {
        "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa",
        "fields": [
          {
            "name": "Security Policy",
            "value": "Confidential"
          }
        ]
      }
    ],
    "has_explicit_shared_members": false,
    "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
  }
}