(PureBasic) GeoOp - Create Job

Create a new job.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.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..
    ; Note: The same REST object, once connected, can be used for many requests.
    ; The bAutoReconnect argument allows it to automatically reconnect as required for any subsequent request.

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

    ; To create a new user, we must build and send the following JSON:

    ; 	{
    ; 	  "jobs": [
    ; 	    {
    ; 	      "priority": 2,
    ; 	      "title": "Deliver More Donuts",
    ; 	      "description": "Deliver more donuts to the cafe.",
    ; 	      "client": {
    ; 	        "id": 9571218
    ; 	      },
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "status": {
    ; 	        "id": 675900
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "1732 Pennsylvania Avenue NW",
    ; 	        "city": "Washington",
    ; 	        "postcode": "20006",
    ; 	      }
    ; 	    }
    ; 	  ]
    ; 	}
    ; 

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

    CkJsonObject::ckUpdateInt(jsonJob,"jobs[0].priority",2)
    CkJsonObject::ckUpdateString(jsonJob,"jobs[0].title","Deliver More Donuts")
    CkJsonObject::ckUpdateString(jsonJob,"jobs[0].description","Deliver more donuts to the cafe.")
    CkJsonObject::ckUpdateInt(jsonJob,"jobs[0].client.id",9571218)
    CkJsonObject::ckUpdateInt(jsonJob,"jobs[0].account.id",39409)
    CkJsonObject::ckUpdateInt(jsonJob,"jobs[0].status.id",675900)
    CkJsonObject::ckUpdateString(jsonJob,"jobs[0].address.line1","1732 Pennsylvania Avenue NW")
    CkJsonObject::ckUpdateString(jsonJob,"jobs[0].address.city","Washington")
    CkJsonObject::ckUpdateString(jsonJob,"jobs[0].address.postcode","20006")

    ; Examine the JSON we're about to send...
    CkJsonObject::setCkEmitCompact(jsonJob, 0)
    Debug CkJsonObject::ckEmit(jsonJob)

    CkRest::ckAddHeader(rest,"Content-Type","application/json")

    CkJsonObject::setCkEmitCompact(jsonJob, 1)
    responseBody.s = CkRest::ckFullRequestString(rest,"POST","/jobs",CkJsonObject::ckEmit(jsonJob))
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonJob)
        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(jsonJob)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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

    ; The success JSON looks like this:

    ; 	{
    ; 	  "result": "success",
    ; 	  "jobs": [
    ; 	    {
    ; 	      "id": 17639811,
    ; 	      "reference": "1001",
    ; 	      "startTime": null,
    ; 	      "endTime": null,
    ; 	      "priority": 2,
    ; 	      "title": "Deliver More Donuts",
    ; 	      "description": "Deliver more donuts to the cafe.",
    ; 	      "jobNumber": null,
    ; 	      "deleted": false,
    ; 	      "type": "normal",
    ; 	      "created": "2016-10-31T13:36:47+00:00",
    ; 	      "modified": "2016-10-31T13:36:47+00:00",
    ; 	      "client": {
    ; 	        "id": 9571218
    ; 	      },
    ; 	      "billingClient": null,
    ; 	      "status": {
    ; 	        "id": 675900
    ; 	      },
    ; 	      "account": {
    ; 	        "id": 39409
    ; 	      },
    ; 	      "address": {
    ; 	        "line1": "1732 Pennsylvania Avenue NW",
    ; 	        "line2": "",
    ; 	        "city": "Washington",
    ; 	        "postcode": "20006",
    ; 	        "latitude": 38.8990534,
    ; 	        "longitude": -77.0401866
    ; 	      },
    ; 	      "metadata": {
    ; 	        "visitsCount": 0,
    ; 	        "assignedVisitsCount": 0,
    ; 	        "unassignedVisitsCount": 0,
    ; 	        "partsCount": 0,
    ; 	        "chargesCount": 0,
    ; 	        "timersCount": 0,
    ; 	        "notesCount": 0,
    ; 	        "parcelsCount": 0,
    ; 	        "paymentsCount": 0,
    ; 	        "documentsCount": 0
    ; 	      }
    ; 	    }
    ; 	  ],
    ; 	  "metadata": {
    ; 	    "receivedItemsCount": 1,
    ; 	    "validItems": [
    ; 	      0
    ; 	    ],
    ; 	    "invalidItems": [
    ; 	    ]
    ; 	  }
    ; 	}
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(jsonJob)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure