Chilkat Online Tools

GetDevicePoolCompatibility TCL Example

AWS Device Farm

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $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_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "devicefarm"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://devicefarm.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "devicefarm.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# 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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "appArn" "string"
CkJsonObject_UpdateString $json "configuration.auxiliaryApps[0]" "string"
CkJsonObject_UpdateString $json "configuration.billingMethod" "string"
CkJsonObject_UpdateString $json "configuration.customerArtifactPaths.androidPaths[0]" "string"
CkJsonObject_UpdateString $json "configuration.customerArtifactPaths.deviceHostPaths[0]" "string"
CkJsonObject_UpdateString $json "configuration.customerArtifactPaths.iosPaths[0]" "string"
CkJsonObject_UpdateString $json "configuration.extraDataPackageArn" "string"
CkJsonObject_UpdateString $json "configuration.locale" "string"
CkJsonObject_UpdateInt $json "configuration.location.latitude" 123
CkJsonObject_UpdateInt $json "configuration.location.longitude" 123
CkJsonObject_UpdateString $json "configuration.networkProfileArn" "string"
CkJsonObject_UpdateInt $json "configuration.radios.bluetooth" 123
CkJsonObject_UpdateInt $json "configuration.radios.gps" 123
CkJsonObject_UpdateInt $json "configuration.radios.nfc" 123
CkJsonObject_UpdateInt $json "configuration.radios.wifi" 123
CkJsonObject_UpdateString $json "configuration.vpceConfigurationArns[0]" "string"
CkJsonObject_UpdateString $json "devicePoolArn" "string"
CkJsonObject_UpdateString $json "test.filter" "string"
CkJsonObject_UpdateString $json "test.parameters.string" "string"
CkJsonObject_UpdateString $json "test.testPackageArn" "string"
CkJsonObject_UpdateString $json "test.testSpecArn" "string"
CkJsonObject_UpdateString $json "test.type" "string"
CkJsonObject_UpdateString $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_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "DeviceFarm_20150623.GetDevicePoolCompatibility"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $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

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "compatibleDevices"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set compatible [CkJsonObject_IntOf $jResp "compatibleDevices[i].compatible"]
    set Arn [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.arn"]
    set Availability [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.availability"]
    set Carrier [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.carrier"]
    set Architecture [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.cpu.architecture"]
    set Clock [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.cpu.clock"]
    set Frequency [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.cpu.frequency"]
    set FleetName [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.fleetName"]
    set FleetType [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.fleetType"]
    set FormFactor [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.formFactor"]
    set HeapSize [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.heapSize"]
    set Image [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.image"]
    set Manufacturer [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.manufacturer"]
    set Memory [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.memory"]
    set Model [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.model"]
    set ModelId [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.modelId"]
    set Name [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.name"]
    set Os [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.os"]
    set Platform [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.platform"]
    set Radio [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.radio"]
    set RemoteAccessEnabled [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.remoteAccessEnabled"]
    set RemoteDebugEnabled [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.remoteDebugEnabled"]
    set Height [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.resolution.height"]
    set Width [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.resolution.width"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "compatibleDevices[i].device.instances"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set arn [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].arn"]
        set deviceArn [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].deviceArn"]
        set instanceProfileArn [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].instanceProfile.arn"]
        set Description [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].instanceProfile.description"]
        set instanceProfileName [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].instanceProfile.name"]
        set PackageCleanup [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.instances[j].instanceProfile.packageCleanup"]
        set RebootAfterUse [CkJsonObject_IntOf $jResp "compatibleDevices[i].device.instances[j].instanceProfile.rebootAfterUse"]
        set status [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].status"]
        set udid [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].udid"]
        set k 0
        set count_k [CkJsonObject_SizeOfArray $jResp "compatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup"]
        while {$k < $count_k} {
            CkJsonObject_put_K $jResp $k
            set strVal [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup[k]"]
            set k [expr $k + 1]
        }
        set k 0
        set count_k [CkJsonObject_SizeOfArray $jResp "compatibleDevices[i].device.instances[j].labels"]
        while {$k < $count_k} {
            CkJsonObject_put_K $jResp $k
            set strVal [CkJsonObject_stringOf $jResp "compatibleDevices[i].device.instances[j].labels[k]"]
            set k [expr $k + 1]
        }
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "compatibleDevices[i].incompatibilityMessages"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set message [CkJsonObject_stringOf $jResp "compatibleDevices[i].incompatibilityMessages[j].message"]
        set v_type [CkJsonObject_stringOf $jResp "compatibleDevices[i].incompatibilityMessages[j].type"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "incompatibleDevices"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set compatible [CkJsonObject_IntOf $jResp "incompatibleDevices[i].compatible"]
    set deviceArn [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.arn"]
    set deviceAvailability [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.availability"]
    set deviceCarrier [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.carrier"]
    set CpuArchitecture [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.cpu.architecture"]
    set CpuClock [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.cpu.clock"]
    set CpuFrequency [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.cpu.frequency"]
    set deviceFleetName [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.fleetName"]
    set deviceFleetType [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.fleetType"]
    set deviceFormFactor [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.formFactor"]
    set deviceHeapSize [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.heapSize"]
    set deviceImage [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.image"]
    set deviceManufacturer [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.manufacturer"]
    set deviceMemory [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.memory"]
    set deviceModel [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.model"]
    set deviceModelId [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.modelId"]
    set deviceName [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.name"]
    set deviceOs [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.os"]
    set devicePlatform [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.platform"]
    set deviceRadio [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.radio"]
    set deviceRemoteAccessEnabled [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.remoteAccessEnabled"]
    set deviceRemoteDebugEnabled [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.remoteDebugEnabled"]
    set ResolutionHeight [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.resolution.height"]
    set ResolutionWidth [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.resolution.width"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "incompatibleDevices[i].device.instances"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set arn [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].arn"]
        set deviceArn [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].deviceArn"]
        set instanceProfileArn [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.arn"]
        set instanceProfileDescription [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.description"]
        set instanceProfileName [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.name"]
        set instanceProfilePackageCleanup [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.packageCleanup"]
        set instanceProfileRebootAfterUse [CkJsonObject_IntOf $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.rebootAfterUse"]
        set status [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].status"]
        set udid [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].udid"]
        set k 0
        set count_k [CkJsonObject_SizeOfArray $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup"]
        while {$k < $count_k} {
            CkJsonObject_put_K $jResp $k
            set strVal [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].instanceProfile.excludeAppPackagesFromCleanup[k]"]
            set k [expr $k + 1]
        }
        set k 0
        set count_k [CkJsonObject_SizeOfArray $jResp "incompatibleDevices[i].device.instances[j].labels"]
        while {$k < $count_k} {
            CkJsonObject_put_K $jResp $k
            set strVal [CkJsonObject_stringOf $jResp "incompatibleDevices[i].device.instances[j].labels[k]"]
            set k [expr $k + 1]
        }
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "incompatibleDevices[i].incompatibilityMessages"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set message [CkJsonObject_stringOf $jResp "incompatibleDevices[i].incompatibilityMessages[j].message"]
        set v_type [CkJsonObject_stringOf $jResp "incompatibleDevices[i].incompatibilityMessages[j].type"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

# 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"
#         }
#       ]
#     }
#   ]
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp