UpdateDevice 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, "networkmanager")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://networkmanager.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"networkmanager.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,"AWSLocation.SubnetArn","string")
CkJsonObject::ckUpdateString(json,"AWSLocation.Zone","string")
CkJsonObject::ckUpdateString(json,"Description","string")
CkJsonObject::ckUpdateString(json,"Location.Address","string")
CkJsonObject::ckUpdateString(json,"Location.Latitude","string")
CkJsonObject::ckUpdateString(json,"Location.Longitude","string")
CkJsonObject::ckUpdateString(json,"Model","string")
CkJsonObject::ckUpdateString(json,"SerialNumber","string")
CkJsonObject::ckUpdateString(json,"SiteId","string")
CkJsonObject::ckUpdateString(json,"Type","string")
CkJsonObject::ckUpdateString(json,"Vendor","string")
; The JSON request body created by the above code:
; {
; "AWSLocation": {
; "SubnetArn": "string",
; "Zone": "string"
; },
; "Description": "string",
; "Location": {
; "Address": "string",
; "Latitude": "string",
; "Longitude": "string"
; },
; "Model": "string",
; "SerialNumber": "string",
; "SiteId": "string",
; "Type": "string",
; "Vendor": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","UpdateDevice")
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,"PATCH","/global-networks/{globalNetworkId}/devices/{deviceId}",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
Key.s
Value.s
SubnetArn.s = CkJsonObject::ckStringOf(jResp,"Device.AWSLocation.SubnetArn")
Zone.s = CkJsonObject::ckStringOf(jResp,"Device.AWSLocation.Zone")
CreatedAt.i = CkJsonObject::ckIntOf(jResp,"Device.CreatedAt")
Description.s = CkJsonObject::ckStringOf(jResp,"Device.Description")
DeviceArn.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceArn")
DeviceId.s = CkJsonObject::ckStringOf(jResp,"Device.DeviceId")
GlobalNetworkId.s = CkJsonObject::ckStringOf(jResp,"Device.GlobalNetworkId")
Address.s = CkJsonObject::ckStringOf(jResp,"Device.Location.Address")
Latitude.s = CkJsonObject::ckStringOf(jResp,"Device.Location.Latitude")
Longitude.s = CkJsonObject::ckStringOf(jResp,"Device.Location.Longitude")
Model.s = CkJsonObject::ckStringOf(jResp,"Device.Model")
SerialNumber.s = CkJsonObject::ckStringOf(jResp,"Device.SerialNumber")
SiteId.s = CkJsonObject::ckStringOf(jResp,"Device.SiteId")
State.s = CkJsonObject::ckStringOf(jResp,"Device.State")
v_Type.s = CkJsonObject::ckStringOf(jResp,"Device.Type")
Vendor.s = CkJsonObject::ckStringOf(jResp,"Device.Vendor")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Device.Tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Key = CkJsonObject::ckStringOf(jResp,"Device.Tags[i].Key")
Value = CkJsonObject::ckStringOf(jResp,"Device.Tags[i].Value")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Device": {
; "AWSLocation": {
; "SubnetArn": "string",
; "Zone": "string"
; },
; "CreatedAt": number,
; "Description": "string",
; "DeviceArn": "string",
; "DeviceId": "string",
; "GlobalNetworkId": "string",
; "Location": {
; "Address": "string",
; "Latitude": "string",
; "Longitude": "string"
; },
; "Model": "string",
; "SerialNumber": "string",
; "SiteId": "string",
; "State": "string",
; "Tags": [
; {
; "Key": "string",
; "Value": "string"
; }
; ],
; "Type": "string",
; "Vendor": "string"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
