Chilkat Online Tools

GetDevice PureBasic Example

Alexa for Business

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, "a4b")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://a4b.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"a4b.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,"DeviceArn","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "DeviceArn": "string"
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","AlexaForBusiness.GetDevice")

    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

    Code.s
    Feature.s

    DeviceArn.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceArn")
    DeviceName.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceName")
    DeviceSerialNumber.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceSerialNumber")
    DeviceStatus.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceStatus")
    ConnectionStatus.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceStatusInfo.ConnectionStatus")
    ConnectionStatusUpdatedTime.i = CkJsonObject::ckIntOf(jResp,"Device.DeviceStatusInfo.ConnectionStatusUpdatedTime")
    DeviceType.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceType")
    MacAddress.s = CkJsonObject::ckStringOf(jResp,"Device.MacAddress")
    CertificateArn.s = CkJsonObject::ckStringOf(jResp,"Device.NetworkProfileInfo.CertificateArn")
    CertificateExpirationTime.i = CkJsonObject::ckIntOf(jResp,"Device.NetworkProfileInfo.CertificateExpirationTime")
    NetworkProfileArn.s = CkJsonObject::ckStringOf(jResp,"Device.NetworkProfileInfo.NetworkProfileArn")
    RoomArn.s = CkJsonObject::ckStringOf(jResp,"Device.RoomArn")
    SoftwareVersion.s = CkJsonObject::ckStringOf(jResp,"Device.SoftwareVersion")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Device.DeviceStatusInfo.DeviceStatusDetails")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Code = CkJsonObject::ckStringOf(jResp,"Device.DeviceStatusInfo.DeviceStatusDetails[i].Code")
        Feature = CkJsonObject::ckStringOf(jResp,"Device.DeviceStatusInfo.DeviceStatusDetails[i].Feature")
        i = i + 1
    Wend

    ; A sample JSON response body parsed by the above code:

    ; {
    ;   "Device": {
    ;     "DeviceArn": "string",
    ;     "DeviceName": "string",
    ;     "DeviceSerialNumber": "string",
    ;     "DeviceStatus": "string",
    ;     "DeviceStatusInfo": {
    ;       "ConnectionStatus": "string",
    ;       "ConnectionStatusUpdatedTime": number,
    ;       "DeviceStatusDetails": [
    ;         {
    ;           "Code": "string",
    ;           "Feature": "string"
    ;         }
    ;       ]
    ;     },
    ;     "DeviceType": "string",
    ;     "MacAddress": "string",
    ;     "NetworkProfileInfo": {
    ;       "CertificateArn": "string",
    ;       "CertificateExpirationTime": number,
    ;       "NetworkProfileArn": "string"
    ;     },
    ;     "RoomArn": "string",
    ;     "SoftwareVersion": "string"
    ;   }
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure