DataFlex

Yousign: Download Information about Previously Uploaded File

See more Yousign Examples

Demonstrates how to download the information (in JSON format) about a file previously uploaded. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoHttp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sName
    String sV_type
    String sContentType
    String sDescription
    String sCreatedAt
    String sUpdatedAt
    String sSha256
    String sWorkspace
    String sCreator
    Boolean iV_protected
    Integer iPosition
    String sParent
    Integer i
    Integer iCount_i
    String sTemp1

    Move False To iSuccess

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Implements the following CURL command:

    // curl --location --request GET 'https://staging-api.yousign.com/files/{{id}}' \
    // --header 'Authorization: Bearer YOUR_API_KEY' \
    // --header 'Content-Type: application/json'

    // Use the following online tool to generate HTTP code from a CURL command
    // Convert a cURL Command to HTTP Source Code

    // Adds the "Authorization: Bearer YOUR_API_KEY" header.
    Set ComAuthToken Of hoHttp To "YOUR_API_KEY"
    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    //   "name": "The best name for my file.pdf",
    //   "type": "signable",
    //   "contentType": "application/pdf",
    //   "description": null,
    //   "createdAt": "2018-12-07T08:10:21+01:00",
    //   "updatedAt": "2018-12-07T08:10:21+01:00",
    //   "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
    //   "metadata": [
    //   ],
    //   "workspace": "/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    //   "creator": null,
    //   "protected": false,
    //   "position": 0,
    //   "parent": null
    // }

    // Sample code for parsing the JSON response...
    // Use the following online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    Get ComStringOf Of hoJResp "id" To sId
    Get ComStringOf Of hoJResp "name" To sName
    Get ComStringOf Of hoJResp "type" To sV_type
    Get ComStringOf Of hoJResp "contentType" To sContentType
    Get ComStringOf Of hoJResp "description" To sDescription
    Get ComStringOf Of hoJResp "createdAt" To sCreatedAt
    Get ComStringOf Of hoJResp "updatedAt" To sUpdatedAt
    Get ComStringOf Of hoJResp "sha256" To sSha256
    Get ComStringOf Of hoJResp "workspace" To sWorkspace
    Get ComStringOf Of hoJResp "creator" To sCreator
    Get ComBoolOf Of hoJResp "protected" To iV_protected
    Get ComIntOf Of hoJResp "position" To iPosition
    Get ComStringOf Of hoJResp "parent" To sParent
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "metadata" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Move (i + 1) To i
    Loop



End_Procedure