Sample code for 30+ languages & platforms
PureBasic

Xero Get Payroll Employees

See more Xero Examples

Download Xero employees information

Chilkat PureBasic Downloads

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")

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

    success = CkHttp::ckHttpNoBody(http,"GET","https://api.xero.com/payroll.xro/1.0/Employees",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))

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

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

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

    ; Sample response
    ; (See the parsing code below..)
    ; 
    ; Use the this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    ; {
    ;   "Id": "796cae61-a7c3-425b-a621-372ab1f29460",
    ;   "Status": "OK",
    ;   "ProviderName": "Chilkat2222",
    ;   "DateTimeUTC": "\/Date(1587075322768)\/",
    ;   "Employees": [
    ;     {
    ;       "EmployeeID": "f12e3b0b-4b4c-4523-b8c0-f481a07bfd13",
    ;       "FirstName": "James",
    ;       "LastName": "Lebron",
    ;       "Status": "ACTIVE",
    ;       "Email": "JL@madeup.email.com",
    ;       "DateOfBirth": "\/Date(492739200000+0000)\/",
    ;       "Gender": "M",
    ;       "Phone": "0400-000-123",
    ;       "Mobile": " 408-230-9732",
    ;       "StartDate": "\/Date(1548806400000+0000)\/",
    ;       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
    ;       "PayrollCalendarID": "2cf6326a-d48b-41bf-bf36-7a73b42dd71b",
    ;       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
    ;     },
    ;     {
    ;       "EmployeeID": "d9f5979f-1de8-4040-aa1d-f1fdd327f893",
    ;       "FirstName": "Odette",
    ;       "LastName": "Garrison",
    ;       "Status": "ACTIVE",
    ;       "Email": "ogg@madeup.email.com",
    ;       "DateOfBirth": "\/Date(390528000000+0000)\/",
    ;       "Gender": "F",
    ;       "Phone": "9000 1234",
    ;       "StartDate": "\/Date(1554422400000+0000)\/",
    ;       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
    ;       "PayrollCalendarID": "ec0f2f68-f4d1-4490-af70-78e5d7f5dcbd",
    ;       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
    ;     },
    ;     {
    ;       "EmployeeID": "22879fb4-d13b-46ed-9c07-e43aba25b576",
    ;       "FirstName": "Oliver",
    ;       "LastName": "Gray",
    ;       "Status": "ACTIVE",
    ;       "Email": "og@madeup.email.com",
    ;       "DateOfBirth": "\/Date(94176000000+0000)\/",
    ;       "Gender": "M",
    ;       "Phone": "0401 123 456",
    ;       "StartDate": "\/Date(1562112000000+0000)\/",
    ;       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
    ;       "PayrollCalendarID": "2cf6326a-d48b-41bf-bf36-7a73b42dd71b",
    ;       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
    ;     },
    ;     {
    ;       "EmployeeID": "c4d82c18-b1a9-4b6c-982c-14b45b95c10a",
    ;       "FirstName": "Sally ",
    ;       "LastName": "Martin",
    ;       "Status": "ACTIVE",
    ;       "Email": "sm@madeup3993.com",
    ;       "DateOfBirth": "\/Date(659577600000+0000)\/",
    ;       "Gender": "F",
    ;       "Phone": "0400 123 456",
    ;       "StartDate": "\/Date(1577750400000+0000)\/",
    ;       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
    ;       "PayrollCalendarID": "2cf6326a-d48b-41bf-bf36-7a73b42dd71b",
    ;       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
    ;     },
    ;     {
    ;       "EmployeeID": "e1a5eed0-721e-482d-b1f1-0b73506f26fb",
    ;       "FirstName": "Sonia",
    ;       "LastName": "Michaels",
    ;       "Status": "ACTIVE",
    ;       "Email": "som@madeup3993.com",
    ;       "DateOfBirth": "\/Date(727660800000+0000)\/",
    ;       "Gender": "F",
    ;       "Phone": "02 2345 6789",
    ;       "Mobile": " ",
    ;       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
    ;     },
    ;     {
    ;       "EmployeeID": "882587ac-1cfe-4f55-9b37-932b0705cd04",
    ;       "FirstName": "Tracy",
    ;       "LastName": "Green",
    ;       "Status": "ACTIVE",
    ;       "Email": "tg@madeup.email.com",
    ;       "DateOfBirth": "\/Date(712886400000+0000)\/",
    ;       "Gender": "F",
    ;       "Phone": "0402 123 456",
    ;       "StartDate": "\/Date(1556755200000+0000)\/",
    ;       "OrdinaryEarningsRateID": "e648f7bf-af43-41bc-98ea-e7ca94c3e3b1",
    ;       "PayrollCalendarID": "ec0f2f68-f4d1-4490-af70-78e5d7f5dcbd",
    ;       "UpdatedDateUTC": "\/Date(1587075120000+0000)\/"
    ;     }
    ;   ]
    ; }

    EmployeeID.s
    FirstName.s
    LastName.s
    v_Email.s
    DateOfBirth.s
    Gender.s
    Phone.s
    Mobile.s
    StartDate.s
    OrdinaryEarningsRateID.s
    PayrollCalendarID.s
    UpdatedDateUTC.s

    Id.s = CkJsonObject::ckStringOf(json,"Id")
    Status.s = CkJsonObject::ckStringOf(json,"Status")
    ProviderName.s = CkJsonObject::ckStringOf(json,"ProviderName")
    DateTimeUTC.s = CkJsonObject::ckStringOf(json,"DateTimeUTC")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(json,"Employees")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        EmployeeID = CkJsonObject::ckStringOf(json,"Employees[i].EmployeeID")
        FirstName = CkJsonObject::ckStringOf(json,"Employees[i].FirstName")
        LastName = CkJsonObject::ckStringOf(json,"Employees[i].LastName")
        Status = CkJsonObject::ckStringOf(json,"Employees[i].Status")
        v_Email = CkJsonObject::ckStringOf(json,"Employees[i].Email")
        DateOfBirth = CkJsonObject::ckStringOf(json,"Employees[i].DateOfBirth")
        Gender = CkJsonObject::ckStringOf(json,"Employees[i].Gender")
        Phone = CkJsonObject::ckStringOf(json,"Employees[i].Phone")
        Mobile = CkJsonObject::ckStringOf(json,"Employees[i].Mobile")
        StartDate = CkJsonObject::ckStringOf(json,"Employees[i].StartDate")
        OrdinaryEarningsRateID = CkJsonObject::ckStringOf(json,"Employees[i].OrdinaryEarningsRateID")
        PayrollCalendarID = CkJsonObject::ckStringOf(json,"Employees[i].PayrollCalendarID")
        UpdatedDateUTC = CkJsonObject::ckStringOf(json,"Employees[i].UpdatedDateUTC")
        i = i + 1
    Wend


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


    ProcedureReturn
EndProcedure