(DataFlex) Xero Get Attachment (Download a Xero Attachment)

Demonstrates how to get the content of an attachment in Xero.

Note: This example requires Chilkat v9.5.0.64 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoRest
    Boolean iSuccess
    String sEndPoint
    String sReceiptID
    Variant vSbPath
    Handle hoSbPath
    Integer iNumReplaced
    String sResponseXml
    Handle hoXml
    Integer iNumRecords
    Handle hoSbSaveFilePath
    Handle hoSbAttachmentPath
    Variant vAttachmentData
    Handle hoAttachmentData
    Integer i
    String sAttachmentID
    String sFilename
    Integer iStatusCode
    String sResponseBody
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    // Note: Requires Chilkat v9.5.0.64 or greater.

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

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // Before sending REST API calls, the REST object needs to be
    // initialized for OAuth1.
    // See Xero 2-Legged OAuth1 Setup for sample code.

    // Assuming the REST object's OAuth1 authenticator is setup, and the initial
    // connection was made, we may now send REST HTTP requests..

    // --------------------------------------------------------------
    // First get a list of attachments for a given document (in this case a Receipt).

    Move "Receipts" To sEndPoint
    Move "c4f40e59-c390-0001-caff-ce731c707d00" To sReceiptID

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
    If (Not(IsComObjectCreated(hoSbPath))) Begin
        Send CreateComObject of hoSbPath
    End
    Get ComAppend Of hoSbPath "/api.xro/2.0/{Endpoint}/{Guid}/Attachments/" To iSuccess
    Get ComReplace Of hoSbPath "{Endpoint}" sEndPoint To iNumReplaced
    Get ComReplace Of hoSbPath "{Guid}" sReceiptID To iNumReplaced

    Get ComGetAsString Of hoSbPath To sTemp1
    Get ComFullRequestNoBody Of hoRest "GET" sTemp1 To sResponseXml
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // A 200 response is expected for actual success.
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        Showln sResponseXml
        Procedure_Return
    End

    // Examine the response.
    Showln sResponseXml

    // A sample response looks like this:

    // 	<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    // 	  <Id>b235646f-34ac-4b15-90ce-d63267f7cd33</Id>
    // 	  <Status>OK</Status>
    // 	  <ProviderName>ChilkatPrivate</ProviderName>
    // 	  <DateTimeUTC>2016-11-11T14:32:17.0908971Z</DateTimeUTC>
    // 	  <Attachments>
    // 	    <Attachment>
    // 	      <AttachmentID>0edcddc8-325f-40c7-b950-8c71f14afc7c</AttachmentID>
    // 	      <FileName>penguins.jpg</FileName>
    // 	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/penguins.jpg</Url>
    // 	      <MimeType>image/jpg</MimeType>
    // 	      <ContentLength>777835</ContentLength>
    // 	    </Attachment>
    // 	    <Attachment>
    // 	      <AttachmentID>0adffdc8-325f-65c7-b950-4391f14af908</AttachmentID>
    // 	      <FileName>starfish.jpg</FileName>
    // 	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/starfish.jpg</Url>
    // 	      <MimeType>image/jpg</MimeType>
    // 	      <ContentLength>24537</ContentLength>
    // 	    </Attachment>
    // 	  </Attachments>
    // 	</Response>

    Get Create (RefClass(cComChilkatXml)) To hoXml
    If (Not(IsComObjectCreated(hoXml))) Begin
        Send CreateComObject of hoXml
    End
    Get ComLoadXml Of hoXml sResponseXml To iSuccess

    // Iterate over the attachments and download each.
    Get ComNumChildrenAt Of hoXml "Attachments" To iNumRecords
    Showln "Number of Attachments = " iNumRecords

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbSaveFilePath
    If (Not(IsComObjectCreated(hoSbSaveFilePath))) Begin
        Send CreateComObject of hoSbSaveFilePath
    End
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAttachmentPath
    If (Not(IsComObjectCreated(hoSbAttachmentPath))) Begin
        Send CreateComObject of hoSbAttachmentPath
    End
    Get Create (RefClass(cComChilkatBinData)) To hoAttachmentData
    If (Not(IsComObjectCreated(hoAttachmentData))) Begin
        Send CreateComObject of hoAttachmentData
    End
    Move 0 To i
    While (i < iNumRecords)
        Set ComI Of hoXml To i
        Get ComGetChildContent Of hoXml "Attachments|Attachment[i]|AttachmentID" To sAttachmentID
        Get ComGetChildContent Of hoXml "Attachments|Attachment[i]|FileName" To sFilename

        Showln "AttachmentID: " sAttachmentID
        Showln "Filename: " sFilename
        Showln "----"

        // Download this attachment.
        // First build the path for this particular attachment by appending the FileName to the path used to get the list of attachments.
        Send ComClear To hoSbAttachmentPath
        Get pvComObject of hoSbPath to vSbPath
        Get ComAppendSb Of hoSbAttachmentPath vSbPath To iSuccess
        Get ComAppend Of hoSbAttachmentPath sFilename To iSuccess

        // Send the GET request in one call, and then get the response in the next two.
        Get ComGetAsString Of hoSbAttachmentPath To sTemp1
        Get ComSendReqNoBody Of hoRest "GET" sTemp1 To iSuccess
        If (iSuccess <> True) Begin
            Get ComLastErrorText Of hoRest To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        // Get the response header.  If it's not a 200 success status code, then the response body does NOT contain
        // the attachment data.
        Get ComReadResponseHeader Of hoRest To iStatusCode
        If (iStatusCode = -1) Begin
            // We didn't get any response..
            Get ComLastErrorText Of hoRest To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        If (iStatusCode <> 200) Begin
            Showln "Response Status: " iStatusCode
            Get ComReadRespBodyString Of hoRest To sResponseBody
            Get ComLastMethodSuccess Of hoRest To bTemp1
            If (bTemp1 <> True) Begin
                Showln "Failed to read the response body."
            End
            Else Begin
                Showln sResponseBody
            End

            Showln "Failed."
            Procedure_Return
        End

        // OK, the response header indicates the attachment content is forthcoming...
        // There are a few ways to get the response body. If it is a very large attachment, it can be streamed directly
        // to a file.  We'll assume it's not, so we'll get the response into a BinData object, and then save it to a file.
        Get ComClear Of hoAttachmentData To iSuccess
        Get pvComObject of hoAttachmentData to vAttachmentData
        Get ComReadRespBd Of hoRest vAttachmentData To iSuccess
        If (iSuccess <> True) Begin
            Get ComLastErrorText Of hoRest To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        // Save the data to the file.
        Get ComSetString Of hoSbSaveFilePath "qa_output/" To iSuccess
        Get ComAppend Of hoSbSaveFilePath sFilename To iSuccess
        Get ComGetAsString Of hoSbSaveFilePath To sTemp1
        Get ComWriteFile Of hoAttachmentData sTemp1 To iSuccess
        If (iSuccess <> True) Begin
            Showln "Failed to save to output file."
        End
        Else Begin
            Get ComGetAsString Of hoSbSaveFilePath To sTemp1
            Showln "Saved to " sTemp1
        End

        Move i + 1 To i
    Loop



End_Procedure