GetDevicePoolCompatibility 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,"appArn","string")
CkJsonObject::ckUpdateString(json,"configuration.auxiliaryApps[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.billingMethod","string")
CkJsonObject::ckUpdateString(json,"configuration.customerArtifactPaths.androidPaths[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.customerArtifactPaths.deviceHostPaths[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.customerArtifactPaths.iosPaths[0]","string")
CkJsonObject::ckUpdateString(json,"configuration.extraDataPackageArn","string")
CkJsonObject::ckUpdateString(json,"configuration.locale","string")
CkJsonObject::ckUpdateInt(json,"configuration.location.latitude",123)
CkJsonObject::ckUpdateInt(json,"configuration.location.longitude",123)
CkJsonObject::ckUpdateString(json,"configuration.networkProfileArn","string")
CkJsonObject::ckUpdateInt(json,"configuration.radios.bluetooth",123)
CkJsonObject::ckUpdateInt(json,"configuration.radios.gps",123)
CkJsonObject::ckUpdateInt(json,"configuration.radios.nfc",123)
CkJsonObject::ckUpdateInt(json,"configuration.radios.wifi",123)
CkJsonObject::ckUpdateString(json,"configuration.vpceConfigurationArns[0]","string")
CkJsonObject::ckUpdateString(json,"devicePoolArn","string")
CkJsonObject::ckUpdateString(json,"test.filter","string")
CkJsonObject::ckUpdateString(json,"test.parameters.string","string")
CkJsonObject::ckUpdateString(json,"test.testPackageArn","string")
CkJsonObject::ckUpdateString(json,"test.testSpecArn","string")
CkJsonObject::ckUpdateString(json,"test.type","string")
CkJsonObject::ckUpdateString(json,"testType","string")
; The JSON request body created by the above code:
; {
; "appArn": "string",
; "configuration": {
; "auxiliaryApps": [
; "string"
; ],
; "billingMethod": "string",
; "customerArtifactPaths": {
; "androidPaths": [
; "string"
; ],
; "deviceHostPaths": [
; "string"
; ],
; "iosPaths": [
; "string"
; ]
; },
; "extraDataPackageArn": "string",
; "locale": "string",
; "location": {
; "latitude": number,
; "longitude": number
; },
; "networkProfileArn": "string",
; "radios": {
; "bluetooth": boolean,
; "gps": boolean,
; "nfc": boolean,
; "wifi": boolean
; },
; "vpceConfigurationArns": [
; "string"
; ]
; },
; "devicePoolArn": "string",
; "test": {
; "filter": "string",
; "parameters": {
; "string": "string"
; },
; "testPackageArn": "string",
; "testSpecArn": "string",
; "type": "string"
; },
; "testType": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DeviceFarm_20150623.GetDevicePoolCompatibility")
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
compatible.i
Arn.s
Availability.s
Carrier.s
Architecture.s
Clock.i
Frequency.s
FleetName.s
FleetType.s
FormFactor.s
HeapSize.i
Image.s
Manufacturer.s
Memory.i
Model.s
ModelId.s
Name.s
Os.s
Platform.s
Radio.s
RemoteAccessEnabled.i
RemoteDebugEnabled.i
Height.i
Width.i
j.i
count_j.i
arn.s
deviceArn.s
instanceProfileArn.s
Description.s
instanceProfileName.s
PackageCleanup.i
RebootAfterUse.i
status.s
udid.s
k.i
count_k.i
strVal.s
message.s
v_type.s
deviceAvailability.s
deviceCarrier.s
CpuArchitecture.s
CpuClock.i
CpuFrequency.s
deviceFleetName.s
deviceFleetType.s
deviceFormFactor.s
deviceHeapSize.i
deviceImage.s
deviceManufacturer.s
deviceMemory.i
deviceModel.s
deviceModelId.s
deviceName.s
deviceOs.s
devicePlatform.s
deviceRadio.s
deviceRemoteAccessEnabled.i
deviceRemoteDebugEnabled.i
ResolutionHeight.i
ResolutionWidth.i
instanceProfileDescription.s
instanceProfilePackageCleanup.i
instanceProfileRebootAfterUse.i
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"compatibleDevices")
While i < count_i
CkJsonObject::setCkI(jResp, i)
compatible = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].compatible")
Arn = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.arn")
Availability = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.availability")
Carrier = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.carrier")
Architecture = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.cpu.architecture")
Clock = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.cpu.clock")
Frequency = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.cpu.frequency")
FleetName = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.fleetName")
FleetType = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.fleetType")
FormFactor = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.formFactor")
HeapSize = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.heapSize")
Image = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.image")
Manufacturer = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.manufacturer")
Memory = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.memory")
Model = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.model")
ModelId = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.modelId")
Name = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.name")
Os = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.os")
Platform = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.platform")
Radio = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.radio")
RemoteAccessEnabled = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.remoteAccessEnabled")
RemoteDebugEnabled = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.remoteDebugEnabled")
Height = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.resolution.height")
Width = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.resolution.width")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"compatibleDevices[i].device.instances")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
arn = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].arn")
deviceArn = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].deviceArn")
instanceProfileArn = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.arn")
Description = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.description")
instanceProfileName = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.name")
PackageCleanup = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.packageCleanup")
RebootAfterUse = CkJsonObject::ckIntOf(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.rebootAfterUse")
status = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].status")
udid = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].udid")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup[k]")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"compatibleDevices[i].device.instances[j].labels")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].device.instances[j].labels[k]")
k = k + 1
Wend
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"compatibleDevices[i].incompatibilityMessages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
message = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].incompatibilityMessages[j].message")
v_type = CkJsonObject::ckStringOf(jResp,"compatibleDevices[i].incompatibilityMessages[j].type")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"incompatibleDevices")
While i < count_i
CkJsonObject::setCkI(jResp, i)
compatible = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].compatible")
deviceArn = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.arn")
deviceAvailability = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.availability")
deviceCarrier = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.carrier")
CpuArchitecture = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.cpu.architecture")
CpuClock = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.cpu.clock")
CpuFrequency = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.cpu.frequency")
deviceFleetName = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.fleetName")
deviceFleetType = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.fleetType")
deviceFormFactor = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.formFactor")
deviceHeapSize = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.heapSize")
deviceImage = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.image")
deviceManufacturer = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.manufacturer")
deviceMemory = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.memory")
deviceModel = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.model")
deviceModelId = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.modelId")
deviceName = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.name")
deviceOs = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.os")
devicePlatform = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.platform")
deviceRadio = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.radio")
deviceRemoteAccessEnabled = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.remoteAccessEnabled")
deviceRemoteDebugEnabled = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.remoteDebugEnabled")
ResolutionHeight = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.resolution.height")
ResolutionWidth = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.resolution.width")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"incompatibleDevices[i].device.instances")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
arn = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].arn")
deviceArn = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].deviceArn")
instanceProfileArn = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.arn")
instanceProfileDescription = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.description")
instanceProfileName = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.name")
instanceProfilePackageCleanup = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.packageCleanup")
instanceProfileRebootAfterUse = CkJsonObject::ckIntOf(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.rebootAfterUse")
status = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].status")
udid = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].udid")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup[k]")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"incompatibleDevices[i].device.instances[j].labels")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].device.instances[j].labels[k]")
k = k + 1
Wend
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"incompatibleDevices[i].incompatibilityMessages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
message = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].incompatibilityMessages[j].message")
v_type = CkJsonObject::ckStringOf(jResp,"incompatibleDevices[i].incompatibilityMessages[j].type")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "compatibleDevices": [
; {
; "compatible": boolean,
; "device": {
; "arn": "string",
; "availability": "string",
; "carrier": "string",
; "cpu": {
; "architecture": "string",
; "clock": number,
; "frequency": "string"
; },
; "fleetName": "string",
; "fleetType": "string",
; "formFactor": "string",
; "heapSize": number,
; "image": "string",
; "instances": [
; {
; "arn": "string",
; "deviceArn": "string",
; "instanceProfile": {
; "arn": "string",
; "description": "string",
; "excludeAppPackagesFromCleanup": [
; "string"
; ],
; "name": "string",
; "packageCleanup": boolean,
; "rebootAfterUse": boolean
; },
; "labels": [
; "string"
; ],
; "status": "string",
; "udid": "string"
; }
; ],
; "manufacturer": "string",
; "memory": number,
; "model": "string",
; "modelId": "string",
; "name": "string",
; "os": "string",
; "platform": "string",
; "radio": "string",
; "remoteAccessEnabled": boolean,
; "remoteDebugEnabled": boolean,
; "resolution": {
; "height": number,
; "width": number
; }
; },
; "incompatibilityMessages": [
; {
; "message": "string",
; "type": "string"
; }
; ]
; }
; ],
; "incompatibleDevices": [
; {
; "compatible": boolean,
; "device": {
; "arn": "string",
; "availability": "string",
; "carrier": "string",
; "cpu": {
; "architecture": "string",
; "clock": number,
; "frequency": "string"
; },
; "fleetName": "string",
; "fleetType": "string",
; "formFactor": "string",
; "heapSize": number,
; "image": "string",
; "instances": [
; {
; "arn": "string",
; "deviceArn": "string",
; "instanceProfile": {
; "arn": "string",
; "description": "string",
; "excludeAppPackagesFromCleanup": [
; "string"
; ],
; "name": "string",
; "packageCleanup": boolean,
; "rebootAfterUse": boolean
; },
; "labels": [
; "string"
; ],
; "status": "string",
; "udid": "string"
; }
; ],
; "manufacturer": "string",
; "memory": number,
; "model": "string",
; "modelId": "string",
; "name": "string",
; "os": "string",
; "platform": "string",
; "radio": "string",
; "remoteAccessEnabled": boolean,
; "remoteDebugEnabled": boolean,
; "resolution": {
; "height": number,
; "width": number
; }
; },
; "incompatibilityMessages": [
; {
; "message": "string",
; "type": "string"
; }
; ]
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
