PureBasic

Xero List Attachments for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to get information about the attachments for a particular Xero item. PureBasic

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

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

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/xero-access-token.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonToken)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    ; Replace the value here with an actual tenant ID obtained from this example:
    ; Get Xero Tenant IDs
    CkHttp::ckSetRequestHeader(http,"Xero-tenant-id","83299b9e-5747-4a14-a18a-a6c94f824eb7")

    CkHttp::setCkAccept(http, "application/json")

    url.s = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/"

    ; Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    CkHttp::ckSetUrlVar(http,"Endpoint","Invoices")

    ; Guid is the ID of the item, such as the InvoiceID.
    CkHttp::ckSetUrlVar(http,"Guid","0032f627-3156-4d30-9b1c-4d3b994dc921")

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

    success = CkHttp::ckHttpNoBody(http,"GET",url,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    Debug "Response Status Code: " + Str(CkHttpResponse::ckStatusCode(resp))

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

    CkJsonObject::ckLoad(jsonResponse,CkHttpResponse::ckBodyStr(resp))
    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    Debug CkJsonObject::ckEmit(jsonResponse)

    If CkHttpResponse::ckStatusCode(resp) <> 200
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(jsonToken)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(jsonResponse)
        ProcedureReturn
    EndIf

    ; Sample response:
    ; 
    ; Use the this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    ; {
    ;   "Id": "24bfbcb9-dec9-4d33-835c-8f165d776766",
    ;   "Status": "OK",
    ;   "ProviderName": "Chilkat2222",
    ;   "DateTimeUTC": "\/Date(1587213296972)\/",
    ;   "Attachments": [
    ;     {
    ;       "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
    ;       "FileName": "penguins.jpg",
    ;       "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
    ;       "MimeType": "image/jpg",
    ;       "ContentLength": 777835
    ;     }
    ;   ]
    ; }

    AttachmentID.s
    FileName.s
    v_Url.s
    MimeType.s
    ContentLength.i

    Id.s = CkJsonObject::ckStringOf(jsonResponse,"Id")
    Status.s = CkJsonObject::ckStringOf(jsonResponse,"Status")
    ProviderName.s = CkJsonObject::ckStringOf(jsonResponse,"ProviderName")
    DateTimeUTC.s = CkJsonObject::ckStringOf(jsonResponse,"DateTimeUTC")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResponse,"Attachments")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        AttachmentID = CkJsonObject::ckStringOf(jsonResponse,"Attachments[i].AttachmentID")
        FileName = CkJsonObject::ckStringOf(jsonResponse,"Attachments[i].FileName")
        v_Url = CkJsonObject::ckStringOf(jsonResponse,"Attachments[i].Url")
        MimeType = CkJsonObject::ckStringOf(jsonResponse,"Attachments[i].MimeType")
        ContentLength = CkJsonObject::ckIntOf(jsonResponse,"Attachments[i].ContentLength")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonToken)
    CkHttpResponse::ckDispose(resp)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure