(PureBasic) GeoOp - Get all Jobs

Gets all information about all jobs.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkDtObj.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

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

    ; This example also assumes an OAuth2 access token was previously fetched.
    ; and saved in a JSON file.  

    ; First get our previously obtained access token.
    ; {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":999236}
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/geoop.json")

    ; This example assumes we previously obtained an access token
    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth2::setCkAccessToken(oauth2, CkJsonObject::ckStringOf(jsonToken,"access_token"))

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

    ; Connect to GeoOp and send the following GET request:

    ; GET /users HTTP/1.1
    ; Host: api.geoop.com
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"api.geoop.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide the authentication credentials (i.e. the access token)
    CkRest::ckSetAuthOAuth2(rest,oauth2)

    ; Set the X-Version header.
    CkRest::ckAddHeader(rest,"X-Version","1.0")

    responseBody.s = CkRest::ckFullRequestNoBody(rest,"GET","/jobs")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

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

    CkJsonObject::setCkEmitCompact(json, 0)

    ; If the response status code did not indicate success, then see what happened..
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        CkJsonObject::ckLoad(json,responseBody)
        Debug CkJsonObject::ckEmit(json)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,responseBody)
    ; Show the full JSON response.. (see below)
    Debug CkJsonObject::ckEmit(json)

    ; These will be used for parsing date/time strings..
    dtime.i = CkDateTime::ckCreate()
    If dtime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bLocalTime.i = 1
    dt.i

    ; Iterate over each job and get information..
    numRecords.i = CkJsonObject::ckSizeOfArray(json,"jobs")
    i.i = 0
    While i < numRecords

        CkJsonObject::setCkI(json, i)
        Debug "job id: " + CkJsonObject::ckStringOf(json,"jobs[i].id")
        Debug "client id: " + CkJsonObject::ckStringOf(json,"jobs[i].client.id")
        Debug "account id: " + CkJsonObject::ckStringOf(json,"jobs[i].account.id")
        Debug "address line1: " + CkJsonObject::ckStringOf(json,"jobs[i].address.line1")

        CkDateTime::ckSetFromTimestamp(dtime,CkJsonObject::ckStringOf(json,"jobs[i].startTime"))
        dt = CkDateTime::ckGetDtObj(dtime,bLocalTime)
        Debug "created: " + Str(CkDtObj::ckMonth(dt)) + "/" + Str(CkDtObj::ckDay(dt)) + "/" + Str(CkDtObj::ckYear(dt)) + "  " + Str(CkDtObj::ckHour(dt)) + ":" + Str(CkDtObj::ckMinute(dt))
        CkDtObj::ckDispose(dt)

        Debug "----"
        i = i + 1
    Wend

    ; A sample jobs listing response:
    ; 
    ; 	{
    ; 	  "result": "success",
    ; 	  "jobs": [
    ; 	    {
    ; 	      "id": 17580761,
    ; 	      "reference": "1000",
    ; 	      "startTime": "2016-10-26T02:10:00+00:00",
    ; 	      "endTime": "2016-10-28T02:40:00+00:00",
    ; 	      "priority": 2,
    ; 	      "title": "[ Demo Job ]",
    ; 	      "description": "",
    ; 	      "jobNumber": null,
    ; 	      "deleted": false,
    ; 	      "type": "demo",
    ; 	      "created": "2015-09-03T02:11:32+00:00",
    ; 	      "modified": "2016-10-26T12:05:09+00:00",
    ; 	      "client": {
    ; 	        "id": 9555868
    ; 	      },
    ; 	      "billingClient": null,
    ; 	      "status": {
    ; 	        "id": 675900
    ; 	      },
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "21462 New York Avenue NW",
    ; 	        "line2": null,
    ; 	        "city": "Washington",
    ; 	        "postcode": "20005",
    ; 	        "latitude": 38.903959,
    ; 	        "longitude": -77.02137
    ; 	      },
    ; 	      "metadata": {
    ; 	        "visitsCount": 3,
    ; 	        "assignedVisitsCount": 3,
    ; 	        "unassignedVisitsCount": 0,
    ; 	        "partsCount": 1,
    ; 	        "chargesCount": 1,
    ; 	        "timersCount": 0,
    ; 	        "notesCount": 0,
    ; 	        "parcelsCount": 0,
    ; 	        "paymentsCount": 0,
    ; 	        "documentsCount": 1
    ; 	      }
    ; 	    },
    ; 	    {
    ; 	      "id": 17639295,
    ; 	      "reference": "1000",
    ; 	      "startTime": "2016-10-31T12:00:00+00:00",
    ; 	      "endTime": "2016-10-31T12:30:00+00:00",
    ; 	      "priority": 2,
    ; 	      "title": "Deliver Donuts",
    ; 	      "description": "Deliver donuts to the cafe.",
    ; 	      "jobNumber": "21122",
    ; 	      "deleted": false,
    ; 	      "type": "normal",
    ; 	      "created": "2016-10-31T12:07:14+00:00",
    ; 	      "modified": "2016-10-31T12:07:14+00:00",
    ; 	      "client": {
    ; 	        "id": 9555868
    ; 	      },
    ; 	      "billingClient": null,
    ; 	      "status": {
    ; 	        "id": 675900
    ; 	      },
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "1732 Pennsylvania Avenue NW",
    ; 	        "line2": null,
    ; 	        "city": "Washington",
    ; 	        "postcode": "20006",
    ; 	        "latitude": 38.8990534,
    ; 	        "longitude": -77.0401866
    ; 	      },
    ; 	      "metadata": {
    ; 	        "visitsCount": 1,
    ; 	        "assignedVisitsCount": 0,
    ; 	        "unassignedVisitsCount": 1,
    ; 	        "partsCount": 0,
    ; 	        "chargesCount": 0,
    ; 	        "timersCount": 0,
    ; 	        "notesCount": 0,
    ; 	        "parcelsCount": 0,
    ; 	        "paymentsCount": 0,
    ; 	        "documentsCount": 0
    ; 	      }
    ; 	    }
    ; 	  ],
    ; 	  "metadata": {
    ; 	    "page": 1,
    ; 	    "pagesCount": 1,
    ; 	    "recordsPerPage": 20,
    ; 	    "recordsCount": 2
    ; 	  }
    ; 	}
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dtime)


    ProcedureReturn
EndProcedure