ListSuites PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
; Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
CkAuthAws::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "devicefarm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://devicefarm.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"devicefarm.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; The following code creates the JSON request body.
; The JSON created by this code is shown below.
; Use this online tool to generate code from sample JSON:
; Generate Code to Create JSON
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"arn","string")
CkJsonObject::ckUpdateString(json,"nextToken","string")
; The JSON request body created by the above code:
; {
; "arn": "string",
; "nextToken": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DeviceFarm_20150623.ListSuites")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
; The following code parses the JSON response.
; A sample JSON response is shown below the sample code.
; Use this online tool to generate parsing code from sample JSON:
; Generate Parsing Code from JSON
arn.s
Errored.i
Failed.i
Passed.i
Skipped.i
Stopped.i
Total.i
Warned.i
created.i
Metered.i
deviceMinutesTotal.i
Unmetered.i
message.s
name.s
result.s
started.i
status.s
stopped.i
v_type.s
nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"suites")
While i < count_i
CkJsonObject::setCkI(jResp, i)
arn = CkJsonObject::ckStringOf(jResp,"suites[i].arn")
Errored = CkJsonObject::ckIntOf(jResp,"suites[i].counters.errored")
Failed = CkJsonObject::ckIntOf(jResp,"suites[i].counters.failed")
Passed = CkJsonObject::ckIntOf(jResp,"suites[i].counters.passed")
Skipped = CkJsonObject::ckIntOf(jResp,"suites[i].counters.skipped")
Stopped = CkJsonObject::ckIntOf(jResp,"suites[i].counters.stopped")
Total = CkJsonObject::ckIntOf(jResp,"suites[i].counters.total")
Warned = CkJsonObject::ckIntOf(jResp,"suites[i].counters.warned")
created = CkJsonObject::ckIntOf(jResp,"suites[i].created")
Metered = CkJsonObject::ckIntOf(jResp,"suites[i].deviceMinutes.metered")
deviceMinutesTotal = CkJsonObject::ckIntOf(jResp,"suites[i].deviceMinutes.total")
Unmetered = CkJsonObject::ckIntOf(jResp,"suites[i].deviceMinutes.unmetered")
message = CkJsonObject::ckStringOf(jResp,"suites[i].message")
name = CkJsonObject::ckStringOf(jResp,"suites[i].name")
result = CkJsonObject::ckStringOf(jResp,"suites[i].result")
started = CkJsonObject::ckIntOf(jResp,"suites[i].started")
status = CkJsonObject::ckStringOf(jResp,"suites[i].status")
stopped = CkJsonObject::ckIntOf(jResp,"suites[i].stopped")
v_type = CkJsonObject::ckStringOf(jResp,"suites[i].type")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "nextToken": "string",
; "suites": [
; {
; "arn": "string",
; "counters": {
; "errored": number,
; "failed": number,
; "passed": number,
; "skipped": number,
; "stopped": number,
; "total": number,
; "warned": number
; },
; "created": number,
; "deviceMinutes": {
; "metered": number,
; "total": number,
; "unmetered": number
; },
; "message": "string",
; "name": "string",
; "result": "string",
; "started": number,
; "status": "string",
; "stopped": number,
; "type": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure